Skip to content

Improve documentation#9457

Merged
helenosheaa merged 3 commits intoinfluxdata:masterfrom
Super-Visions:feature/doc-symlinks
Jul 6, 2021
Merged

Improve documentation#9457
helenosheaa merged 3 commits intoinfluxdata:masterfrom
Super-Visions:feature/doc-symlinks

Conversation

@Hipska
Copy link
Copy Markdown
Contributor

@Hipska Hipska commented Jun 30, 2021

This includes multiple improvements:

  • Add README symlinks on locations where you might expect some documentation without the need to update on multiple places.
  • Add proper links to contribution of external plugins.
  • Link to the list of known external plugins from the main README file.

Required for all PRs:

  • Updated associated README.md.

@Hipska Hipska requested a review from sjwang90 June 30, 2021 20:25
@telegraf-tiger telegraf-tiger bot added the feat Improvement on an existing feature such as adding a new setting/mode to an existing plugin label Jun 30, 2021
@Hipska Hipska added the docs Issues related to Telegraf documentation and configuration descriptions label Jun 30, 2021
@Hipska Hipska requested a review from popey July 1, 2021 07:24
sjwang90
sjwang90 approved these changes Jul 1, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@sjwang90 sjwang90 left a comment

Choose a reason for hiding this comment

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

Nice! Looks great.

srebhan
srebhan approved these changes Jul 5, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@srebhan srebhan left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@srebhan srebhan added the ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review. label Jul 5, 2021
@srebhan srebhan self-assigned this Jul 5, 2021
popey
popey approved these changes Jul 6, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@popey popey left a comment

Choose a reason for hiding this comment

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

Looks great to me! Thank you!

@helenosheaa helenosheaa merged commit c56a652 into influxdata:master Jul 6, 2021
reimda pushed a commit that referenced this pull request Jul 7, 2021
@Hipska @reimda
Improve documentation (#9457)
f128f33 
(cherry picked from commit c56a652)
@Hipska Hipska deleted the feature/doc-symlinks branch October 14, 2021 07:41
@Hipska Hipska mentioned this pull request Oct 14, 2021
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@srebhan srebhan srebhan approved these changes

+2 more reviewers

@popey popey popey approved these changes

@sjwang90 sjwang90 sjwang90 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@srebhan srebhan

Labels

docs Issues related to Telegraf documentation and configuration descriptions feat Improvement on an existing feature such as adding a new setting/mode to an existing plugin ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@Hipska @popey @sjwang90 @srebhan @helenosheaa