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 dashboard list visualization #87494

Merged
merged 6 commits into from May 21, 2024

Conversation

mdcruz
Copy link
Contributor

@mdcruz mdcruz commented May 8, 2024

What is this feature?

Updates to the dashboard list visualization docs to include:

  • how to configure a dashboard list visualization (video TBA)
  • rearranging sections to match other visualization types

Also adding sections in text visualization and adding panel options shared file to flame graph
NOTE: Don't backport the Panel options shared file changes to versions 10.4 and 10.3

Why do we need this feature?

To explain to our users how to configure a dashboard list visualization easily and when to use it.

Who is this feature for?

Grafana OSS and Cloud users

Which issue(s) does this PR fix?:

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 8, 2024 09:24
@mdcruz mdcruz added the no-changelog Skip including change in changelog/release notes label May 8, 2024
@grafana-delivery-bot grafana-delivery-bot bot added this to the 11.1.x milestone May 8, 2024
@mdcruz mdcruz force-pushed the update-dashboard-list-visualization branch from dfa82ed to 88553ea Compare May 8, 2024 09:26
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.

This looks great! I've made some wording suggestions to update the original language.

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
@imatwawana imatwawana added backport v10.2.x 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 and removed backport v10.2.x labels May 13, 2024
Copy link
Contributor

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

3 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.

Copy link
Contributor

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

@mdcruz
Copy link
Contributor Author

mdcruz commented May 13, 2024

@imatwawana We've changed the YouTube published date to next week, the 20th of May because there'll be lots of videos published this week regarding G11. This PR can only be merged on or after the 20th. :)

@imatwawana imatwawana merged commit fa319f3 into main May 21, 2024
11 checks passed
@imatwawana imatwawana deleted the update-dashboard-list-visualization branch May 21, 2024 18:04
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-87494-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 fa319f36fb8c86b00e948a8feca4c929ee1b45fc

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-87494-to-v10.3.x
# Create the PR body template
PR_BODY=$(gh pr view 87494 --json body --template 'Backport fa319f36fb8c86b00e948a8feca4c929ee1b45fc from #87494{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[v10.3.x] docs: update dashboard 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-87494-to-v10.3.x

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

# Remove the local backport branch
git switch main
git branch -D backport-87494-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 21, 2024
Copy link
Contributor

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

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

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

# Remove the local backport branch
git switch main
git branch -D backport-87494-to-v10.4.x

grafana-delivery-bot bot pushed a commit that referenced this pull request May 21, 2024
* docs: update dashboard list visualization

* docs: add youtube video

* Apply suggestions from code review

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

* Ran prettier

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
(cherry picked from commit fa319f3)
imatwawana pushed a commit that referenced this pull request May 21, 2024
docs: update dashboard list visualization (#87494)

* docs: update dashboard list visualization

* docs: add youtube video

* Apply suggestions from code review

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

* Ran prettier

---------

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

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

* docs: add youtube video

* Apply suggestions from code review

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

* Ran prettier

---------

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

* docs: add youtube video

* Apply suggestions from code review

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

* Ran prettier

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
(cherry picked from commit fa319f3)
imatwawana added a commit that referenced this pull request May 21, 2024
docs: update dashboard list visualization (#87494)

* docs: update dashboard list visualization

* docs: add youtube video

* Apply suggestions from code review

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

* Ran prettier

---------

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

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

* docs: update dashboard list visualization

* docs: add youtube video

* Apply suggestions from code review

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

* Ran prettier

---------

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

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