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

Clarify blackbox exporter documentation #5719

Merged
merged 2 commits into from
Nov 7, 2023
Merged

Clarify blackbox exporter documentation #5719

merged 2 commits into from
Nov 7, 2023

Conversation

marctc
Copy link
Contributor

@marctc marctc commented Nov 6, 2023 •
edited
Loading

PR Description

  • Documentation for blackbox exporter contained some broken config examples. This PR fixes
    them and clarifies some areas.
  • Added validation for either specifying config file or blackbox module config content.

Which issue(s) this PR fixes

Fixes #5007

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@marctc marctc requested review from a team and clayton-cornell as code owners November 6, 2023 16:52
tpaschalis
tpaschalis approved these changes Nov 7, 2023
View reviewed changes
Copy link
Member

@tpaschalis tpaschalis left a comment

Choose a reason for hiding this comment

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

LGTM!

clayton-cornell
clayton-cornell approved these changes Nov 7, 2023
View reviewed changes
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

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

Docs are good as-is

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Nov 7, 2023
@marctc marctc merged commit 49f1bd1 into main Nov 7, 2023
11 checks passed
@marctc marctc deleted the blackbox_docs_feedback branch November 7, 2023 17:28
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@tpaschalis tpaschalis tpaschalis approved these changes

@clayton-cornell clayton-cornell clayton-cornell approved these changes

Assignees
No one assigned
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

prometheus.exporter.blackbox: issues with documentation and examples
3 participants
@marctc @tpaschalis @clayton-cornell