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

Commit a0a2f99

Browse files
mbbrobergnanliu
authored andcommitted
Adjusted Plugin Catalog explanation
Changed the audience to explaining how we update the catalog to get away from implying others should run through these steps themselves. This text will be helpful for future maintainers to understand the toolchain here. Also cleaned up some formatting + table of contents.
1 parent 731ba2b commit a0a2f99

1 file changed

Lines changed: 18 additions & 16 deletions

File tree

docs/PLUGIN_AUTHORING.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
### Table of Content
44

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)
1618

1719
## Overview
1820

@@ -133,12 +135,12 @@ We recommend sharing your plugins early and often by adding them to the list of
133135

134136
### Plugin Catalog
135137

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:
137139

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)
142144

143145
### Plugin Status
144146

0 commit comments

Comments
 (0)