You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We need a way to consistently message ECS default status across plugins. By carefully crafting and applying a shared attribute, we can ensure that the messaging is consistent across plugins. This approach also ensures that the text doesn't diverge over time from plugin to plugin.
If we need to change or tweak the info, we can update text in the attribute (and corresponding attribute in the VPR attributes file), and have the updates reflected in all plugins where the attribute is used.
Set up framework
Create shared attribute files for use in plugin docs. Set up :include: statements to make attributes available.
VPR: N/A (The VPR is not stack versioned, so backports don't apply.)
IMPORTANT: Set up and validate the attributes for both the Logstash Reference and the Versioned Plugin Reference before applying the attributes. Otherwise, we'll crash the doc build.
Next steps
Apply attribute to plugin doc source files.
Replace current hard-coded text in plugin with attribute
Test locally
Bump versions, and publish
Plan: Start by testing one plugin, publishing it, and validating it for both the LSR and VPR docgen process.
The text was updated successfully, but these errors were encountered:
We need a way to consistently message ECS default status across plugins. By carefully crafting and applying a shared attribute, we can ensure that the messaging is consistent across plugins. This approach also ensures that the text doesn't diverge over time from plugin to plugin.
If we need to change or tweak the info, we can update text in the attribute (and corresponding attribute in the VPR attributes file), and have the updates reflected in all plugins where the attribute is used.
Set up framework
:include:
statements to make attributes available.IMPORTANT: Set up and validate the attributes for both the Logstash Reference and the Versioned Plugin Reference before applying the attributes. Otherwise, we'll crash the doc build.
Next steps
The text was updated successfully, but these errors were encountered: