Skip to content

Commit

Permalink
Merge pull request #1360 from edwardchalstrey1/python-version-link
Browse files Browse the repository at this point in the history
Add a link to Python versions in smoke test docs & update how to build docs
  • Loading branch information
edwardchalstrey1 authored Jan 26, 2023
2 parents 3060edc + 6cc29e6 commit 2483b6a
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 1 deletion.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/snippets/14_run_smoke_tests.partial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <available_python_and_r_versions>`.
2 changes: 2 additions & 0 deletions docs/roles/researcher/snippets/04_using_srd.partial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 2483b6a

Please sign in to comment.