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: fix query example for labels and values #13213

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Conversation

ivanahuckova
Copy link
Member

The query param example for fetching labels and label values was incorrect. This PR fixes it.

@ivanahuckova ivanahuckova requested a review from a team as a code owner June 13, 2024 14:47
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jun 13, 2024
@ivanahuckova ivanahuckova changed the title Docs: Fix query example for labels and values docs: fix query example for labels and values Jun 13, 2024
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[Docs team] LGTM

@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

1 similar comment
@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

@JStickler JStickler merged commit 5df56a4 into main Jun 13, 2024
63 checks passed
@JStickler JStickler deleted the ivanahuckova-patch-2 branch June 13, 2024 15:28
@grafanabot
Copy link
Collaborator

The backport to release-2.9.x 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-13213-to-release-2.9.x origin/release-2.9.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 5df56a4e0da96d41b192c7289a24d452b221d76d

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-13213-to-release-2.9.x
# Create the PR body template
PR_BODY=$(gh pr view 13213 --json body --template 'Backport 5df56a4e0da96d41b192c7289a24d452b221d76d from #13213{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'chore: [release-2.9.x] docs: fix query example for labels and values' --body-file - --label 'size/XS' --label 'type/docs' --label 'backport' --base release-2.9.x --milestone release-2.9.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-13213-to-release-2.9.x

# Create a pull request where the `base` branch is `release-2.9.x` and the `compare`/`head` branch is `backport-13213-to-release-2.9.x`.

# Remove the local backport branch
git switch main
git branch -D backport-13213-to-release-2.9.x

@grafanabot
Copy link
Collaborator

The backport to release-3.0.x 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-13213-to-release-3.0.x origin/release-3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 5df56a4e0da96d41b192c7289a24d452b221d76d

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-13213-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 13213 --json body --template 'Backport 5df56a4e0da96d41b192c7289a24d452b221d76d from #13213{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'chore: [release-3.0.x] docs: fix query example for labels and values' --body-file - --label 'size/XS' --label 'type/docs' --label 'backport' --base release-3.0.x --milestone release-3.0.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-13213-to-release-3.0.x

# Create a pull request where the `base` branch is `release-3.0.x` and the `compare`/`head` branch is `backport-13213-to-release-3.0.x`.

# Remove the local backport branch
git switch main
git branch -D backport-13213-to-release-3.0.x

@JStickler
Copy link
Contributor

It doesn't look like this was documented in 2.9 or 3.0, so probably a new feature. Leaving this fixed in main and not backporting this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-2.9.x backport release-3.0.x backport-failed size/XS type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants