Skip to content

[DOCS] Added --linkcheckonly parameter for build_docs.pl - #262

Merged
lcawl merged 1 commit into
elastic:masterfrom
lcawl:lcawley-linkcheckonly
Nov 22, 2017
Merged

[DOCS] Added --linkcheckonly parameter for build_docs.pl#262
lcawl merged 1 commit into
elastic:masterfrom
lcawl:lcawley-linkcheckonly

Conversation

@lcawl

@lcawl lcawl commented Nov 21, 2017

Copy link
Copy Markdown
Contributor

Relates to #249, in particular:

Check cross-doc links and perform other post-build verification on specific books using the already-built versions of everything else.

This PR adds the ability to skip the time-consuming steps related to fetching and building documentation. For example:

./build_docs.pl --all --linkcheckonly
*** USING lcawley-linkcheckonly BRANCH ***
Checking GitHub username and password
Updating repositories
Skipping fetching repo apm-agent-nodejs.
Skipping fetching repo apm-agent-python.
Skipping fetching repo apm-server.
Skipping fetching repo beats.
Skipping fetching repo cloud.
Skipping fetching repo curator.
Skipping fetching repo elasticsearch.
Skipping fetching repo elasticsearch-hadoop.
Skipping fetching repo elasticsearch-js.
Skipping fetching repo elasticsearch-net.
Skipping fetching repo elasticsearch-php.
Skipping fetching repo guide.
Skipping fetching repo guide-cn.
Skipping fetching repo kibana.
Skipping fetching repo logstash.
Skipping fetching repo logstash-docs.
Skipping fetching repo sense.
Skipping fetching repo stack-docs.
Skipping fetching repo x-pack.
Skipping fetching repo x-pack-elasticsearch.
Skipping fetching repo x-pack-kibana.
Skipping fetching repo x-pack-logstash.
Removing old repo <.temp>
Skipping documentation builds.
Checking links
Checking Kibana links
Branch 5.0
Branch 5.1
Branch 5.2
Branch 5.3
Branch 5.4
Branch 5.5
Branch 5.6
Branch 6.0
Branch 6.x
Branch master
All cross-document links OK

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):

Can't open directory html/en/kibana: No such file or directory at ./build_docs.pl line 251.

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.

@lcawl lcawl added the docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo. label Nov 21, 2017
@lcawl
lcawl requested a review from clintongormley November 21, 2017 23:28
@debadair debadair mentioned this pull request Nov 22, 2017
2 tasks
@lcawl
lcawl merged commit ff56570 into elastic:master Nov 22, 2017
@lcawl
lcawl deleted the lcawley-linkcheckonly branch November 22, 2017 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants