Allow running --open with --all #660
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
This allows you to `--open` the docs built with `--all`. This should be useful when testing changes that effect all docs, like the redirect work that I plan on doing soon. There is a wrinkle though: to make serving the docs locally work we actually built *different* docs. We'd switch from finding jQuery at `/static/js/jquery.min.js` to getting it from `https://www.elastic.co/static/js/jquery.min.js`. This worked, and it was simple enough to do for the built in python web server that we use when you run `--open` outside of docker, but we don't want to do that when we serve all of the docs because most of the docs will have been built with the standard template. But now that we have docker we don't have to! In docker we're using nginx to serve the docs and we can write a few rewrite rules to fix the missing assets. For good measure we assets rewrite when we're running in docker even when we're building a single doc. So now building a single doc is just that much more real!
ghost
approved these changes
Mar 4, 2019
| @@ -733,6 +670,82 @@ sub pick_conf { | |||
| die $Opts->{conf} . " doesn't exist"; | |||
| } | |||
|
|
|||
| #=================================== | |||
| sub serve_and_open_browser { | |||
| #=================================== | |||
There was a problem hiding this comment.
decomposition
Much ❤️ for decomposition.
|
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.
This allows you to
--openthe docs built with--all. This should beuseful when testing changes that effect all docs, like the redirect work
that I plan on doing soon.
There is a wrinkle though: to make serving the docs locally work we
actually built different docs. We'd switch from finding jQuery at
/static/js/jquery.min.jsto getting it fromhttps://www.elastic.co/static/js/jquery.min.js. This worked, and itwas simple enough to do for the built in python web server that we use
when you run
--openoutside of docker, but we don't want to do thatwhen we serve all of the docs because most of the docs will have been
built with the standard template.
But now that we have docker we don't have to! In docker we're using
nginx to serve the docs and we can write a few rewrite rules to fix the
missing assets. For good measure we assets rewrite when we're running in
docker even when we're building a single doc. So now building a single
doc is just that much more real!