Add a basic explanation of GitHub Codespaces

This adds a first pass explanation of using GitHub Codespaces with the research template. It follows: opensafely/research-template#102 which is now merged.
opensafely · Jul 13, 2023 · ded834d · ded834d
1 parent 2674350
commit ded834d
Show file tree

Hide file tree

Showing 19 changed files with 532 additions and 0 deletions.
diff --git a/docs/github-codespaces.md b/docs/github-codespaces.md
diff --git a/docs/images/codespaces-actions.png b/docs/images/codespaces-actions.png
diff --git a/docs/images/codespaces-create.png b/docs/images/codespaces-create.png
diff --git a/docs/images/codespaces-discard-changes.png b/docs/images/codespaces-discard-changes.png
diff --git a/docs/images/codespaces-ehrql-autocompletion.png b/docs/images/codespaces-ehrql-autocompletion.png
diff --git a/docs/images/codespaces-ehrql-tutorial-directory.png b/docs/images/codespaces-ehrql-tutorial-directory.png
diff --git a/docs/images/codespaces-github-sign-up.png b/docs/images/codespaces-github-sign-up.png
diff --git a/docs/images/codespaces-jupyterlab-ports.png b/docs/images/codespaces-jupyterlab-ports.png
diff --git a/docs/images/codespaces-new-folder.png b/docs/images/codespaces-new-folder.png
diff --git a/docs/images/codespaces-open-in-integrated-terminal.png b/docs/images/codespaces-open-in-integrated-terminal.png
diff --git a/docs/images/codespaces-opensafely-cli.png b/docs/images/codespaces-opensafely-cli.png
diff --git a/docs/images/codespaces-opensafely-example-project.png b/docs/images/codespaces-opensafely-example-project.png
diff --git a/docs/images/codespaces-options.png b/docs/images/codespaces-options.png
diff --git a/docs/images/codespaces-panel-options.png b/docs/images/codespaces-panel-options.png
diff --git a/docs/images/codespaces-panel.png b/docs/images/codespaces-panel.png
diff --git a/docs/images/codespaces-setup-screen.png b/docs/images/codespaces-setup-screen.png
diff --git a/docs/images/codespaces-template.png b/docs/images/codespaces-template.png
diff --git a/docs/images/codespaces-vscode-layout.png b/docs/images/codespaces-vscode-layout.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,6 +35,7 @@ nav:
           - Overview: install-intro.md
           - Managing Gitpod workspaces: gitpod-workspaces.md
           - GitHub and Git: install-github-and-git.md
+          - Running OpenSAFELY in GitHub Codespaces: github-codespaces.md
           - Python: install-python.md
           - Docker: install-docker.md
           - OpenSAFELY CLI: opensafely-cli.md