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

Commit

Permalink
Merge pull request #1481 from nanliu/docs
Browse files Browse the repository at this point in the history
Add section on how plugin catalog works.
  • Loading branch information
nanliu authored Jan 20, 2017
2 parents f240e29 + a0a2f99 commit f36d1aa
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 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 @@ -131,6 +133,15 @@ All metadata fields are optional, but recommended to help users discover your pl

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`.

### 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`
* 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

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).
Expand Down

0 comments on commit f36d1aa

Please sign in to comment.