Add note about --resources parameter #372
Closed
Conversation
This file contains 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
After the x-pack merge, building the Elasticsearch reference documentation requires specifying additional resources using the `--resource` parameter. This change adds a note to check the doc_build_aliases.sh file if ommiting this parameteer leads to errors and adds an example for building the reference documentation.
|
Since I ran into this and it took me a bit to understand whats wrong I think some sort of note is useful. Maybe there are other places where this fits in better, please let me know. |
cbuescher
added
enhancement
|
@cbuescher That build command will change again shortly (i.e. the --resources parameter will no longer be required when elastic/elasticsearch#30665 is complete). In general I think it's best to encourage people to use that aliases file, since we keep that up-to-date with the changes. |
Didn't know that, I guess mentioning the alias file is suffiecient then, I just didn't know it yet. We can close this then. |
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.
After the x-pack merge, building the Elasticsearch reference documentation
requires specifying additional resources using the
--resourceparameter.This change adds a note to check the doc_build_aliases.sh file if ommiting this
parameter leads to errors and adds an example for building the reference
documentation.