influxdata / influxdata/telegraf
CLI documentation
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 17.8k
- Forks
- 5.8k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 161
Description
### Use Case
It would be nice to have a human readable documentation about the CLI command and all possible sub-commands + options in the repository. Just like we have a README.md for every plugin.
### Expected behavior
Having a readme file in `cmd/telegraf/` directory which not only says to run `telegraf help` but also has the actual documentation of the various commands and flags.
### Actual behavior
Currently one needs to download/install telegraf binary and run its `help` command in order to read about a certain functionality.
### Additional info
Could be autogenerated by running the `make docs` command. The CI could then warn the contributor if the repo is dirty and need to push the updated docs.
Contributor guide
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
Start with the existing CLI help output by running the Telegraf binary's help command, then inspect cmd/telegraf/ and the make docs command. Document all CLI commands, subcommands, and options in a README under cmd/telegraf/. If generation is used, the completed work should also support checking whether generated documentation leaves the repository dirty.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100