Skip to content

Add "Using grafana dashboards" path#54

Open
mccollam wants to merge 3 commits intomainfrom
using-grafana-dashboards
Open

Add "Using grafana dashboards" path#54
mccollam wants to merge 3 commits intomainfrom
using-grafana-dashboards

Conversation

@mccollam
Copy link
Member

Adds an intro to Grafana dashboards path to walk new users through the UI

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Ronald McCollam seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Collaborator

@moxious moxious left a comment

Choose a reason for hiding this comment

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

Just reviewing JSON -- I haven't tested this yet in-product. It's looking very good, comments are minor and easily addressed.

When you push again, please add some details:

  • Where can this guide be tested/which instance? (Will any be OK, like local OSS as well)?
  • When do you think this guide should be suggested? On which URLs/for whom

"reftarget": "a[data-testid='view-weather']",
"content": "We'll use the Weather Demo dashboard to explore Grafana. Click \"Go to dashboards\" in the \"Weather Demo\" section.\n\n[FIXME] Verify that the dashboard is available before letting them complete this step",
"requirements": [
"has-dashboard-named:Overview [Celsius]"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Now I'll admit this is a detail I don't know for sure; but notice how your first block uses the exists-reftarget requirement, but this one doesn't. Most other blocks are missing exists-reftarget. It might be redundant because pathfinder might automatically insert exists-reftarget (I can't remember this detail) but best practice would be to include the exists-reftarget requirement, to say that you want to check it exists before suggesting people do this thing.

]
},
{
"type": "section",
Copy link
Collaborator

Choose a reason for hiding this comment

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

consider adding a section-level requirement. I'm not commenting this on your first section because you can start that from wherever; but you might consider e.g. on-page:/dashboards

That might not be the right one, but basically the thinking here is "make it hard for the users to screw up your guide by getting distracted and navigating elsewhere

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think it matters here but I will add it elsewhere where relevant

]
},
{
"type": "section",
Copy link
Collaborator

Choose a reason for hiding this comment

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

best practice suggested by our docs friends:

"Always include 'What you will learn' before each section, OR 'What you have learned' after each section."

(Easily done with a line or two in a markdown block)

@mccollam mccollam requested a review from moxious January 15, 2026 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments