docs: dashboard preset authoring guide + stat-panel staleness fix - #2
Merged
Merged
Conversation
Add a "Building & editing dashboards" section covering the preset JSON string, the 24-col grid layout, sections with children[], and the currentRevision optimistic-concurrency update contract. Document the two opaque-400 validation rules learned the hard way: stat widgets only validate as flat top-level layout entries (never inside a section's children), and section color is limited to gray/purple/teal. Add the stat-panel "No Results" trap for lagging (polled-integration) metrics and the last_over_time([30m]) fix, a UI-less API verification recipe, and a polled-integration label-scheme note (lag, stat dimension, integration-named env label). Also note the observed CLI instant-query 400 caveat in Common issues.
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.
What
Adds a "Building & editing dashboards" section to the groundcover-cli skill — the preset-authoring workflow that the CRUD verbs alone don't explain.
Covers:
.presetis a JSON string; thespec/layout/widgets/duration/variables/schemaVersionshape; 24-col grid with hand-computedy; widget types incl.textfor headers andsection.type:"section"+ achildren[]array of relative-positioned panels.currentRevisionis required (optimistic concurrency); re-getafter each write; the jq re-serialize pattern.400 Dashboard validation failed, the bisect strategy, and the two rules that cost real time: stat widgets only validate flat top-level (never in a section), and sectioncolor∈ {gray, purple, teal}.last_over_time([30m]).statdimension multiplier, integration-named env label, separate variable per label scheme.metrics query400s on instant bodies; fall back to range.Testing
Docs-only change. All claims are field-verified against a live Groundcover tenant while building a dashboard end-to-end. Generic placeholders only — no org-specific identifiers, metric names, or tenant UUIDs.