Skip to content

Commit

Permalink
Rename various images for consistency
Browse files Browse the repository at this point in the history
It would be better to organise these per directory probably (#1400),
but avoiding that for now. This at least marks more clearly what these
images are for.

Have not renamed the `win-anaconda-prompt.png` and `win-docker-starting.png`
because the `win-docker-starting.png` is used elsewhere.
  • Loading branch information
StevenMaude committed Nov 30, 2023
1 parent 1d43e79 commit f2a2b9d
Show file tree
Hide file tree
Showing 8 changed files with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,10 @@ account, for developing your own study:
<br><a href="https://github.com/opensafely/research-template/generate" target="_blank">https://github.com/opensafely/research-template/generate</a>.
1. Use the **Owner** drop-down menu, and select the account you want to own the
repository (typically under your own account)
![Entering a name, owner and description, when creating a repository from the research template.](images/create-repository-owner-name.png)
![Entering a name, owner and description, when creating a repository from the research template.](images/getting-started-create-repository-owner-name.png)
1. Type a name for your repository, and an optional description
1. Choose a [repository visibility](repositories.md#repository-visibility). This would usually be "Public"
![Entering a description and choosing to make a repository public or private, when creating a repository from the research template.](images/create-repository-public-private.png)
![Entering a description and choosing to make a repository public or private, when creating a repository from the research template.](images/getting-started-create-repository-public-private.png)
1. There is an "Include all branches" option: this does **not** need to be selected.
(You only need the main branch; the other branches are
work-in-progress changes.)
Expand Down Expand Up @@ -714,25 +714,25 @@ the new commit.
your text editor and save them locally, you also see the changes in
GitHub Desktop. To add all changes in all files to a single "*commit*", tick the
checkbox at the top of the list.<br>
![Committing files with GitHub Desktop.](images/commit-all.png)
![Committing files with GitHub Desktop.](images/getting-started-github-desktop-commit-all.png)
1. At the bottom of the list of changes, in the **Summary** field, type a short,
meaningful description of the changes (this is called the *commit message*).
Optionally, you can add more information about the change in the
**Description** field. Press the blue button to make the commit.<br>
![Writing a commit message with GitHub Desktop.](images/commit-message.png)
![Writing a commit message with GitHub Desktop.](images/getting-started-github-desktop-commit-message.png)
1. Click **Push origin** to push your local changes to the remote repository on
GitHub ![Pushing changes to GitHub with GitHub Desktop.](images/push-to-github.png)
GitHub ![Pushing changes to GitHub with GitHub Desktop.](images/getting-started-github-desktop-push-to-github.png)

### Check that the automated tests pass

Visit your repository on GitHub's site. Click on the **Actions** tab
![The GitHub Actions tab in a repository.](images/github-actions-tab.png)
![The GitHub Actions tab in a repository.](images/getting-started-github-actions-tab.png)

You'll see a *Workflow* running with the *commit message* of your last
commit. The workflow verifies that the command `opensafely run run_all` can
run successfully. If it's yellow, it's still running. If it's red, it
has failed. If it's green, it has succeeded. You want it to be green!
![A list of workflows in GitHub Actions.](images/github-running-workflow.png)
![The GitHub Actions tab showing a successful workflow.](images/getting-started-github-actions-workflow-success.png)

## 7. Next steps

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit f2a2b9d

Please sign in to comment.