diff --git a/docs/getting-started/how-to/index.md b/docs/getting-started/how-to/index.md index 3d658f4ba..460ad2cbf 100644 --- 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 new file mode 100644 index 000000000..9992128bd --- /dev/null +++ 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 index 564ce2f2c..6406d3d20 100644 --- 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