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.

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

[Docs] prometheus.exporter.[blackbox, snmp] misc. fixes #5187

Merged

Conversation

spartan0x117
Copy link
Contributor

@spartan0x117 spartan0x117 commented Sep 13, 2023

PR Description

(Hopefully) alleviates some confusion in the docs for prometheus.exporter.blackbox and prometheus.exporter.snmp derive the name attribute from the label of the block and is not a required argument to the block.

Which issue(s) this PR fixes

Related to #5163

Notes to the Reviewer

PR Checklist

  • Documentation added

Co-authored-by: Clayton Cornell <[email protected]>
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.

LGTM

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Sep 13, 2023
@clayton-cornell
Copy link
Contributor

@spartan0x117 Can we backport this to v0.34, v0.35, and v0.36 docs or is it something for next only?

@spartan0x117
Copy link
Contributor Author

@clayton-cornell I hadn't thought about the backporting when batching these changes. The blackbox and snmp changes should be fine for all of those, but the cloudwatch exporter was added in v0.35.

Should I remove the cloudwatch changes from this PR and make it a separate one?

@clayton-cornell
Copy link
Contributor

@spartan0x117 We can remove the cloudwatch and do it in a separate PR... or backport to all anyway. If we backport to v0.34 the backport will fail because it can't cherrypick into a file that doesn't exist. We could checkout the faield backprot to v0.34, delete cloudwatch, and then push it.

Either way the result will be the same. Cleanest is to strip out cloudwatch into its own PR.

@spartan0x117 spartan0x117 changed the title [Docs] prometheus.exporter.[blackbox, cloudwatch, snmp] misc. fixes [Docs] prometheus.exporter.[blackbox, snmp] misc. fixes Sep 14, 2023
@spartan0x117
Copy link
Contributor Author

Makes sense! I backed out the cloudwatch changes and moved them to this PR: #5195

@clayton-cornell clayton-cornell merged commit 31999c8 into main Sep 14, 2023
9 checks passed
@clayton-cornell clayton-cornell deleted the spartan0x117/cloudwatch-blackbox-snmp-docs-fixes branch September 14, 2023 19:27
@grafanabot
Copy link
Contributor

The backport to release-v0.34 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-5187-to-release-v0.34 origin/release-v0.34
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 31999c8224d3d6cbf848fa441e5862a03abd5837
# Push it to GitHub
git push --set-upstream origin backport-5187-to-release-v0.34
git switch main
# Remove the local backport branch
git branch -D backport-5187-to-release-v0.34

Then, create a pull request where the base branch is release-v0.34 and the compare/head branch is backport-5187-to-release-v0.34.

@grafanabot
Copy link
Contributor

The backport to release-v0.35 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-5187-to-release-v0.35 origin/release-v0.35
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 31999c8224d3d6cbf848fa441e5862a03abd5837
# Push it to GitHub
git push --set-upstream origin backport-5187-to-release-v0.35
git switch main
# Remove the local backport branch
git branch -D backport-5187-to-release-v0.35

Then, create a pull request where the base branch is release-v0.35 and the compare/head branch is backport-5187-to-release-v0.35.

@grafanabot
Copy link
Contributor

The backport to release-v0.36 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-5187-to-release-v0.36 origin/release-v0.36
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 31999c8224d3d6cbf848fa441e5862a03abd5837
# Push it to GitHub
git push --set-upstream origin backport-5187-to-release-v0.36
git switch main
# Remove the local backport branch
git branch -D backport-5187-to-release-v0.36

Then, create a pull request where the base branch is release-v0.36 and the compare/head branch is backport-5187-to-release-v0.36.

clayton-cornell pushed a commit that referenced this pull request Sep 14, 2023
* Remove name from block arguments and add a sentence that a label is required

* Fix blocks header levels and move 'period and length' section

* Add suggested change

Co-authored-by: Clayton Cornell <[email protected]>

* Revert "Fix blocks header levels and move 'period and length' section"

This reverts commit 93a593a.

---------

Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 31999c8)
clayton-cornell pushed a commit that referenced this pull request Sep 14, 2023
* Remove name from block arguments and add a sentence that a label is required

* Fix blocks header levels and move 'period and length' section

* Add suggested change

Co-authored-by: Clayton Cornell <[email protected]>

* Revert "Fix blocks header levels and move 'period and length' section"

This reverts commit 93a593a.

---------

Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 31999c8)
clayton-cornell pushed a commit that referenced this pull request Sep 14, 2023
* Remove name from block arguments and add a sentence that a label is required

* Fix blocks header levels and move 'period and length' section

* Add suggested change

Co-authored-by: Clayton Cornell <[email protected]>

* Revert "Fix blocks header levels and move 'period and length' section"

This reverts commit 93a593a.

---------

Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 31999c8)
clayton-cornell added a commit that referenced this pull request Sep 14, 2023
* Remove name from block arguments and add a sentence that a label is required

* Fix blocks header levels and move 'period and length' section

* Add suggested change

Co-authored-by: Clayton Cornell <[email protected]>

* Revert "Fix blocks header levels and move 'period and length' section"

This reverts commit 93a593a.

---------

Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 31999c8)

Co-authored-by: Mischa Thompson <[email protected]>
clayton-cornell added a commit that referenced this pull request Sep 14, 2023
* Remove name from block arguments and add a sentence that a label is required

* Fix blocks header levels and move 'period and length' section

* Add suggested change

Co-authored-by: Clayton Cornell <[email protected]>

* Revert "Fix blocks header levels and move 'period and length' section"

This reverts commit 93a593a.

---------

Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 31999c8)

Co-authored-by: Mischa Thompson <[email protected]>
clayton-cornell added a commit that referenced this pull request Sep 14, 2023
* Remove name from block arguments and add a sentence that a label is required

* Fix blocks header levels and move 'period and length' section

* Add suggested change

Co-authored-by: Clayton Cornell <[email protected]>

* Revert "Fix blocks header levels and move 'period and length' section"

This reverts commit 93a593a.

---------

Co-authored-by: Clayton Cornell <[email protected]>
(cherry picked from commit 31999c8)

Co-authored-by: Mischa Thompson <[email protected]>
@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 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport release-v0.34 backport release-v0.35 backport release-v0.36 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
Development

Successfully merging this pull request may close these issues.

3 participants