From 5be472b736f997e9e9879d9c96a58fae61763324 Mon Sep 17 00:00:00 2001 From: Dean Krueger Date: Fri, 17 Jan 2025 15:27:05 -0600 Subject: [PATCH 1/4] added more detailed instructions to the README on building and previewing the website --- README.rst | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 191b281a..5115c0f2 100644 --- a/README.rst +++ b/README.rst @@ -82,7 +82,28 @@ 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 `` + + 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 :localhost: 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`` 6. Repeat steps 4-5 until satisfied. From d5508e560bfafadee6c33aa199b66a62c1fbc15d Mon Sep 17 00:00:00 2001 From: Dean Krueger Date: Fri, 17 Jan 2025 15:29:49 -0600 Subject: [PATCH 2/4] fixed the formatting of the cd gh-build --> python3 -m ... part of the readme --- README.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 5115c0f2..8c40cf7e 100644 --- a/README.rst +++ b/README.rst @@ -85,8 +85,12 @@ Best practice workflow for contributing to site changes 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 `` + + :: + + cd gh-build + python3 -m http:server + the most common port number for things like this is 8000, or 8080, and as such choosing one of these is recommended: From f585d67137e431a79ee22b3ca964fe79b98a3ae1 Mon Sep 17 00:00:00 2001 From: Dean Krueger Date: Fri, 17 Jan 2025 15:37:41 -0600 Subject: [PATCH 3/4] added instructions for viewing the website on localhost --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index 8c40cf7e..a347bedc 100644 --- a/README.rst +++ b/README.rst @@ -109,6 +109,15 @@ Best practice workflow for contributing to site changes ``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:`` + + which in the example above would look like: + + ``http://loaclhost:8000`` + 6. Repeat steps 4-5 until satisfied. 7. Once satisfied with the source RST files, push your branch to your fork of From 2003c4b37022cf04d7682fc95a40a52bd8856888 Mon Sep 17 00:00:00 2001 From: Dean Krueger Date: Thu, 23 Jan 2025 13:16:13 -0600 Subject: [PATCH 4/4] changed the : in python3 -m http:server 8000 to a period (python3 -m http.server 8000), which is the correct syntax of the command. Made change in both locations --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index a347bedc..a79a7e29 100644 --- a/README.rst +++ b/README.rst @@ -89,13 +89,13 @@ Best practice workflow for contributing to site changes :: cd gh-build - python3 -m http:server + python3 -m http.server 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`` + ``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