Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain updating Codespaces config for a project #1547

Merged
merged 1 commit into from
Jun 20, 2024
Merged

Explain updating Codespaces config for a project #1547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/getting-started/how-to/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
12 changes: 12 additions & 0 deletions docs/getting-started/how-to/update-github-codespaces-in-your-project/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading