Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Create and apply attributes for ECS default messaging #13464

Open
6 of 17 tasks
Tracked by #13420
karenzone opened this issue Nov 30, 2021 · 0 comments
Open
6 of 17 tasks
Tracked by #13420

Doc: Create and apply attributes for ECS default messaging #13464

karenzone opened this issue Nov 30, 2021 · 0 comments
Assignees

Comments

@karenzone
Copy link
Contributor

karenzone commented Nov 30, 2021

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

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant