Skip to content

Commit

Permalink
clarify docs publishing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Christian Rehm committed Oct 28, 2022
1 parent a1135f0 commit 9e2b467
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/contributing/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,20 @@

## Publish

> **NOTE**: This requires [Docker](https://www.docker.com/) to be installed on your
machine and you to be authenticated against GitHub (for example via [SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh)).

1. Pull down the `gh-pages` branch. This only needs to be done once

git checkout --track origin/gh-pages

1. Run the `publish_documentation` script
2. Switch back to the `main` branch

git checkout main

3. Run the `publish_documentation` script

./publish_documentation.sh
1. Visit the hosted documentation

4. Visit the hosted documentation
**[https://wayfair-incubator.github.io/extra-model/site/](https://wayfair-incubator.github.io/extra-model/site/)**

0 comments on commit 9e2b467

Please sign in to comment.