diff --git a/docs/AGGREGATORS.md b/docs/AGGREGATORS.md index d0e926718..eee5b1de5 100644 --- a/docs/AGGREGATORS.md +++ b/docs/AGGREGATORS.md @@ -17,6 +17,7 @@ This section is for developers who want to create a new aggregator plugin. through it. This should be done using the builtin `HashID()` function of each metric. * When the `Reset()` function is called, all caches should be cleared. +- Follow the recommended [CodeStyle][]. ### Aggregator Plugin Example @@ -124,3 +125,4 @@ func init() { [telegraf.Aggregator]: https://godoc.org/github.com/influxdata/telegraf#Aggregator [SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig +[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle diff --git a/docs/INPUTS.md b/docs/INPUTS.md index b1b196398..32eb9b9f5 100644 --- a/docs/INPUTS.md +++ b/docs/INPUTS.md @@ -20,6 +20,7 @@ and submit new inputs. consult the [SampleConfig][] page for the latest style guidelines. - The `Description` function should say in one line what this plugin does. +- Follow the recommended [CodeStyle][]. Let's say you've written a plugin that emits metrics about processes on the current host. @@ -137,6 +138,7 @@ Check the [amqp_consumer][] for an example implementation. [prom metric types]: https://prometheus.io/docs/concepts/metric_types/ [input data formats]: https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md [SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig +[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle [telegraf.Input]: https://godoc.org/github.com/influxdata/telegraf#Input [telegraf.ServiceInput]: https://godoc.org/github.com/influxdata/telegraf#ServiceInput [telegraf.Accumulator]: https://godoc.org/github.com/influxdata/telegraf#Accumulator diff --git a/docs/OUTPUTS.md b/docs/OUTPUTS.md index cfa8083b4..306b9ea6f 100644 --- a/docs/OUTPUTS.md +++ b/docs/OUTPUTS.md @@ -15,6 +15,7 @@ similar constructs. plugin can be configured. This is included in `telegraf config`. Please consult the [SampleConfig][] page for the latest style guidelines. - The `Description` function should say in one line what this output does. +- Follow the recommended [CodeStyle][]. ### Output Plugin Example @@ -92,4 +93,5 @@ You should also add the following to your `SampleConfig()`: [file]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/file [output data formats]: https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md [SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig +[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle [telegraf.Output]: https://godoc.org/github.com/influxdata/telegraf#Output diff --git a/docs/PROCESSORS.md b/docs/PROCESSORS.md index e1fa182ca..4f18b2d55 100644 --- a/docs/PROCESSORS.md +++ b/docs/PROCESSORS.md @@ -16,6 +16,7 @@ This section is for developers who want to create a new processor plugin. plugin can be configured. This is included in `telegraf config`. Please consult the [SampleConfig][] page for the latest style guidelines. * The `Description` function should say in one line what this processor does. +- Follow the recommended [CodeStyle][]. ### Processor Plugin Example @@ -60,4 +61,5 @@ func init() { ``` [SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig +[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle [telegraf.Processor]: https://godoc.org/github.com/influxdata/telegraf#Processor