VPR: Add attribute for ecs default #1128
Merged
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
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.
Release notes
[rn:skip]
What does this PR do?
Adds and links shared attribute file for accurately stating ecs default status for the Versioned Plugin Reference.
Design intent/usage
We can add/update text related to ecs defaults (or other info we want to write once and use multiple places). Then, we can reference it by calling the attribute. In this case
{ecs-default}.Important: This work mirrors a corresponding change for the Logstash Reference.
Potential gotchas
The Versioned Plugin Reference isn't stack versioned. This detail could make consistent messaging across plugins and versions tricky. If we apply this attribute and then change the text, the new text will be applied to every version (past, present, and future) of every plugin using the attribute.
One possibility: introduce a new attribute for each major change to messaging, and replace the old attribute with the new one in the source file. Then the updated messaging will be applied only to applicable plugin versions and newer.
ToDo
Related: elastic/logstash#13083
Test set: #1161
PREVIEW: https://logstash-docs_1161.docs-preview.app.elstc.co/guide/en/logstash-versioned-plugins/current/v1.3.0-plugins-inputs-azure_event_hubs.html#_test_attribute_here