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: Fix typos #14376

Merged
merged 3 commits into from
Jan 5, 2024
Merged

docs: Fix typos #14376

merged 3 commits into from
Jan 5, 2024

Conversation

deining
Copy link
Contributor

@deining deining commented Dec 3, 2023

This PR fixes a few typos I spotted in the project.

@srebhan
Copy link
Member

srebhan commented Dec 4, 2023

@deining can you please split this PR into fixes for READMEs(+sample-configs) & comments and a second PR that fixes error-messages and things in the code!? Please also double-check if the README changes reflect the actual code...

Background is the reason for #14379 where there is a typo in the field-name but we cannot change that without breaking current users of the plugins...

@srebhan srebhan self-assigned this Dec 4, 2023
@srebhan srebhan changed the title Fix typos docs: Fix typos Dec 4, 2023
@srebhan srebhan added docs Issues related to Telegraf documentation and configuration descriptions waiting for response waiting for response from contributor labels Dec 4, 2023
Hipska
Hipska suggested changes Dec 12, 2023
View reviewed changes
Copy link
Contributor

@Hipska Hipska left a comment

Choose a reason for hiding this comment

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

I have reviewed all the changes, there are a few, we need to be extra sure they don't break things. Also please make sure all tests of the CI pass.

plugins/inputs/bond/bond_test.go Outdated Show resolved Hide resolved
plugins/inputs/nginx_plus_api/nginx_plus_api_metrics_test.go Outdated Show resolved Hide resolved
@deining deining force-pushed the fix-typos branch 3 times, most recently from 38bd488 to 85ddfd8 Compare December 13, 2023 19:55
@deining deining requested a review from Hipska December 13, 2023 19:57
@deining deining force-pushed the fix-typos branch 2 times, most recently from 4d49a9c to 9ca7e63 Compare December 13, 2023 20:08
@srebhan
Copy link
Member

srebhan commented Dec 14, 2023 •
edited
Loading

@deining can you please run make docs on your machine to update all READMEs with the content of sample.conf files!?
Furthermore, please also fix this issue

plugins/outputs/elasticsearch/README.md:332: long line in paragraph

@telegraf-tiger telegraf-tiger bot removed the waiting for response waiting for response from contributor label Dec 14, 2023
Hipska
Hipska approved these changes Dec 14, 2023
View reviewed changes
Copy link
Contributor

@Hipska Hipska 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, just make sure to fix CI test results.

@Hipska Hipska self-assigned this Dec 14, 2023
@telegraf-tiger
Copy link
Contributor

Download PR build artifacts for linux_amd64.tar.gz, darwin_arm64.tar.gz, and windows_amd64.zip.
Downloads for additional architectures and packages are available below.

👍 This pull request doesn't change the Telegraf binary size

📦 Click here to get additional PR build artifacts

Artifact URLs

DEB RPM TAR GZ ZIP
amd64.deb aarch64.rpm darwin_amd64.tar.gz windows_amd64.zip
arm64.deb armel.rpm darwin_arm64.tar.gz windows_arm64.zip
armel.deb armv6hl.rpm freebsd_amd64.tar.gz windows_i386.zip
armhf.deb i386.rpm freebsd_armv7.tar.gz
i386.deb ppc64le.rpm freebsd_i386.tar.gz
mips.deb riscv64.rpm linux_amd64.tar.gz
mipsel.deb s390x.rpm linux_arm64.tar.gz
ppc64el.deb x86_64.rpm linux_armel.tar.gz
riscv64.deb linux_armhf.tar.gz
s390x.deb linux_i386.tar.gz
linux_mips.tar.gz
linux_mipsel.tar.gz
linux_ppc64le.tar.gz
linux_riscv64.tar.gz
linux_s390x.tar.gz

@deining
Copy link
Contributor Author

deining commented Dec 29, 2023

Looks good, just make sure to fix CI test results.

All checks are green now 😄

@deining deining requested a review from Hipska December 29, 2023 16:52
powersj
powersj approved these changes Jan 5, 2024
View reviewed changes
Copy link
Contributor

@powersj powersj left a comment

Choose a reason for hiding this comment

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

Thank you for doing this.

I would next time prefer to see these split, as @srebhan had originally requested into one PR for Go code items and one for non-Go code items.

@powersj powersj 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 Jan 5, 2024
srebhan
srebhan approved these changes Jan 5, 2024
View reviewed changes
Copy link
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.

Thanks for your work @deining!

@srebhan srebhan merged commit 5f5a56e into influxdata:master Jan 5, 2024
4 checks passed
@github-actions github-actions bot added this to the v1.29.2 milestone Jan 5, 2024
@deining deining deleted the fix-typos branch January 6, 2024 08:45
powersj pushed a commit that referenced this pull request Jan 8, 2024
@deining @powersj
docs: Fix typos (#14376)
59f595e 
(cherry picked from commit 5f5a56e)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@powersj powersj powersj approved these changes

@srebhan srebhan srebhan approved these changes

@Hipska Hipska Awaiting requested review from Hipska

Assignees

@srebhan srebhan

Labels
docs Issues related to Telegraf documentation and configuration descriptions 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
v1.29.2
Development

Successfully merging this pull request may close these issues.
4 participants
@deining @srebhan @Hipska @powersj