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

Update plugins documentation #6001

Open
taras-z opened this issue Nov 21, 2022 · 0 comments
Open

Update plugins documentation #6001

taras-z opened this issue Nov 21, 2022 · 0 comments
Labels
type:maintenance tests, chores, or project maintenance

Comments

@taras-z
Copy link

taras-z commented Nov 21, 2022

Summary

It would be nice to read updated information about provided official and community plugins that can lower the entrance level to new users and developers.

The Plugins page contains:

  1. descriptions not for [all plugins],(https://github.com/nasa/openmct/blob/master/src/plugins/plugins.js)
  2. broken links.

Solutions

There are a few ways to improve plugins documentation:

  1. Update the page manually:
    1.1. by hand (for example, monthly),
    1.2. check changes by git history and update descriptions.
  2. Update the page automatically:
    2.1. by scheduled routine (for example, weekly),
    2.1. generate (compile) the page from a partial description of each plugin (for example, from README.rd in a plugin folder).
@taras-z taras-z added the type:maintenance tests, chores, or project maintenance label Nov 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:maintenance tests, chores, or project maintenance
Projects
None yet
Development

No branches or pull requests

1 participant