|
2 | 2 |
|
3 | 3 | ### Table of Content |
4 | 4 |
|
5 | | -1. [Overview](#overview) |
6 | | - * [Plugin Library](#plugin-library) |
7 | | -2. [Developing Plugins](#developing-plugins) |
8 | | - * [Plugin Type](#plugin-type) |
9 | | - * [Plugin Name](#plugin-name) |
10 | | - * [Plugin Metric Namespace](#plugin-metric-namespace) |
11 | | - * [Plugin Interface](#plugin-interface) |
12 | | - * [Plugin Version](#plugin-version) |
13 | | - * [Plugin Release](#plugin-release) |
14 | | - * [Plugin Metadata](#plugin-metadata) |
15 | | - * [Documentation](#documentation) |
| 5 | +* [Overview](#overview) |
| 6 | + * [Plugin Library](#plugin-library) |
| 7 | +* [Developing Plugins](#developing-plugins) |
| 8 | + * [Plugin Type](#plugin-type) |
| 9 | + * [Plugin Name](#plugin-name) |
| 10 | + * [Plugin Metric Namespace](#plugin-metric-namespace) |
| 11 | + * [Plugin Interface](#plugin-interface) |
| 12 | + * [Plugin Version](#plugin-version) |
| 13 | + * [Plugin Release](#plugin-release) |
| 14 | + * [Plugin Metadata](#plugin-metadata) |
| 15 | + * [Plugin Catalog](#plugin-catalog) |
| 16 | + * [Plugin Status](#plugin-status) |
| 17 | + * [Documentation](#documentation) |
16 | 18 |
|
17 | 19 | ## Overview |
18 | 20 |
|
@@ -133,12 +135,12 @@ We recommend sharing your plugins early and often by adding them to the list of |
133 | 135 |
|
134 | 136 | ### Plugin Catalog |
135 | 137 |
|
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: |
| 138 | +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 keep these catalogs in sync, we do the following: |
137 | 139 |
|
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. |
| 140 | +* Update [plugins.yml](plugins.yml) file to include a line containing `- org/repo_name` |
| 141 | +* Periodically run [pluginsync tool](https://github.com/intelsdi-x/snap-pluginsync#update-plugin-metadata) to update the catalog |
| 142 | +* [Plugin Metadata](#plugin-metadata) will be scanned and used accordingly when the pluginsync tool generates the catalog |
| 143 | +* We 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 since they are generated from [templates](https://github.com/intelsdi-x/snap-pluginsync/blob/master/PLUGIN_CATALOG.md.erb) |
142 | 144 |
|
143 | 145 | ### Plugin Status |
144 | 146 |
|
|
0 commit comments