Conversation
|
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. |
moxious
left a comment
There was a problem hiding this comment.
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]" |
There was a problem hiding this comment.
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", |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
I don't think it matters here but I will add it elsewhere where relevant
| ] | ||
| }, | ||
| { | ||
| "type": "section", |
There was a problem hiding this comment.
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)
Adds an intro to Grafana dashboards path to walk new users through the UI