-
Epic
-
Resolution: Unresolved
-
Major
-
None
-
None
-
Push plugin docs to collectd wiki
The Barometer team has created and contributed to several collectd plugins.
Most of the documentation, test plans and configuration information for these plugins is on the Barometer wiki, and not on the collectd wiki.
The docs should be moved to the collectd wiki.
There are gaps between the collectd wiki and the upstream docs, these should eventually be closed. The intention later would be to replicate some of the information in the collectd wiki into the upstream docs. For this to occur, the docs need to be up to date.
Information to be added to the wiki page:
- Plugin details in the summary box on the top right
- Link to the PR
- Link to Barometer wiki and test plans
- Test plan page (and link to main plugin page)
- Config cookbook page, showing various config examples (if applicable)
- Plugin history - copy the entries from the release pages for each update to this plugin, to show what versions that various features were introduced in
- Is the plugin included in the table of plugins?
Info to add to collectd repo:
- small paragraph in the README and make sure the dependencies are listed
- Entry in collectd.conf.pod for config details
Wiki page layout
There are a bunch of sections conventionally used in the collectd wiki.
TODO: Add these in here
There are also certain templates and categories used for navigation.
TODO: add these in here
Plugins
PCIe Advanced Error Reporting Plugin
These plug-ins are in various stages of being ported over, and stories/tasks will be created to track progress.
- clones
-
BAROMETER-136 Move HLDs to collectd wiki
- Closed