Skip to content

Commit

Permalink
minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
epassaro committed Dec 16, 2020
1 parent f3517b4 commit 9a8ece8
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions docs/development/pr_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,42 @@
Documentation Preview
*********************

Most of the time it's enough to build documentation locally
Most of the time it's enough to build the documentation locally
and see how things are going. But sometimes it's nice to share
our changes to get some feedback from other collaborators.
our changes and get some feedback from other collaborators.

Unfortunately, GitHub Pages does not provide a simple way to
preview documentation changes from a pull request as Read The Docs
does, but there's a way to achieve this that suits most of our use
cases.
preview documentation changes from a pull request (as ReadTheDocs
does) but there's a way to achieve this that suits for most of our
use cases.


=========
Procedure
=========

Imagine you are working locally on a branch named `new-feature`.
Imagine you are developing a new feature for TARDIS on your local
branch named `new-feature` and follow these steps:

- Make a new branch from the branch you are working with a suitable
name, for example: `new-feature-docs`.
- Checkout to a new branch with a suitable name,
like `new-feature-docs`.

- Edit `.github/workflows/documentation-build.yml` and add a new
trigger:
trigger below the *push* trigger:

.. code-block: none
pull_request:
branches:
- master
branches:
- master
- Push changes and make a new pull request to **your fork** *master*
- Push changes and make a new pull request to **your fork's** *master*
branch.

- Go to fork *Settings* and make sure you is building GitHub Pages from
*gh-pages* branch.
- Go to your fork's *Settings* tab make sure GitHub Pages are building
from the *gh-pages* branch.

- The documentation preview should be available at
- If everything is okm the documentation preview should be available at
`<your-username>.github.io/tardis`.

- Remember you will need to rebase `new-feature-docs` to `new-feature`
every time you make changes to `new-feature`.

0 comments on commit 9a8ece8

Please sign in to comment.