Readme build instructions #410
Conversation
|
should be |
There was a problem hiding this comment.
A comment about port-forwarding and when it's necessary.
Also, does it make sense to describe how to serve it from inside a docker container and access it? Or do we assume/instruct people to bind mount everything and then launch the server from outside the docker container?
|
|
||
| ``python3 -m http:server 8000`` | ||
|
|
||
| If you are building the website on a computer which you are |
There was a problem hiding this comment.
I think there are too issues here. In general, you could access the remote machine directly as:
https://remote.machine:8000
But if that remote machine is behind a firewall then you will need port-forwarding as well.
There was a problem hiding this comment.
Huh, I didn't know you could access remote machines like that. You're saying that for, say, non-UW machines you'd be able to just connect to your remote machine's IP: to see the page (assuming there wasn't some other firewall)? I've never done that method before, and so I'm not totally certain how it works. However, especially for our workflow here at UW the method I outlined gets the job done. This leads me to wonder how big the Venn diagram intersection of "people who want to contribute to the website who aren't associated with UW" and "people who want to build the website on a remote machine and access it through a local machine" is. Let me know if you think it's worth it for me to write a little section about what to do in that case. I THINK what I wrote will work for all cases, so maybe it's best to just leave that as the default instruction (I'm not aware of any big issue with doing ssh -L 8000:localhost:8000 [email protected], but I'm also not an expert).
…http.server 8000), which is the correct syntax of the command. Made change in both locations
Fixed |
Previous versions of the README left users (me when I was trying to do this for the first time) high and dry after telling them to run
make docker-gh-preview. It was not at all clear that to actually view the changes made to the website it needed to be served and visited at localhost. This version of the README gives users (especially new ones) more detailed instructions on exactly what they need to do after they make changes to the website so that they can check their work.Closes #397