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: update alert list visualization #87815

Merged
merged 5 commits into from
May 22, 2024
Merged

Conversation

mdcruz
Copy link
Contributor

@mdcruz mdcruz commented May 14, 2024

What is this feature?

Updates to the alert list visualization docs to include:

  • how to configure an alert list visualization (video TBA)
  • rearranging sections to match other visualization types

NOTE: Do not backport panel options shared file link to versions 10.3 and 10.4.

Why do we need this feature?

To explain to our users how to configure an alert list visualization easily and when to use it.

Who is this feature for?

Grafana OSS and Cloud users

Fixes #

Special notes for your reviewer:

Please check that:

  • It works as expected from a user's perspective.
  • If this is a pre-GA feature, it is behind a feature toggle.
  • The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

@mdcruz mdcruz requested a review from imatwawana as a code owner May 14, 2024 13:40
@grafana-delivery-bot grafana-delivery-bot bot added this to the 11.1.x milestone May 14, 2024
@mdcruz mdcruz added the no-changelog Skip including change in changelog/release notes label May 14, 2024
Copy link
Collaborator

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

Great update! I've made some structural and wording suggestions.

@imatwawana imatwawana added backport v10.3.x Mark PR for automatic backport to v10.3.x backport v10.4.x backport v11.0.x Mark PR for automatic backport to v11.0.x labels May 14, 2024
Copy link
Contributor

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

2 similar comments
Copy link
Contributor

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

Copy link
Contributor

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

mdcruz and others added 2 commits May 14, 2024 17:47
Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
Copy link
Collaborator

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

LGTM (pending addition of video)!

@mdcruz
Copy link
Contributor Author

mdcruz commented May 20, 2024

LGTM (pending addition of video)!

@imatwawana I've added the video now, but the video is set to go live on the 22nd May :)

@mdcruz
Copy link
Contributor Author

mdcruz commented May 22, 2024

@imatwawana All ready to be merged. Video is now live :)

@imatwawana imatwawana merged commit 2855675 into main May 22, 2024
11 checks passed
@imatwawana imatwawana deleted the update-alert-list-visualization branch May 22, 2024 13:33
Copy link
Contributor

The backport to v10.3.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-87815-to-v10.3.x origin/v10.3.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 285567573e587360e3e6009029f80a26c1bc3d24

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-87815-to-v10.3.x
# Create the PR body template
PR_BODY=$(gh pr view 87815 --json body --template 'Backport 285567573e587360e3e6009029f80a26c1bc3d24 from #87815{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[v10.3.x] docs: update alert list visualization' --body-file - --label 'type/docs' --label 'no-changelog' --label 'backport' --base v10.3.x --milestone 10.3.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-87815-to-v10.3.x

# Create a pull request where the `base` branch is `v10.3.x` and the `compare`/`head` branch is `backport-87815-to-v10.3.x`.

# Remove the local backport branch
git switch main
git branch -D backport-87815-to-v10.3.x

@grafana-delivery-bot grafana-delivery-bot bot added the backport-failed Failed to generate backport PR. Please resolve conflicts and create one manually. label May 22, 2024
grafana-delivery-bot bot pushed a commit that referenced this pull request May 22, 2024
* docs: update alert list visualization

* Apply suggestions from code review

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>

* fix: linting errors

* docs: add youtube video

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit 2855675)
grafana-delivery-bot bot pushed a commit that referenced this pull request May 22, 2024
* docs: update alert list visualization

* Apply suggestions from code review

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>

* fix: linting errors

* docs: add youtube video

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit 2855675)
imatwawana pushed a commit that referenced this pull request May 22, 2024
docs: update alert list visualization (#87815)

* docs: update alert list visualization

* Apply suggestions from code review

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>

* fix: linting errors

* docs: add youtube video

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit 2855675)

Co-authored-by: Marie Cruz <mdcruz@users.noreply.github.com>
imatwawana pushed a commit that referenced this pull request May 22, 2024
docs: update alert list visualization (#87815)

* docs: update alert list visualization

* Apply suggestions from code review

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>

* fix: linting errors

* docs: add youtube video

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit 2855675)

Co-authored-by: Marie Cruz <mdcruz@users.noreply.github.com>
imatwawana pushed a commit that referenced this pull request May 22, 2024
* docs: update alert list visualization

* Apply suggestions from code review

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>

* fix: linting errors

* docs: add youtube video

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit 2855675)
imatwawana added a commit that referenced this pull request May 22, 2024
docs: update alert list visualization (#87815)

* docs: update alert list visualization

* Apply suggestions from code review

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>

* fix: linting errors

* docs: add youtube video

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit 2855675)

Co-authored-by: Marie Cruz <mdcruz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport v10.3.x Mark PR for automatic backport to v10.3.x backport v10.4.x backport v11.0.x Mark PR for automatic backport to v11.0.x backport-failed Failed to generate backport PR. Please resolve conflicts and create one manually. no-changelog Skip including change in changelog/release notes type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants