diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dda4145c9b..2b204ef8fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,6 +26,7 @@ Jump to the following sections: - [Working in a private repository](#working-in-a-private-repository) - [Who's involved in the project](#whos-involved-in-the-project) - [Make a change with a pull request](#making-a-change-with-a-pull-request) + - [Make a change to the documentation](#making-a-change-to-the-documentation) ## A DevOps development philosophy @@ -219,6 +220,21 @@ You can update your [fork](https://docs.github.com/en/get-started/quickstart/for GitHub has a [nice introduction](https://docs.github.com/en/get-started/quickstart/github-flow) to the pull request workflow, but please [get in touch](#get-in-touch) if you have any questions :balloon:. +### Making a change to the documentation + +The docs, including for older releases, are available [here](https://alan-turing-institute.github.io/data-safe-haven). + +You should follow the same instructions as above to [make a change with a pull request](#making-a-change-with-a-pull-request) when editing the documentation. + +To test your changes, build the docs locally by checking out your fork of the repo, navigating to the `docs` folder and `make`ing them: + +```{bash} +cd data-safe-haven/docs +make html +``` + +This will add the contents to a folder called `_output` inside `docs`. Open the index html from a browser and you should be able to navigate the docs and view your changes. + ### Who's involved in the project As some users have `GitHub` IDs that make it a little difficult to know who they are in real life and it's sometimes nice to know **who** you're working with on the project, hopefully this table will help you put names to faces and IDs :sparkles: diff --git a/docs/deployment/snippets/14_run_smoke_tests.partial.md b/docs/deployment/snippets/14_run_smoke_tests.partial.md index 2cf5af8a0e..a44f332d24 100644 --- a/docs/deployment/snippets/14_run_smoke_tests.partial.md +++ b/docs/deployment/snippets/14_run_smoke_tests.partial.md @@ -10,4 +10,4 @@ They are automatically uploaded to the SRD during the deployment step. - if any of the tests fail, check the `README.md` in this folder for help in diagnosing the issues - Copy `tests/test_jupyter.ipynb` to your home directory - activate each of the available Python versions in turn - - run `jupyter notebook` in each case and check that you can run the notebook and that all versions and paths match throughout + - run `jupyter notebook` in each case and check that you can run the notebook and that all versions and paths match throughout. See {ref}`Available Python Versions `. diff --git a/docs/roles/researcher/snippets/04_using_srd.partial.md b/docs/roles/researcher/snippets/04_using_srd.partial.md index 92c0ed1cfc..7b8fefcfc0 100644 --- a/docs/roles/researcher/snippets/04_using_srd.partial.md +++ b/docs/roles/researcher/snippets/04_using_srd.partial.md @@ -78,6 +78,8 @@ For example: :align: center ``` +(available_python_and_r_versions)= + ### {{snake}} Available Python and R versions Typing `R` at the command line will give you the system version of `R` with many custom packages pre-installed.