Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI documentation #15871

Open
Hipska opened this issue Sep 11, 2024 · 1 comment
Open

CLI documentation #15871

Hipska opened this issue Sep 11, 2024 · 1 comment
Labels
feature request Requests for new plugin and for new features to existing plugins help wanted Request for community participation, code, contribution size/m 2-4 day effort

Comments

@Hipska
Copy link
Contributor

Hipska commented Sep 11, 2024

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.

@Hipska Hipska added the feature request Requests for new plugin and for new features to existing plugins label Sep 11, 2024
@srebhan
Copy link
Member

srebhan commented Sep 12, 2024

Next steps: Implement a command to generate the readme from the help probably by running the binary or by cleverly extracting data from the command settings...

@srebhan srebhan added help wanted Request for community participation, code, contribution size/m 2-4 day effort labels Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Requests for new plugin and for new features to existing plugins help wanted Request for community participation, code, contribution size/m 2-4 day effort
Projects
None yet
Development

No branches or pull requests

2 participants