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.

Sign up for GitHub

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

Jump to bottom

docs: document telegraf commands and flags #9635

Merged
merged 2 commits into from
Sep 20, 2021
Merged

docs: document telegraf commands and flags #9635

merged 2 commits into from
Sep 20, 2021

Conversation

sjwang90
Copy link
Contributor

No description provided.

@sjwang90 sjwang90 added the docs Issues related to Telegraf documentation and configuration descriptions label Aug 17, 2021
@sjwang90 sjwang90 mentioned this pull request Aug 17, 2021
Closed
helenosheaa
helenosheaa suggested changes Aug 19, 2021
View reviewed changes
Copy link
Member

@helenosheaa helenosheaa left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have this information located here. There's also some bits in the CONFIGURATION.md maybe we could link to the existing documentation in there instead?

@sjwang90
Copy link
Contributor Author

@helenosheaa I essentially copied the flag and command information from usage.go. That file isn't necessarily documentation to so I thought it should live in its own docs page (useful for when users are searching).

This should be created in docs.influxdata.com anyways so lmk what you think. Linking to the configuration.MD is a good call either way.

@helenosheaa
Copy link
Member

Ok that makes sense. How about keep the commands and flags in this file and then link to it in the CONFIGURATION.md next to the Generating a Configuration File section where we already have some examples to help with discoverability.

@sjwang90 sjwang90 requested a review from helenosheaa September 1, 2021 21:25
helenosheaa
helenosheaa approved these changes Sep 9, 2021
View reviewed changes
Copy link
Member

@helenosheaa helenosheaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@sjwang90 sjwang90 mentioned this pull request Sep 15, 2021
Closed
@reimda reimda merged commit 9ecf604 into master Sep 20, 2021
@reimda reimda deleted the docs-commandsflags branch September 20, 2021 15:13
reimda pushed a commit that referenced this pull request Oct 6, 2021
@sjwang90 @reimda
docs: document telegraf commands and flags (#9635)
0ed38c7 
(cherry picked from commit 9ecf604)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@helenosheaa helenosheaa helenosheaa approved these changes

Assignees
No one assigned
Labels
docs Issues related to Telegraf documentation and configuration descriptions
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sjwang90 @helenosheaa @reimda