Skip to content

docs: add navigation and chrome terms to the Elastic glossary (#6222)#6755

Open
florent-leborgne wants to merge 9 commits into
mainfrom
docs-issue-6222-glossary-chrome-terms
Open

docs: add navigation and chrome terms to the Elastic glossary (#6222)#6755
florent-leborgne wants to merge 9 commits into
mainfrom
docs-issue-6222-glossary-chrome-terms

Conversation

@florent-leborgne
Copy link
Copy Markdown
Member

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

Summary

This PR addresses #6222 by adding nine navigation and chrome terms to the Elastic glossary (reference/glossary/index.md). The wording matches the naming standardized in #4073 / #6693 (style-guide alignment), not the now-stale wording in the #6222 issue body.

New entries

All entries are sentence-cased to match the rest of the glossary, and each explicitly ties the term to {{kib}}.

  • application menu (section A, after app) — the bar above the workspace that hosts actions specific to the active app.
  • classic view (section C, after CA) — the non-solution option in the solution view setting. Includes the disambiguation note from Add navigation and chrome terms to the Elastic glossary #6222 explaining that bare "Classic" is also used in Discover for Classic vs. {{esql}} mode.
  • flyout (section F, after flush) — a panel that slides in from the right of the workspace to show contextual content for the active app.
  • global header (section G, after GeoJSON) — the top bar of the Kibana chrome that hosts global controls (global search field, space switcher).
  • navigation menu (section N, after namespace) — the primary navigation panel on the left side of Kibana. Includes cross-references to solution view, secondary navigation, and an explicit "Not to be confused with the sidebar" pointer.
  • secondary navigation (section S, after searchable snapshot) — the panel that opens to the right of the navigation menu when a top-level item expands into sub-items.
  • sidebar (section S, after shrink) — the global, resizable right-hand panel where plugins register apps (Agent Builder chat as the canonical example). Includes reciprocal cross-references to flyout and to the navigation menu so the easily-confused names point at each other.
  • solution view (section S, after solution) — the per-space setting that controls the navigation menu. Possible values: Search, Observability, Security, Classic.
  • workspace (section W, after workpad) — the main content area of the active app, framed by the application menu, navigation menu, and (when present) sidebar.

Updates to existing entries

Three existing entries are lightly updated so the glossary stays internally consistent with the new chrome vocabulary:

  • app — "accessed through the side navigation" → "accessed through the navigation menu".
  • {{es}} — the bullet that mentioned "navigation or solution view" was rewritten to link to the new solution view entry, removing the conflation of navigation and solution view.
  • labs — "you'll see Labs in the toolbar" → "you'll see Labs in the application menu" so the location reference uses the canonical chrome term. (Reviewer: please spot-check that the Labs beaker button still appears in the application menu of Dashboard and Canvas in 9.4.)

Alignment with #4073 / #6693

The wording for each entry closely tracks the table standardized in #6693 (style-guide "Naming Kibana UI elements" section). Two terms originally proposed in the #6222 issue body — "Side navigation" and "Solution navigation" — are intentionally not added, because PR #6693 settled on "navigation menu" instead of "Side navigation" and dropped "Solution navigation" in favor of describing the navigation menu's contents through the active solution view.

No applies_to tags are added to the new entries. The definitions describe currently-active chrome, and the existing glossary keeps version-scoping out of entries except where the definition itself is version-bound (for example, glossary-cps).

Resolves

Closes #6222

Depends on

Follow-ups for separate audit

The user also asked me to look for existing chrome/UI-element terms in the glossary that may need to be revisited now that Kibana's chrome has evolved across the 9.x line. Aside from the labs wording update folded into this PR, the only other entries that describe visual UI elements are time filter and panel, and both are still valid sub-elements of current Kibana UIs — no action needed.

Propagating the new terms across the docs corpus (every existing "main menu" / "App menu bar" mention) is intentionally left for follow-up PRs under #4911, matching the same scoping decision made in #6693.


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

@github-actions
Copy link
Copy Markdown
Contributor

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 28, 2026

🔍 Preview links for changed docs

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 28, 2026

Elastic Docs Style Checker (Vale)

Summary: 3 warnings found

⚠️ Warnings (3): Fix when the suggestion improves clarity or correctness.
File Line Rule Message
reference/glossary/index.md 721 Elastic.DirectionalLanguage Don't use directional language. Use 'the label of the element' instead of 'to the right of'.
reference/glossary/index.md 742 Elastic.Spelling 'resizable' is a possible misspelling.
reference/glossary/index.md 742 Elastic.DirectionalLanguage Don't use directional language. Use 'the label of the element' instead of 'on the right side'.

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.

Adds nine terms aligned with the naming decisions in #4073 / #6693:
Application menu, Classic view, Flyout, Global header, Navigation menu,
Secondary navigation, Sidebar, Solution view, and Workspace. Updates
the existing app and Elasticsearch entries to link the new entries.

Co-authored-by: Cursor <cursoragent@cursor.com>
@florent-leborgne florent-leborgne force-pushed the docs-issue-6222-glossary-chrome-terms branch from 1dc07c3 to 5b9d269 Compare May 28, 2026 13:31
@florent-leborgne florent-leborgne marked this pull request as ready for review May 29, 2026 08:33
@florent-leborgne florent-leborgne requested a review from a team as a code owner May 29, 2026 08:33
Copy link
Copy Markdown
Member

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

I think we are exposing a little bit of internal cruft in this. otherwise lgtm

Comment thread reference/glossary/index.md Outdated
Comment thread reference/glossary/index.md Outdated
Comment thread reference/glossary/index.md Outdated
: Reduces the number of [primary shards](/reference/glossary/index.md#glossary-primary-shard) in an index.

$$$glossary-sidebar$$$ sidebar
: A global, resizable panel on the right side of {{kib}} where plugins can register apps, such as the {{agent-builder}} chat. Unlike a [flyout](/reference/glossary/index.md#glossary-flyout), which is contextual to the active app, the sidebar persists across apps. Not to be confused with the [navigation menu](/reference/glossary/index.md#glossary-navigation-menu), which is the primary navigation panel on the left side of {{kib}}.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

is plugins registering apps actually relevant to end users here?

Comment thread reference/glossary/index.md Outdated
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Copy link
Copy Markdown
Member Author

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

Sorry I marked this as ready by mistake, I still expect reviews on the actual names in another PR (perhaps done in between) and haven't properly reviewed this one. My bad there.

Comment thread reference/glossary/index.md Outdated
Comment thread reference/glossary/index.md Outdated
Comment thread reference/glossary/index.md Outdated
Comment thread reference/glossary/index.md Outdated
Comment thread reference/glossary/index.md Outdated
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.

Add navigation and chrome terms to the Elastic glossary

2 participants