@@ -82,7 +82,41 @@ Best practice workflow for contributing to site changes
82
82
``make docker-gh-preview ``
83
83
84
84
to build the website inside a docker container with all the correct
85
- dependencies and configuration taken care of automagically.
85
+ dependencies and configuration taken care of automagically. Once this
86
+ is done, navigate into the gh-build directory and serve the website.
87
+
88
+
89
+ ::
90
+
91
+ cd gh-build
92
+ python3 -m http.server <port number>
93
+
94
+
95
+ the most common port number for things like this is 8000, or 8080,
96
+ and as such choosing one of these is recommended:
97
+
98
+ ``python3 -m http.server 8000 ``
99
+
100
+ If you are building the website on a computer which you are
101
+ connected to remotely, it will then be necessary to create a tunnel
102
+ between your local and remote machines. This can be done with:
103
+
104
+ ``ssh -L <port number>:localhost:<port number> username@remote ``
105
+
106
+ So if using port 8000 as in the example above, and connecting to a
107
+ remote machine which you had listed in your config file as "remote-machine"
108
+ the command would look something like this:
109
+
110
+ ``ssh -L 8000:localhost:8000 username@remote-machine ``
111
+
112
+ Finally, connect to the website on your computer by opening a browser
113
+ and going to:
114
+
115
+ ``http://localhost:<port number> ``
116
+
117
+ which in the example above would look like:
118
+
119
+ ``http://loaclhost:8000 ``
86
120
87
121
6. Repeat steps 4-5 until satisfied.
88
122
0 commit comments