Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,41 @@ Best practice workflow for contributing to site changes
``make docker-gh-preview``

to build the website inside a docker container with all the correct
dependencies and configuration taken care of automagically.
dependencies and configuration taken care of automagically. Once this
is done, navigate into the gh-build directory and serve the website.


::

cd gh-build
python3 -m http.server <port number>


the most common port number for things like this is 8000, or 8080,
and as such choosing one of these is recommended:

``python3 -m http.server 8000``

If you are building the website on a computer which you are
connected to remotely, it will then be necessary to create a tunnel
between your local and remote machines. This can be done with:

``ssh -L <port number>:localhost:<port number> username@remote``

So if using port 8000 as in the example above, and connecting to a
remote machine which you had listed in your config file as "remote-machine"
the command would look something like this:

``ssh -L 8000:localhost:8000 username@remote-machine``

Finally, connect to the website on your computer by opening a browser
and going to:

``http://localhost:<port number>``

which in the example above would look like:

``http://loaclhost:8000``

6. Repeat steps 4-5 until satisfied.

Expand Down