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

Commit

Permalink
Adjusted Plugin Catalog explanation
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
mbbroberg authored and nanliu committed Jan 20, 2017
1 parent 731ba2b commit a0a2f99
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions docs/PLUGIN_AUTHORING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,19 @@

### Table of Content

1. [Overview](#overview)
* [Plugin Library](#plugin-library)
2. [Developing Plugins](#developing-plugins)
* [Plugin Type](#plugin-type)
* [Plugin Name](#plugin-name)
* [Plugin Metric Namespace](#plugin-metric-namespace)
* [Plugin Interface](#plugin-interface)
* [Plugin Version](#plugin-version)
* [Plugin Release](#plugin-release)
* [Plugin Metadata](#plugin-metadata)
* [Documentation](#documentation)
* [Overview](#overview)
* [Plugin Library](#plugin-library)
* [Developing Plugins](#developing-plugins)
* [Plugin Type](#plugin-type)
* [Plugin Name](#plugin-name)
* [Plugin Metric Namespace](#plugin-metric-namespace)
* [Plugin Interface](#plugin-interface)
* [Plugin Version](#plugin-version)
* [Plugin Release](#plugin-release)
* [Plugin Metadata](#plugin-metadata)
* [Plugin Catalog](#plugin-catalog)
* [Plugin Status](#plugin-status)
* [Documentation](#documentation)

## Overview

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

### Plugin Catalog

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

* Update [plugins.yml](plugins.yml) file to include a line containing `- org/repo_name`.
* Our [pluginsync tool](https://github.com/intelsdi-x/snap-pluginsync#update-plugin-metadata) will be executed periodically to update our plugin catalog.
* [Plugin Metadata](#plugin-metadata) will be scanned and used accordingly when the pluginsync generates the catalog.
* 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.
* Update [plugins.yml](plugins.yml) file to include a line containing `- org/repo_name`
* Periodically run [pluginsync tool](https://github.com/intelsdi-x/snap-pluginsync#update-plugin-metadata) to update the catalog
* [Plugin Metadata](#plugin-metadata) will be scanned and used accordingly when the pluginsync tool generates the catalog
* 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)

### Plugin Status

Expand Down

0 comments on commit a0a2f99

Please sign in to comment.