Add --force-docs option
#1879
Merged
Add --force-docs option
#1879
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
kgeller
approved these changes
Apr 14, 2022
ebeahan
added a commit
to ebeahan/ecs
that referenced
this pull request
Apr 14, 2022
* add --force-docs flag * document --force-docs * include mixing doc updates * changelog (cherry picked from commit 7c8cd17)
ebeahan
added a commit
to ebeahan/ecs
that referenced
this pull request
Apr 14, 2022
* add --force-docs flag * document --force-docs * include mixing doc updates * changelog (cherry picked from commit 7c8cd17) # Conflicts: # docs/fields/fields.asciidoc # docs/index.asciidoc
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
ebeahan
added a commit
that referenced
this pull request
Apr 14, 2022
ebeahan
added a commit
that referenced
this pull request
Apr 14, 2022
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.
Overview
Adds a new argument,
--force-docs,to the generator script. This option forces the ECS docs (./docsdir) to be generated even if--subset,--include,or--excludeare also set.Background
When
--subsetand--includeflags were originally introduced, the generator would exit before generating the./docsfiles. The ECS docs are purpose-formatted for Elastic's doc framework. Users generating custom artifacts with--includeand/or--subsetare unlikely to use./docsas-is.With the change introduced in #1847, the ECS docs aren't updating running
make.The--force-docsoption generates the./docsdirectory even if these custom options are also set.