From c56a652b4d295b52c3583d191e41b8cf552db42b Mon Sep 17 00:00:00 2001 From: Thomas Casteleyn Date: Tue, 6 Jul 2021 23:20:53 +0200 Subject: [PATCH] Improve documentation (#9457) --- CONTRIBUTING.md | 6 +++--- README.md | 4 +++- config/README.md | 1 + docs/developers/README.md | 1 + 4 files changed, 8 insertions(+), 4 deletions(-) create mode 120000 config/README.md create mode 120000 docs/developers/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ada24a76..ea06a968c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,11 +14,11 @@ 1. Open a new [pull request][]. #### Contributing an External Plugin *(new)* -Input, output, and processor plugins written for internal Telegraf can be run as externally-compiled plugins through the [Execd Input](plugins/inputs/execd), [Execd Output](/plugins/outputs/execd), and [Execd Processor](plugins/processors/execd) Plugins without having to change the plugin code. -Follow the guidelines of how to integrate your plugin with the [Execd Go Shim](/plugins/common/shim) to easily compile it as a separate app and run it with the respective `execd` plugin. -Check out our [guidelines](docs/EXTERNAL_PLUGINS.md#external-plugin-guidelines) on how to build and set up your external plugins to run with `execd`. +Input, output, and processor plugins written for internal Telegraf can be run as externally-compiled plugins through the [Execd Input](/plugins/inputs/execd), [Execd Output](/plugins/outputs/execd), and [Execd Processor](/plugins/processors/execd) Plugins without having to change the plugin code. +Follow the guidelines of how to integrate your plugin with the [Execd Go Shim](/plugins/common/shim) to easily compile it as a separate app and run it with the respective `execd` plugin. +Check out our [guidelines](/docs/EXTERNAL_PLUGINS.md#external-plugin-guidelines) on how to build and set up your external plugins to run with `execd`. #### Security Vulnerability Reporting InfluxData takes security and our users' trust very seriously. If you believe you have found a security issue in any of our diff --git a/README.md b/README.md index 5180d0d82..d0d67cb19 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ Telegraf is plugin-driven and has the concept of 4 distinct plugin types: New plugins are designed to be easy to contribute, pull requests are welcomed and we work to incorporate as many pull requests as possible. +If none of the internal plugins fit your needs, you could have a look at the +[list of external plugins](EXTERNAL_PLUGINS.md). ## Try in Browser :rocket: @@ -29,7 +31,7 @@ There are many ways to contribute: - [Review code and feature proposals](https://github.com/influxdata/telegraf/pulls) - Answer questions and discuss here on github and on the [Community Site](https://community.influxdata.com/) - [Contribute plugins](CONTRIBUTING.md) -- [Contribute external plugins](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/execd/shim) *(experimental)* +- [Contribute external plugins](docs/EXTERNAL_PLUGINS.md) ## Minimum Requirements diff --git a/config/README.md b/config/README.md new file mode 120000 index 000000000..5455122d9 --- /dev/null +++ b/config/README.md @@ -0,0 +1 @@ +../docs/CONFIGURATION.md \ No newline at end of file diff --git a/docs/developers/README.md b/docs/developers/README.md new file mode 120000 index 000000000..f939e75f2 --- /dev/null +++ b/docs/developers/README.md @@ -0,0 +1 @@ +../../CONTRIBUTING.md \ No newline at end of file