Merge pull request #1522 from opensafely/iaindillingham/use-git

Add "How to use Git effectively" page
opensafely · May 16, 2024 · 18d6dad · 18d6dad
2 parents 8c3fa94 + f999c0c
commit 18d6dad
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 64 deletions.
diff --git a/docs/_redirects b/docs/_redirects
@@ -62,6 +62,8 @@
 /dataset-onsdeaths/                      /data-sources/onsdeaths/             301
 /dataset-ukrr                            /data-sources/ukrr/                  301
 /dataset-ukrr/                           /data-sources/ukrr/                  301
+/install-github-and-git                  /getting-started/how-to/use-git-effectively/ 301
+/install-github-and-git/                 /getting-started/how-to/use-git-effectively/ 301
 /permissions                             /jobs-site/                          301
 /permissions/                            /jobs-site/                          301
 /job-server                              /jobs-site/                          301

diff --git a/docs/getting-started/how-to/index.md b/docs/getting-started/how-to/index.md
@@ -4,7 +4,7 @@ The how-to guides provide practical steps for setting up and using OpenSAFELY.
 
 * [How to add GitHub Codespaces to your project](add-github-codespaces-to-your-project/index.md)
 * [How to use GitHub Codespaces in your project](use-github-codespaces-in-your-project/index.md)
-* [How to use GitHub and Git](../../install-github-and-git.md)
+* [How to use Git effectively](use-git-effectively/index.md)
 * [How to use the OpenSAFELY command-line interface](../../opensafely-cli.md)
 * [How to create a code repository for your
   project](create-a-code-repository-for-your-project/index.md)

diff --git a/docs/getting-started/how-to/use-git-effectively/index.md b/docs/getting-started/how-to/use-git-effectively/index.md
@@ -0,0 +1,21 @@
+This page links to resources that describe how to use Git effectively.
+
+## Using Git with `git`
+
+The `git` command-line tool has a large number of commands.
+However, only a small number are important and commonly used.
+These are summarised in GitHub's "[Git Cheat Sheet](https://education.github.com/git-cheat-sheet-education.pdf)".
+
+## Using Git with VS Code
+
+VS Code's Source Control view provides a visual interface to important and commonly used commands.
+For more information, see the "[Introduction to Git in VS Code](https://code.visualstudio.com/docs/sourcecontrol/intro-to-git)" page in VS Code's docs.
+
+## Diving deeper
+
+The [Turing Way](https://book.the-turing-way.org/) project has a section on its website entitled "[Version Control](https://book.the-turing-way.org/reproducible-research/vcs)".
+
+The University of Bristol's Electronic Health Records Group have a section on their website entitled "[Introduction to using Git and GitHub](https://grpehr.github.io/training/01-index.html)".
+
+Git's "[Documentation](https://git-scm.com/doc)" page links to several videos and books,
+including the "[Pro Git](https://git-scm.com/book/en/v2)" book by Scott Chacon and Ben Straub.
diff --git a/docs/install-github-and-git.md b/docs/install-github-and-git.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,7 +35,7 @@ nav:
         - How-to guides: getting-started/how-to/index.md
         - How to add GitHub Codespaces to your project: getting-started/how-to/add-github-codespaces-to-your-project/index.md
         - How to use GitHub Codespaces in your project: getting-started/how-to/use-github-codespaces-in-your-project/index.md
-        - How to use GitHub and Git: install-github-and-git.md
+        - How to use Git effectively: getting-started/how-to/use-git-effectively/index.md
         - How to use the OpenSAFELY command-line interface: opensafely-cli.md
         - How to create a code repository for your project: getting-started/how-to/create-a-code-repository-for-your-project/index.md
       - Explanation: