influxdata/telegraf

CLI documentation

Open

#15,871 opened on Sep 11, 2024

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Go (4,161 forks)batch import
feature requesthelp wantedsize/m

Repository metrics

Stars
 (9,892 stars)
PR merge metrics
 (Avg merge 2d 12h) (136 merged PRs in 30d)

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

Research direction
Explore using Cobra's doc generation to auto generate CLI documentation from the help commands, then integrate into the Makefile with 'make docs' and add a CI check to ensure docs are up to date.
Tech stack
go
Domain
backendcli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoMakeGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85