CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation (#9457)

This commit is contained in:
Thomas Casteleyn 2021-07-06 23:20:53 +02:00 committed by GitHub
parent 285cae2b64
commit c56a652b4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -14,11 +14,11 @@
1. Open a new [pull request][]. 1. Open a new [pull request][].
#### Contributing an External Plugin *(new)* #### 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.
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. 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`. 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 #### 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 InfluxData takes security and our users' trust very seriously. If you believe you have found a security issue in any of our

4
README.md
View File

@ -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 New plugins are designed to be easy to contribute, pull requests are welcomed
and we work to incorporate as many pull requests as possible. 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: ## 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) - [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/) - Answer questions and discuss here on github and on the [Community Site](https://community.influxdata.com/)
- [Contribute plugins](CONTRIBUTING.md) - [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 ## Minimum Requirements

1
config/README.md Symbolic link
View File

@ -0,0 +1 @@
../docs/CONFIGURATION.md

1
docs/developers/README.md Symbolic link
View File

@ -0,0 +1 @@
../../CONTRIBUTING.md