alerting-first-rule-lj: add install-datasources milestone - #482
Draft
BeverlyJaneJ wants to merge 16 commits into
Draft
alerting-first-rule-lj: add install-datasources milestone#482BeverlyJaneJ wants to merge 16 commits into
BeverlyJaneJ wants to merge 16 commits into
Conversation
Adds a Pathfinder-driven QuickPizza install step so learners don't need to install the tutorial data sources manually before starting the path. Rewires business-value -> install-datasources -> navigate-to-form, bumps downstream step numbers, and trims the install bullet from the cover.
BeverlyJaneJ
added
the
deploy-preview
BeverlyJaneJ
requested review from
Jayclifford345,
chri2547,
jdbaldry,
moxious,
robbymilo,
tacole02 and
tomglenn
as code owners
July 26, 2026 01:18
BeverlyJaneJ
marked this pull request as draft
July 26, 2026 01:19
|
💻 Deploy preview available (alerting-first-rule-lj: add install-datasources milestone): |
Aligns UI-element wording with current Grafana alerting docs (v11.1+), which describe this UI by the button label (+ New alert rule) and by named page sections rather than as a form. Wire-level IDs, folder names, section IDs, and dependency tokens are unchanged.
Rewrites the build-query milestone to build sum(increase(quickpizza_server_http_requests_total{status=~"5.."}[5m])) in Builder mode, with values pre-filled for the learner where the picker allows. Adds optional Sum and Explain sections. Updates set-condition threshold from 1 (req/s) to 0 (any errors), removing the 'traffic surge' framing. Adjusts configure-labels-evaluation and save-rule copy so it no longer references the removed service_name=quickpizza-public-api filter; the save-rule summary annotation now uses {{ $value }} since Sum aggregates labels away.
Breaks the dense opening paragraph into a short lede, a plain-language bullet list of what the learner will do, and a one-sentence payoff.
build-query: folds each section's lead markdown block into the interactive step's content so every numbered step has an action attached, preventing lonely numbered sentences when requirements gate the interactive block. navigate-to-form: pre-fills the alert rule name with 'QuickPizza server errors' via formfill, matching the query built in the next milestone.
Combines the intro markdown, why-it-matters sentence, and formfill instruction into a single interactive step, and removes the trailing summary markdown block. The section now renders as one numbered do-it step plus a next-milestone line.
- operator: use [data-testid='data-testid Select match operator'] and switch to Show me only (no skip) - explain toggle: use [data-testid='data-testid prometheus explain switch wrapper'] and move section to right after data source - value: reword to 'In the Select value box, enter 5..'
- Retitle sections to 'Choose when the alert fires' and 'Preview rule' - Highlight the Alert condition area via WHEN QUERY label - Highlight the Is above button scoped under alert-rule step-2 - Drop jargon (comparison operator, threshold), use plain language - Remove redundant markdown blocks and repetition - Fold wrap-up into the final noop
- Retitle to 'Create a folder and add labels'; fix section reference to 'Add folder and labels' - Replace jargon-heavy intro (service_name, Sum step) with plain routing summary - Section 1: single create-folder path (New folder button + noop for name+Create) - Section 2: Add labels button, concrete severity=critical example, brief transition - Drop reference-dump markdown table and orphan wrap-up
- Drop urgency/interval and alert-type reference tables - Retitle section 1 to 'Create an evaluation group' (single path) - Replace highlight steps with button click + noop for modal contents - Concrete 1m interval and 1m pending period recommendations - Convert trailing markdown wrap-up to noop transition
…nt, save-rule; add configure-notification milestone - Rework configure-handling: plain-language intro, auto-expand collapse, keep-defaults rationale, transition noop - Rework select-contact-point: single highlight step on the picker, concrete grafana-default-email recommendation, transition noop - Add configure-notification milestone: formfill Summary and Description with QuickPizza-specific values - Slim save-rule to just save-and-activate with doIt: false so the learner presses Save - Update manifest to insert configure-notification between select-contact-point and save-rule - Split combined contact-point + annotation bullet in journey outcomes and end-journey recap
…alue - save-rule: switch to highlight action with [data-testid='save-rule']; the actual Grafana button text is 'Save', so text-based match won't work - save-rule: convert trailing wrap-up markdown to a noop transition step - business-value: split the dense hook + list paragraph into a one-sentence hook and a scannable bullet list of what you build
…havior New section highlights #keep-firing-for-input, explains the setting as post-condition dampening to prevent flapping, and recommends leaving it at None for this rule. Intro markdown updated to name all three evaluation-behavior settings.
New learning path teaching how to write an alert rule with query language using PromQL. Mirrors alerting-first-rule-lj structure with 12 milestones: install-datasources, navigate-to-form, build-query, set-condition, configure-labels-evaluation, set-evaluation-behavior, configure-handling (with recovery threshold), select-contact-point, configure-notification (formatted percentage annotations), save-rule, business-value, end-journey.
Per-commit rationale for the entire changeset stacked on docs/lp-basic-alerting, covering install-datasources, query rework, UI-wording alignment with Grafana docs, jargon removal, selector fixes, notification milestone, Keep firing for gap-fill, and the new alerting-query-language-lj. Includes alignment matrix against the learning-hub docs in grafana/website PR #30466.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Pathfinder-driven QuickPizza install step so learners don't need to install the tutorial data sources manually before starting the path. Rewires business-value -> install-datasources -> navigate-to-form, bumps downstream step numbers, and trims the install bullet from the cover.