[DOCS] Added --linkcheckonly parameter for build_docs.pl - #262
Merged
Conversation
clintongormley
approved these changes
Nov 22, 2017
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
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.
Relates to #249, in particular:
This PR adds the ability to skip the time-consuming steps related to fetching and building documentation. For example:
The expectation is that this script would be run after a full build had already been done (otherwise the script cannot find the output files and returns an error like this):
The idea is that you could run a build for a specific book, copy the output to the appropriate elastic/docs/html/ folder, then run the build --all --linkcheckonly to quickly check for broken links before you merge your documentation changes.