Skip to content

Conversation

Hipska
Copy link
Contributor

@Hipska Hipska commented Dec 20, 2022

  • Let the CI also enforce the new README section introduced by docs: add global configuration header #12107.
  • Update the include section with a more correct link and update this to the example input.
  • Add/update this section also to all plugins.

Required for all PRs

@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 Dec 20, 2022
@Hipska Hipska requested review from srebhan and powersj and removed request for srebhan December 20, 2022 14:43
@Hipska
Copy link
Contributor Author

Hipska commented Jan 9, 2023

@powersj did pull master and make docs and all seems to be clean. I don't get why the CI thinks it's not. 🤷

@Hipska Hipska requested a review from powersj January 9, 2023 09:52
@powersj
Copy link
Contributor

powersj commented Jan 9, 2023

@powersj did pull master and make docs and all seems to be clean. I don't get why the CI thinks it's not. shrug

heh so two things:

  1. Your master is behind. It doesn't include some of the new plugins.
  2. I assume you are doing this on a mac? I think the build flags are preventing you from updating the linux only plugins as the diff for me shows that is what makes up most of the missing changes:
diff --git a/plugins/inputs/conntrack/README.md b/plugins/inputs/conntrack/README.md
diff --git a/plugins/inputs/dpdk/README.md b/plugins/inputs/dpdk/README.md
diff --git a/plugins/inputs/hugepages/README.md b/plugins/inputs/hugepages/README.md
diff --git a/plugins/inputs/intel_dlb/README.md b/plugins/inputs/intel_dlb/README.md
diff --git a/plugins/inputs/intel_pmu/README.md b/plugins/inputs/intel_pmu/README.md
diff --git a/plugins/inputs/intel_powerstat/README.md b/plugins/inputs/intel_powerstat/README.md
diff --git a/plugins/inputs/iptables/README.md b/plugins/inputs/iptables/README.md
diff --git a/plugins/inputs/ipvs/README.md b/plugins/inputs/ipvs/README.md
diff --git a/plugins/inputs/kernel/README.md b/plugins/inputs/kernel/README.md
diff --git a/plugins/inputs/kernel_vmstat/README.md b/plugins/inputs/kernel_vmstat/README.md
diff --git a/plugins/inputs/linux_cpu/README.md b/plugins/inputs/linux_cpu/README.md
diff --git a/plugins/inputs/mdstat/README.md b/plugins/inputs/mdstat/README.md
diff --git a/plugins/inputs/ras/README.md b/plugins/inputs/ras/README.md
diff --git a/plugins/inputs/sensors/README.md b/plugins/inputs/sensors/README.md
diff --git a/plugins/inputs/slab/README.md b/plugins/inputs/slab/README.md
diff --git a/plugins/inputs/sysstat/README.md b/plugins/inputs/sysstat/README.md

@Hipska
Copy link
Contributor Author

Hipska commented Jan 9, 2023

I did merge this (my morning) with 6fb08bb which was the latest at that time. Strange it wouldn't update all plugin README's, those are not supposed to be platform dependant?

@Hipska
Copy link
Contributor Author

Hipska commented Jan 12, 2023

@powersj I added the updated docs for other GOOSs

@telegraf-tiger
Copy link
Contributor

@powersj
Copy link
Contributor

powersj commented Jan 12, 2023

Thanks!

@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 12, 2023
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.

Good job @Hipska! Looks good to me.

@srebhan srebhan merged commit 61523bd into influxdata:master Jan 12, 2023
@Hipska Hipska deleted the feat/tools/readme_linter/global_configuration_section branch January 12, 2023 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Development

Successfully merging this pull request may close these issues.

3 participants