influxdata / influxdata/docs-v2
Processor's 'order' parameter description doesn't match Telegraf source code
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
Quote from currently published doc:
> order: This is the order in which processors are executed. If this is not specified, then processor execution order will be random.
Quote from current [Telegraf master](https://github.com/influxdata/telegraf/blob/664d013acba3f3209e9e46ec5bb5f9e7c5f26bf4/docs/CONFIGURATION.md):
> order: The order in which the processor(s) are executed. starting with 1. If this is not specified then processor execution order will be the order in the config. Processors without "order" will take precedence over those with a defined order.
##### Relevant URLs
- https://docs.influxdata.com/telegraf/v1.26/configuration/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the published Telegraf configuration documentation at the relevant URL with Telegraf's docs/CONFIGURATION.md, which contains the current order description. Update the published wording to match the source, then verify that the processor order parameter documentation accurately describes execution order and precedence.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100