Skip to content

docs: document the dashboard 48-column grid (#5449)#6329

Closed
florent-leborgne wants to merge 6 commits into
mainfrom
docs-issue-5449-dashboard-grid
Closed

docs: document the dashboard 48-column grid (#5449)#6329
florent-leborgne wants to merge 6 commits into
mainfrom
docs-issue-5449-dashboard-grid

Conversation

@florent-leborgne
Copy link
Copy Markdown
Member

@florent-leborgne florent-leborgne commented May 6, 2026

Summary

This PR addresses #5449 in full and contributes the panel-sizing/arranging portion of #5445.

Changes to explore-analyze/dashboards/arrange-panels.md:

  • New top-level Dashboard grid layout and best practices section, placed right after Requirements so readers see it before any of the arrange/move/resize sections. It documents:
    • The 48-column grid and snap behavior, plus the default new-panel width (half / 24 columns).
    • A reference table of common widths (Full / Half / Third / Quarter / Sixth).
    • A short set of best practices for sizing and arranging panels: matching panel height to content type, keeping heights consistent within a row, using width to signal importance, and separating primary from secondary content with collapsible sections.
  • Updates the resize bullet under Move and resize panels to point readers to the new section, so the snap behavior is discoverable from the procedure.

The best practices bullets were originally drafted in #6330 and moved here so all panel-sizing and arranging guidance lives next to the grid mechanics it depends on.

Verified against elastic/kibana source:

  • DASHBOARD_GRID_COLUMN_COUNT = 48 (src/platform/plugins/shared/dashboard/common/page_bundle_constants.ts)
  • DEFAULT_PANEL_WIDTH = DASHBOARD_GRID_COLUMN_COUNT / 2 = 24 (src/platform/plugins/shared/dashboard/common/constants.ts)

The 48-column grid is long-standing and not version-scoped, so no applies_to is added.

Resolves


AI-generated draft — created with Claude Sonnet 4.6.
Review all generated content for factual accuracy before merging.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

✅ Vale Linting Results

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

🔍 Preview links for changed docs

Co-authored-by: Cursor <cursoragent@cursor.com>
florent-leborgne added a commit that referenced this pull request May 6, 2026
- Shorten H2 to `## Best practices` to match the other three pages
  in this PR and parallel #6329's noun-phrase style.
- Cross-link the width bullet to the new `Dashboard grid layout`
  section added in #6329 so readers can find concrete column widths
  in one click.

Co-authored-by: Cursor <cursoragent@cursor.com>
florent-leborgne added a commit that referenced this pull request May 6, 2026
Move the panel sizing/arranging best-practices section to PR #6329
so it lives inside the new "Dashboard grid layout" section instead
of as a standalone section at the bottom of the page.

The cross-link in `create-dashboard.md` still points at
`#arrange-panels-best-practices`, which #6329 will create.

Co-authored-by: Cursor <cursoragent@cursor.com>
Adds an H3 Best practices subsection inside the new Dashboard grid
layout H2, covering:

- Match panel height to content type
- Keep heights consistent within a row
- Use width to signal importance (refers to the column reference
  table above)
- Separate primary from secondary content with collapsible sections

Cross-references back to Best practices for dashboard design in
`create-dashboard.md` (added in PR #6330).

Originally drafted in #6330, moved here so all panel sizing /
arranging guidance lives in a single section with the grid mechanics.

Co-authored-by: Cursor <cursoragent@cursor.com>
The link from `arrange-panels.md` Best practices to
`create-dashboard.md#create-dashboard-best-practices` pointed at an
anchor that only exists in #6330. Removing it lets this PR merge
independently.

The reverse direction (`create-dashboard.md` → `arrange-panels.md`
Best practices) is kept in #6330 and will resolve once this PR lands.

Co-authored-by: Cursor <cursoragent@cursor.com>
Comment thread explore-analyze/dashboards/arrange-panels.md Outdated
Comment thread explore-analyze/dashboards/arrange-panels.md Outdated
Comment thread explore-analyze/dashboards/arrange-panels.md Outdated
florent-leborgne and others added 2 commits May 6, 2026 20:45
Co-authored-by: Florent LB <florent.leborgne@elastic.co>
Co-authored-by: Cursor <cursoragent@cursor.com>
florent-leborgne added a commit that referenced this pull request May 6, 2026
The target section was renamed to 'Dashboard grid layout and best
practices' in #6329, with the H2 anchor 'dashboard-grid-layout'. The
old 'arrange-panels-best-practices' anchor no longer exists, so update
the link target and label to match.

Co-authored-by: Cursor <cursoragent@cursor.com>
@florent-leborgne
Copy link
Copy Markdown
Member Author

Closing in favor of a new PR that consolidates the panel-sizing and dashboard-design guidance into a single dashboards-best-practices.md page, with pointers from arrange-panels.md and individual chart pages instead of duplicated content. The new PR will close both #5449 and #5445.

@florent-leborgne
Copy link
Copy Markdown
Member Author

Superseded by #6340, which consolidates this PR and #6330 into a single comprehensive Best practices for creating dashboards page that closes both #5449 and #5445.

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.

Document the dashboard grid system in the Organize panels page

1 participant