From 3e9f191142e8b1799fef52f3fe8cfee95b0b136b Mon Sep 17 00:00:00 2001 From: Samantha Wang <32681364+sjwang90@users.noreply.github.com> Date: Fri, 7 May 2021 12:26:11 -0700 Subject: [PATCH] Redirect former wiki links (#9183) * fix docs links * redirect links * redirect links * redirect links * redirect links --- docs/AGGREGATORS.md | 8 ++++---- docs/INPUTS.md | 8 ++++---- docs/OUTPUTS.md | 8 ++++---- docs/PROCESSORS.md | 8 ++++---- docs/maintainers/PULL_REQUESTS.md | 4 ++-- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/AGGREGATORS.md b/docs/AGGREGATORS.md index a5930a3e0df6d..0edf467837457 100644 --- a/docs/AGGREGATORS.md +++ b/docs/AGGREGATORS.md @@ -11,13 +11,13 @@ This section is for developers who want to create a new aggregator plugin. `github.com/influxdata/telegraf/plugins/aggregators/all/all.go` file. - The `SampleConfig` function should return valid toml that describes how the plugin can be configured. This is included in `telegraf config`. Please - consult the [SampleConfig][] page for the latest style guidelines. + consult the [Sample Config][] page for the latest style guidelines. * The `Description` function should say in one line what this aggregator does. * The Aggregator plugin will need to keep caches of metrics that have passed 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][]. +- Follow the recommended [Code Style][]. ### Aggregator Plugin Example @@ -128,5 +128,5 @@ 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 +[Sample Config]: https://github.com/influxdata/telegraf/blob/master/docs/developers/SAMPLE_CONFIG.md +[Code Style]: https://github.com/influxdata/telegraf/blob/master/docs/developers/CODE_STYLE.md diff --git a/docs/INPUTS.md b/docs/INPUTS.md index 6a10cf949829c..679c24e287604 100644 --- a/docs/INPUTS.md +++ b/docs/INPUTS.md @@ -17,10 +17,10 @@ and submit new inputs. `github.com/influxdata/telegraf/plugins/inputs/all/all.go` file. - The `SampleConfig` function should return valid toml that describes how the plugin can be configured. This is included in `telegraf config`. Please - consult the [SampleConfig][] page for the latest style + consult the [Sample Config][] page for the latest style guidelines. - The `Description` function should say in one line what this plugin does. -- Follow the recommended [CodeStyle][]. +- Follow the recommended [Code Style][]. Let's say you've written a plugin that emits metrics about processes on the current host. @@ -143,8 +143,8 @@ Check the [amqp_consumer][] for an example implementation. [amqp_consumer]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/amqp_consumer [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 +[Sample Config]: https://github.com/influxdata/telegraf/blob/master/docs/developers/SAMPLE_CONFIG.md +[Code Style]: https://github.com/influxdata/telegraf/blob/master/docs/developers/CODE_STYLE.md [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 1a27ca515f118..db8383126ad68 100644 --- a/docs/OUTPUTS.md +++ b/docs/OUTPUTS.md @@ -13,9 +13,9 @@ similar constructs. `github.com/influxdata/telegraf/plugins/outputs/all/all.go` file. - The `SampleConfig` function should return valid toml that describes how the plugin can be configured. This is included in `telegraf config`. Please - consult the [SampleConfig][] page for the latest style guidelines. + consult the [Sample Config][] page for the latest style guidelines. - The `Description` function should say in one line what this output does. -- Follow the recommended [CodeStyle][]. +- Follow the recommended [Code Style][]. ### Output Plugin Example @@ -115,6 +115,6 @@ or investigate other reasons why the writes might be taking longer than expected [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 +[Sample Config]: https://github.com/influxdata/telegraf/blob/master/docs/developers/SAMPLE_CONFIG.md +[Code Style]: https://github.com/influxdata/telegraf/blob/master/docs/developers/CODE_STYLE.md [telegraf.Output]: https://godoc.org/github.com/influxdata/telegraf#Output diff --git a/docs/PROCESSORS.md b/docs/PROCESSORS.md index 25566fe323fd2..30b2c643de8f6 100644 --- a/docs/PROCESSORS.md +++ b/docs/PROCESSORS.md @@ -14,9 +14,9 @@ This section is for developers who want to create a new processor plugin. config`. - The `SampleConfig` function should return valid toml that describes how the plugin can be configured. This is included in `telegraf config`. Please - consult the [SampleConfig][] page for the latest style guidelines. + consult the [Sample Config][] page for the latest style guidelines. * The `Description` function should say in one line what this processor does. -- Follow the recommended [CodeStyle][]. +- Follow the recommended [Code Style][]. ### Processor Plugin Example @@ -160,7 +160,7 @@ func init() { } ``` -[SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig -[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle +[Sample Config]: https://github.com/influxdata/telegraf/blob/master/docs/developers/SAMPLE_CONFIG.md +[Code Style]: https://github.com/influxdata/telegraf/blob/master/docs/developers/CODE_STYLE.md [telegraf.Processor]: https://godoc.org/github.com/influxdata/telegraf#Processor [telegraf.StreamingProcessor]: https://godoc.org/github.com/influxdata/telegraf#StreamingProcessor diff --git a/docs/maintainers/PULL_REQUESTS.md b/docs/maintainers/PULL_REQUESTS.md index c41e4dd138788..e7b26c10fca69 100644 --- a/docs/maintainers/PULL_REQUESTS.md +++ b/docs/maintainers/PULL_REQUESTS.md @@ -19,7 +19,7 @@ contributor to merge or rebase. ## Review -[Review the pull request](Review). +[Review the pull request](docs/developers/REVIEWS.md). ## Merge @@ -53,7 +53,7 @@ message. If applicable mention the plugin in the message. ## After Merge -[Update the Changelog](Changelog). +[Update the Changelog](https://github.com/influxdata/telegraf/blob/master/docs/maintainers/CHANGELOG.md). If required, backport the patch and the changelog update to the current release branch. Usually this can be done by cherry picking the commits: