Skip to content
This repository was archived by the owner on Nov 8, 2022. It is now read-only.

Commit 731ba2b

Browse files
committed
Add section on how plugin catalog works.
1 parent 48cf90f commit 731ba2b

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/PLUGIN_AUTHORING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,15 @@ All metadata fields are optional, but recommended to help users discover your pl
131131

132132
We recommend sharing your plugins early and often by adding them to the list of known plugins. To list your plugin in the plugin catalog, please submit a PR and update [plugins.yml](./plugins.yml) file to include the plugin's github `organization/repo_name`.
133133

134+
### Plugin Catalog
135+
136+
We provide a list of snap plugins at [snap-telemetry.io](http://snap-telemetry.io/plugins.html) and in [this repo](PLUGIN_CATALOG.md). To include your plugins in our plugin catalog:
137+
138+
* Update [plugins.yml](plugins.yml) file to include a line containing `- org/repo_name`.
139+
* Our [pluginsync tool](https://github.com/intelsdi-x/snap-pluginsync#update-plugin-metadata) will be executed periodically to update our plugin catalog.
140+
* [Plugin Metadata](#plugin-metadata) will be scanned and used accordingly when the pluginsync generates the catalog.
141+
* Please do _not_ make changes directly to [PLUGIN_CATALOG.md](plugin_catalog.md) or the [parsed_plugin_list.js](https://github.com/intelsdi-x/snap/blob/gh-pages/assets/catalog/parsed_plugin_list.js) file.
142+
134143
### Plugin Status
135144

136145
While the Snap framework is hardened through tons of testing, **plugins mature at their own pace**. We want our community to share plugins early and update them often. We are defining categories of maturity of a plugin and will roll them out with the resolution of [#1322](https://github.com/intelsdi-x/snap/issues/1322).

0 commit comments

Comments
 (0)