Change nginx layout of --open #667
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When you run a build with `--open` we start a web server locally and open up a browser window for you to look at them. With the docker-based `build_docs` that server is nginx. nginx is fancy, and one of the things that we can do pretty easily is lay out the files that we serve so they look fairly like the public web site. This change does just that and it should come in handy to test future work we plan to do that generates an nginx config to deploy to the site serving the docs.
nik9000
commented
Mar 5, 2019
build_docs
Outdated
| @@ -234,7 +234,7 @@ def run_build_docs(args): | |||
| # is weird. If we tell it that the browser's name is `open` | |||
| # we'll get whatever the user set as their default browser. | |||
| environ['BROWSER'] = 'open' | |||
| webbrowser.open('http://localhost:8000', new=1, autoraise=False) | |||
| webbrowser.open('http://localhost:8000/guide', new=1, autoraise=False) | |||
There was a problem hiding this comment.
This is the new path. It mirrors the public site nicely when you do ./build_docs --all --open
| @@ -710,7 +710,7 @@ sub serve_and_open_browser { | |||
| if ( not $running_in_standard_docker ) { | |||
| sleep 1; | |||
| say "Press Ctrl-C to exit the web server"; | |||
| open_browser("http://localhost:8000/$open_path"); | |||
| open_browser("http://localhost:8000/"); | |||
There was a problem hiding this comment.
This is always the path when you build the docs with ./build_docs.pl which doesn't support --all.
|
Thanks for reviewing @Jarpy! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When you run a build with
--openwe start a web server locally andopen up a browser window for you to look at them. With the docker-based
build_docsthat server is nginx. nginx is fancy, and one of the thingsthat we can do pretty easily is lay out the files that we serve so they
look fairly like the public web site. This change does just that and it
should come in handy to test future work we plan to do that generates an
nginx config to deploy to the site serving the docs.