Split parser/serializer docs (influxdata#4690)

README.md

@@ -1,23 +1,19 @@
 # Telegraf [![Circle CI](https://circleci.com/gh/influxdata/telegraf.svg?style=svg)](https://circleci.com/gh/influxdata/telegraf) [![Docker pulls](https://img.shields.io/docker/pulls/library/telegraf.svg)](https://hub.docker.com/_/telegraf/)
 
-Telegraf is an agent written in Go for collecting, processing, aggregating,
-and writing metrics.
+Telegraf is an agent for collecting, processing, aggregating, and writing metrics.
 
 Design goals are to have a minimal memory footprint with a plugin system so
-that developers in the community can easily add support for collecting metrics
-.  For an example configuration referencet from local or remote services.
+that developers in the community can easily add support for collecting
+metrics.
 
-Telegraf is plugin-driven and has the concept of 4 distinct plugins:
+Telegraf is plugin-driven and has the concept of 4 distinct plugin types:
 
 1. [Input Plugins](#input-plugins) collect metrics from the system, services, or 3rd party APIs
 2. [Processor Plugins](#processor-plugins) transform, decorate, and/or filter metrics
 3. [Aggregator Plugins](#aggregator-plugins) create aggregate metrics (e.g. mean, min, max, quantiles, etc.)
 4. [Output Plugins](#output-plugins) write metrics to various destinations
 
-For more information on Processor and Aggregator plugins please [read this](./docs/AGGREGATORS_AND_PROCESSORS.md).
-
-New plugins are designed to be easy to contribute,
-we'll eagerly accept pull
+New plugins are designed to be easy to contribute, we'll eagerly accept pull
 requests and will manage the set of plugins that Telegraf supports.
 
 ## Contributing
@@ -26,7 +22,7 @@ There are many ways to contribute:
 - Fix and [report bugs](https://github.com/influxdata/telegraf/issues/new)
 - [Improve documentation](https://github.com/influxdata/telegraf/issues?q=is%3Aopen+label%3Adocumentation)
 - [Review code and feature proposals](https://github.com/influxdata/telegraf/pulls)
-- Answer questions on github and on the [Community Site](https://community.influxdata.com/)
+- Answer questions and discuss here on github and on the [Community Site](https://community.influxdata.com/)
 - [Contribute plugins](CONTRIBUTING.md)
 
 ## Installation:
@@ -42,7 +38,7 @@ Ansible role: https://github.com/rossmcdonald/telegraf
 
 Telegraf requires golang version 1.9 or newer, the Makefile requires GNU make.
 
-1. [Install Go](https://golang.org/doc/install) >=1.9
+1. [Install Go](https://golang.org/doc/install) >=1.9 (1.10 recommended)
 2. [Install dep](https://golang.github.io/dep/docs/installation.html) ==v0.5.0
 3. Download Telegraf source:
    ```
@@ -86,44 +82,47 @@ These builds are generated from the master branch:
 See usage with:
 
 ```
-./telegraf --help
+telegraf --help
 ```
 
 #### Generate a telegraf config file:
 
 ```
-./telegraf config > telegraf.conf
+telegraf config > telegraf.conf
 ```
 
 #### Generate config with only cpu input & influxdb output plugins defined:
 
 ```
-./telegraf --input-filter cpu --output-filter influxdb config
+telegraf --input-filter cpu --output-filter influxdb config
 ```
 
 #### Run a single telegraf collection, outputing metrics to stdout:
 
 ```
-./telegraf --config telegraf.conf --test
+telegraf --config telegraf.conf --test
 ```
 
 #### Run telegraf with all plugins defined in config file:
 
 ```
-./telegraf --config telegraf.conf
+telegraf --config telegraf.conf
 ```
 
 #### Run telegraf, enabling the cpu & memory input, and influxdb output plugins:
 
 ```
-./telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
+telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
 ```
 
+## Documentation
+
+[Latest Release Documentation][release docs].
 
-## Configuration
+For documentation on the latest development code see the [documentation index][devel docs].
 
-See the [configuration guide](docs/CONFIGURATION.md) for a rundown of the more advanced
-configuration options.
+[release docs]: https://docs.influxdata.com/telegraf
+[devel docs]: docs
 
 ## Input Plugins