[main](forwardport #45815) [9.0](backport #45772) [docs automation] Update generate_fields_docs.py to add applies_to badges#46046
Closed
mergify[bot] wants to merge 1 commit intomainfrom
Closed
Conversation
….py` to add applies_to badges (#45815) * [docs automation] Update `generate_fields_docs.py` to add applies_to badges (#45772) Add applies_to to more situations in exported fields * update generate_fields_docs.py to add `applies_to` badges * Overall documentation update --------- Co-authored-by: Denis <denis.rechkunov@elastic.co> (cherry picked from commit 7fbc298) # Conflicts: # docs/reference/filebeat/exported-fields-winlog.md # docs/reference/metricbeat/exported-fields-kubernetes.md # docs/reference/metricbeat/exported-fields-nats.md # docs/reference/metricbeat/exported-fields-system.md # docs/reference/metricbeat/exported-fields-windows.md * remove 9.1 and 9.2 updates * rereun update --------- Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> (cherry picked from commit 1121991) # Conflicts: # docs/reference/filebeat/exported-fields-winlog.md # docs/reference/metricbeat/exported-fields-kubernetes.md # docs/reference/metricbeat/exported-fields-nats.md # docs/reference/metricbeat/exported-fields-system.md
Contributor
Author
|
Cherry-pick of 1121991 has failed: To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally |
Contributor
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
Contributor
Contributor
|
I'm not sure why this, a forwardport of a backport, was opened by mergify. These changes were already merged into |
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.
Note
Starting with v9.0, there is no longer a new documentation set published with every minor release: the same page stays valid over time and shows version-related evolutions. Read more in Write cumulative documentation.
Related to #45436, https://github.com/elastic/docs-content-internal/issues/128
Updates
generate_fields_docs.pyto add moreapplies_tobadges as needed. Currently we're only addingdeprecatedbadges to fields when there's adeprecatedproperty infields.yml. In addition to those, we want to add anapplies_tobadge when:releasespecified (usually included ifbetaorpreview).versionproperty specified as described in [docs] [proof-of concept] Make it possible to addapplies_tolabels to generated docs #45436. This allows contributors to include version information over time for fields or groups of fields. For example, for a field that was added in beta in 9.0.0 and then went GA in 9.1.0, you would add:To test out the new
versionproperty, I added aversiontofields.ymlfiles that contained new fields in 9.1.0 from these two PRs:I also made some slight formatting changes to improve how definition lists are rendered (indenting all lines in a definition list item).
Some notes for the reviewers:
This is an automatic backport of pull request [docs automation] Update
generate_fields_docs.pyto add applies_to badges #45772 done by Mergify.This is an automatic backport of pull request [9.0](backport #45772) [docs automation] Update
generate_fields_docs.pyto add applies_to badges #45815 done by Mergify.