Skip to content

Add note about --resources parameter #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add note about --resources parameter #372

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,14 @@ build_docs.pl --doc path/to/index.asciidoc
To use simplified aliases for the build commands for each book, see
`doc_build_aliases.sh`.

NOTE: Some documentation parts, e.g. the Elasticseach reference
documentation, may need additional resources specified with the
`--resource` parameter. If you get errors with a particular book,
you should consult the above mentioned alias file as well. For
example, to build the Elasticsearch reference documentation, you
will need to run
`build_docs.pl --doc docs/reference/index.asciidoc --resource=x-pack/docs/`

=== Specifying a different output dir

By default, the HTML docs are generated in `./html_docs`. You can
Expand Down