Skip to content

Commit

Permalink
feat(docs): include documentation on how to build docs locally
Browse files Browse the repository at this point in the history
  • Loading branch information
V committed Dec 2, 2024
1 parent fb4e341 commit 5dc53ed
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/contribute/submitting_changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,14 @@ The action is an automated service provided by GitHub that ensures suggested add

Our GitHub action is triggered on pushes to the `data-infra` repository related to the `docs` directory.

Another way to edit and test your markdown changes is using the jupyterhub. Edit the text files directly then run this command from the base of the data-infra repo: `jb build docs --warningiserror`.

This will locally build the docs and allow you to test your changes without having to make lots of commits.

(docs-preview)=

## How do I preview my docs change?

Once the GitHub action has run and all tests have passed a 'Netlify' preview link will be generated. You can find this link in the comments of your PR. Follow that link to preview your changes.
![Collection Matrix](assets/netlify-link.png)

0 comments on commit 5dc53ed

Please sign in to comment.