From 72aa771891c7e09be08295c51294771d5b5509f1 Mon Sep 17 00:00:00 2001 From: Samantha Wang Date: Tue, 28 Jul 2020 12:13:26 -0700 Subject: [PATCH] edit docs --- CONTRIBUTING.md | 2 +- docs/EXTERNAL_PLUGINS.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11c30d785..0fcca4306 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Input, output, and processor plugins written for internal Telegraf can be run as 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 some 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 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/docs/EXTERNAL_PLUGINS.md b/docs/EXTERNAL_PLUGINS.md index ca13e8563..28ea924bb 100644 --- a/docs/EXTERNAL_PLUGINS.md +++ b/docs/EXTERNAL_PLUGINS.md @@ -15,7 +15,7 @@ The guidelines of writing external plugins would follow those for our general [i Please reference the documentation on how to create these plugins written in Go. -## Execd Go Shim +#### Execd Go Shim For Go plugins, there is a [Execd Go Shim](plugins/common/shim) that will make it trivial to extract an internal input, processor, or output plugin from the main Telegraf repo out to a stand-alone repo. This shim This allows anyone to build and run it as a separate app using one of the `execd`plugins: - [inputs.execd](/plugins/inputs/execd) - [processors.execd](/plugins/processors/execd)