Merge pull request #1547 from opensafely/steve/document-updating-code…

…spaces-configuration Explain updating Codespaces config for a project
opensafely · Jun 20, 2024 · 9bae30e · 9bae30e
2 parents ccc0abe + c04197d
commit 9bae30e
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/docs/getting-started/how-to/index.md b/docs/getting-started/how-to/index.md
@@ -3,6 +3,7 @@ The how-to guides provide practical steps for setting up and using OpenSAFELY.
 ## Using OpenSAFELY
 
 * [How to add GitHub Codespaces to your project](add-github-codespaces-to-your-project/index.md)
+* [How to update GitHub Codespaces in your project](update-github-codespaces-in-your-project/index.md)
 * [How to use GitHub Codespaces in your project](use-github-codespaces-in-your-project/index.md)
 * [How to use released outputs in GitHub Codespaces](use-released-outputs-in-github-codespaces/index.md)
 * [How to use Git effectively](use-git-effectively/index.md)

diff --git a/docs/getting-started/how-to/update-github-codespaces-in-your-project/index.md b/docs/getting-started/how-to/update-github-codespaces-in-your-project/index.md
@@ -0,0 +1,12 @@
+This page describes how to update the GitHub Codespaces in your project,
+if your project already has GitHub Codespaces added.
+
+You may wish to update the GitHub Codespaces configuration,
+if you want to use the latest configuration as provided by the research template
+in your existing project.
+
+## Updating the GitHub Codespaces configuration in your project
+
+* Delete the files inside `.devcontainer` in your project.
+* Now follow the instructions as for [adding GitHub Codespaces to an existing
+  project](../add-github-codespaces-to-your-project/index.md).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -34,6 +34,7 @@ nav:
       - How-to guides:
         - 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 update GitHub Codespaces in your project: getting-started/how-to/update-github-codespaces-in-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 released outputs in GitHub Codespaces: getting-started/how-to/use-released-outputs-in-github-codespaces/index.md
         - How to use Git effectively: getting-started/how-to/use-git-effectively/index.md