docs: add navigation and chrome terms to the Elastic glossary (#6222)#6755
docs: add navigation and chrome terms to the Elastic glossary (#6222)#6755florent-leborgne wants to merge 9 commits into
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
🔍 Preview links for changed docs |
a8589a7 to
ef28cbb
Compare
ef28cbb to
baabf11
Compare
baabf11 to
1dc07c3
Compare
Elastic Docs Style Checker (Vale)Summary: 3 warnings found
|
| 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>
1dc07c3 to
5b9d269
Compare
shainaraskas
left a comment
There was a problem hiding this comment.
I think we are exposing a little bit of internal cruft in this. otherwise lgtm
| : 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}}. |
There was a problem hiding this comment.
is plugins registering apps actually relevant to end users here?
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>
florent-leborgne
left a comment
There was a problem hiding this comment.
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.
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, afterapp) — the bar above the workspace that hosts actions specific to the active app.classic view(section C, afterCA) — 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, afterflush) — a panel that slides in from the right of the workspace to show contextual content for the active app.global header(section G, afterGeoJSON) — the top bar of the Kibana chrome that hosts global controls (global search field, space switcher).navigation menu(section N, afternamespace) — 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, aftersearchable snapshot) — the panel that opens to the right of the navigation menu when a top-level item expands into sub-items.sidebar(section S, aftershrink) — 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, aftersolution) — the per-space setting that controls the navigation menu. Possible values: Search, Observability, Security, Classic.workspace(section W, afterworkpad) — 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 newsolution viewentry, 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_totags 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
labswording update folded into this PR, the only other entries that describe visual UI elements aretime filterandpanel, 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.