-
Notifications
You must be signed in to change notification settings - Fork 40
Demo findability prototypes together #3256
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 157 commits
d75da63
0f58ae0
407c477
76657fb
3213a5c
33502f5
cd3075b
e0cc136
a870f12
41c1ca2
858593e
027fcd7
4490cf9
c808a6e
1e81481
99670dd
5c7380b
b7172c6
18540af
c9160ce
e7c8292
3fa5e19
69d6c32
9942d3a
0b4bb8d
15b3bef
eea7a08
db10774
6b953fd
8c2d0d8
8c1645c
0278198
6d747b1
b00e1db
216ec9c
c34c969
afd4977
defdce1
3aa6eee
e60bd4b
c08b6e3
1f3f702
313138a
6a667dc
369e518
beefc87
c4cbed6
92d4829
6cad4aa
f1c3e2a
e4171a2
65579de
29ba44f
d828f09
d4bdd09
a6399e3
b8e3e80
0f21dd1
bebeab4
11895b4
a88ea32
cf5e8e8
a798bb0
c69e47f
e49938a
822bba0
287adac
5debd27
a521e8b
94ec3bf
4130966
1dfdeb1
b767e2b
46d2f6e
2eaa6f4
21e88aa
071f456
3a46434
ef333f8
23f27b3
7fed2c5
cdabed1
0557264
1e4da5a
710743e
ca03a50
a0b98a3
b813024
e02fc81
6803630
fdb278a
2d20e27
c4c5bab
13a6695
4e3bde9
3df00ef
194a57b
41f26a5
dae9fc0
dbda3a4
e9676c6
ec6ff07
8817c8c
e3d365f
28cbaca
a7ff220
26b4886
705bd15
7cc21db
9179599
7940d99
1908fee
f6ce8b8
24cee85
40538ef
171b72a
9979af7
4f247a8
35aa23b
4481051
39fb863
57ea08e
d0c4497
f569f7e
22a6dcb
f5fea77
04f59da
79299cb
676566c
4cc9e37
563b460
20a3966
6a60978
c08b2b2
c4705ec
2158dec
0784279
8c7d3fa
52840c4
c4d5edb
ca9489e
6dde442
10330f7
a1262cd
c6b9d67
d556dff
65bc6de
8c4af37
63f927e
1fab04a
1c18fa1
54c3a7e
3357eb6
0bf256a
b0dbb3a
e6c9ed6
af3da7b
ef8b5a6
588260f
9206684
3e262e4
17bbea5
deb195c
7d37bf9
f631f36
fbc0cd5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| ### | ||
| # Centralized "What's new" feed used by the {whats-new} directive. | ||
| # | ||
| # Any page can render a product's recent highlights with: | ||
| # | ||
| # :::{whats-new} | ||
| # :product: kibana | ||
| # ::: | ||
| # | ||
| # The {whats-new} directive looks the product up in this file and renders the | ||
| # full panel (header + items). Authors only edit this file; the directive | ||
| # stays trivial in markdown. | ||
| # | ||
| # An optional `id` and `badge` per product control the section anchor and the | ||
| # small badge shown to the left of the title; default badge is "New". | ||
| ### | ||
|
|
||
| products: | ||
|
|
||
| kibana: | ||
| title: What's new in Kibana | ||
| id: whats-new | ||
| badge: New | ||
|
Comment on lines
+20
to
+23
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Duplicate section IDs can break anchors Both product entries use Suggested fix kibana:
title: What's new in Kibana
- id: whats-new
+ id: whats-new-kibana
@@
elasticsearch:
title: What's new in Elasticsearch
- id: whats-new
+ id: whats-new-elasticsearchAlso applies to: 47-50 🤖 Prompt for AI Agents |
||
| release-links: | ||
| - label: '9.4' | ||
| url: https://www.elastic.co/docs/release-notes/kibana | ||
| - label: Serverless | ||
| url: https://www.elastic.co/docs/release-notes/serverless | ||
| items: | ||
| - title: Dashboards and visualizations APIs | ||
| description: Programmatically create and manage dashboards and visualizations | ||
| link: https://www.elastic.co/docs/api/doc/kibana | ||
| meta: 9.4 preview | ||
| - title: AI agent skills | ||
| description: Teach AI coding agents to work with the Elastic stack | ||
| link: https://www.elastic.co/docs/explore-analyze/ai-features/agent-skills | ||
| meta: Mar 2026 | ||
| - title: Agent Builder | ||
| description: Build custom AI agents that reason over your data | ||
| link: https://www.elastic.co/docs/explore-analyze/ai-features/elastic-agent-builder | ||
| meta: 9.3 GA | ||
| - title: Workflows | ||
| description: Automate tasks with Kibana actions, HTTP calls, and AI agents | ||
| link: https://www.elastic.co/docs/explore-analyze/workflows | ||
| meta: 9.3 preview | ||
|
|
||
| elasticsearch: | ||
| title: What's new in Elasticsearch | ||
| id: whats-new | ||
| badge: New | ||
| release-links: | ||
| - label: '9.4' | ||
| url: https://www.elastic.co/docs/release-notes/elasticsearch | ||
| - label: Serverless | ||
| url: https://www.elastic.co/docs/release-notes/serverless | ||
| items: | ||
| - title: semantic_text field type | ||
| description: Simplify semantic search — no pipeline setup needed, just define the field and start querying | ||
| link: https://www.elastic.co/docs/solutions/search/semantic-search/semantic-search-semantic-text | ||
| meta: 9.4 GA | ||
| - title: ES|QL improvements | ||
| description: New functions, cross-cluster support, and dense vector operations directly in ES|QL queries | ||
| link: https://www.elastic.co/docs/reference/query-languages/esql/esql-getting-started | ||
| meta: '9.4' | ||
| - title: Inference API expansion | ||
| description: Connect to external AI models (OpenAI, Cohere, Anthropic, Hugging Face, Azure, Google) for embeddings and reranking | ||
| link: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put | ||
| meta: '9.4' | ||
| - title: Breaking changes in 9.x | ||
| description: Review removed settings, deprecated APIs, and behavioral changes before upgrading from 8.x | ||
| link: https://www.elastic.co/docs/release-notes/elasticsearch/breaking-changes | ||
| meta: Upgrade guide | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Card group | ||
|
|
||
| A section heading + a card grid container. Wraps one or more [`{link-card}`](link-card.md) directives. | ||
|
|
||
| ## Basic | ||
|
|
||
| ```markdown | ||
| ::::{card-group} | ||
| :title: Install and administer | ||
| :id: install | ||
|
|
||
| :::{link-card} | ||
| title: Self-managed | ||
| link: /deploy/self-managed | ||
| description: Run on your own infrastructure. | ||
| links: | ||
| - { label: Docker, url: /deploy/docker } | ||
| ::: | ||
|
|
||
| :::{link-card} | ||
| title: Elastic Cloud Hosted | ||
| link: /deploy/cloud | ||
| description: Managed deployments on AWS, GCP, or Azure. | ||
| ::: | ||
| :::: | ||
| ``` | ||
|
|
||
| The outer fence uses **four** colons (`::::`) so the inner three-colon `:::` fences for the cards aren't interpreted as a closing fence. Use as many extra colons on the outer fence as you need to nest cleanly. | ||
|
|
||
| ## Options | ||
|
|
||
| | Option | Notes | | ||
| |---|---| | ||
| | `:title:` | H2 heading. Optional — without it, only the grid renders. | | ||
| | `:intro:` | Optional intro paragraph below the heading. | | ||
| | `:id:` | Section anchor. Picked up by [`{on-this-page}`](on-this-page.md). | | ||
|
|
||
| ## Layout | ||
|
|
||
| The grid auto-fills 1, 2, or 3 columns based on viewport width using `grid-template-columns: repeat(auto-fill, minmax(310px, 1fr))`. Card heights match within a row. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Hero | ||
|
|
||
| A full-bleed hero band with a product icon, page title, description, fake search box, version dropdown, quick-action pills, and an optional release-status line. Designed for the [hub layout](hub-pages.md) but reusable on any page. | ||
|
|
||
| All hero content is supplied via options. The directive body is not used. | ||
|
|
||
| ## Basic | ||
|
|
||
| ```markdown | ||
| :::{hero} | ||
| :icon: kibana | ||
| :title: Kibana | ||
| :description: The UI for the Elasticsearch platform. | ||
| :version: v9 / Serverless (current) | ||
| ::: | ||
| ``` | ||
|
|
||
| The `:title:` option doubles as the page title (no body H1 needed). `:description:` supports inline markdown — links, bold, emphasis. | ||
|
|
||
| ## Options | ||
|
|
||
| | Option | Type | Notes | | ||
| |---|---|---| | ||
| | `:title:` | string | **Required.** Page heading shown next to the icon. Also picked up as the document's page title. | | ||
| | `:description:` | inline markdown | One-line summary shown below the title. Supports bold, italics, and links. | | ||
| | `:icon:` | string | Product key. Resolves to an inline SVG via the product-icon lookup. Known keys: `elasticsearch`, `kibana`, `observability`, `security`. Unknown keys fall back to a single-letter chip. | | ||
| | `:version:` | string | Label inside the version chip (e.g. `v9 / Serverless (current)`). | | ||
| | `:versions:` | comma list | When set, the chip becomes a `<details>` dropdown listing other versions. Items use `Label` (greyed, "soon") or `Label=URL` (clickable). | | ||
| | `:quick-links:` | comma list, `Label=URL` | Pill bar below the version chip. | | ||
| | `:releases:` | inline markdown | Small status line under the pills, supports inline links and bold/italic. | | ||
| | `:search:` | bool, default `true` | Show the placeholder search box. | | ||
|
|
||
| ## Version dropdown | ||
|
|
||
| ```markdown | ||
| :::{hero} | ||
| :icon: kibana | ||
| :title: Kibana | ||
| :description: The UI for the Elasticsearch platform. | ||
| :version: v9 / Serverless (current) | ||
| :versions: v8=https://www.elastic.co/docs/products/kibana/8.x,v7 | ||
| ::: | ||
| ``` | ||
|
|
||
| `v8=...` is a clickable link. `v7` (no `=URL`) renders greyed out with a "soon" badge. | ||
|
|
||
| ## Quick links and releases | ||
|
|
||
| ```markdown | ||
| :::{hero} | ||
| :icon: elasticsearch | ||
| :title: Elasticsearch | ||
| :description: The distributed search and analytics engine. | ||
| :version: v9 / Serverless (current) | ||
| :quick-links: Install=/install,API reference=/api,Release notes=/release-notes | ||
| :releases: Latest: [Stack 9.4.1](/rn) (Mar 28, 2026) · [Serverless deployed](/srn) Apr 1, 2026 | ||
| ::: | ||
| ``` | ||
|
|
||
| The `:releases:` option is inline markdown — same syntax as a single line of body markdown. Use `:` for a literal colon when you don't want YAML to parse the value as a key/value pair. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| products: | ||
| - id: elasticsearch | ||
| - id: kibana | ||
| --- | ||
|
|
||
| # Hub pages | ||
|
|
||
| Hub pages are product-scoped landing pages — a 360° overview of one product across versions, deployment types, and surfaces. They're enabled by setting `layout: hub` in the page's frontmatter and composed from a small set of dedicated directives. | ||
|
|
||
| ## Enable the layout | ||
|
|
||
| ```yaml | ||
| --- | ||
| layout: hub | ||
| --- | ||
| ``` | ||
|
|
||
| The `hub` layout drops the right-rail "On this page" TOC and the prev/next nav. The body owns the full width of the content column so directives can render full-bleed sections. | ||
|
|
||
| ## Directives | ||
|
|
||
| | Directive | Purpose | | ||
| |-----------|---------| | ||
| | [`{hero}`](hero.md) | Full-bleed page hero with product icon, title, search, version dropdown, and quick-action pills. | | ||
| | [`{on-this-page}`](on-this-page.md) | Auto-generated inline TOC linking each section anchor on the page. | | ||
| | [`{intro}`](intro.md) | Small "getting started" callout panel with a teal accent bar. | | ||
| | [`{whats-new}`](whats-new.md) | "What's new" panel populated from `config/whats-new.yml`. | | ||
| | [`{card-group}`](card-group.md) | Section heading + card grid container. | | ||
| | [`{link-card}`](link-card.md) | Rich card with title, description, primary link list, and optional aside. | | ||
|
|
||
| ## Page skeleton | ||
|
|
||
| ```markdown | ||
| --- | ||
| layout: hub | ||
| --- | ||
|
|
||
| :::{hero} | ||
| :icon: kibana | ||
| :title: Kibana | ||
| :description: The UI for the Elasticsearch platform. | ||
| :version: v9 / Serverless (current) | ||
| :versions: v8,v7 | ||
| :quick-links: Install=/install,Tutorial=/tutorial | ||
| :releases: Latest: [Stack 9.4.1](/rn) (Mar 28, 2026) | ||
| ::: | ||
|
|
||
| :::{on-this-page} | ||
| ::: | ||
|
|
||
| :::{intro} | ||
| **New to Kibana?** [Take the tutorial](/tutorial) — 30 minutes, hands-on. | ||
| ::: | ||
|
|
||
| :::{whats-new} | ||
| :product: kibana | ||
| ::: | ||
|
|
||
| ::::{card-group} | ||
| :title: Install and administer | ||
| :id: install | ||
|
|
||
| :::{link-card} | ||
| title: Self-managed | ||
| link: /deploy-manage/deploy/self-managed | ||
| description: Run Kibana on your own infrastructure. | ||
| links: | ||
| - { label: Docker, url: /deploy/docker } | ||
| - { label: Configure, url: /deploy/configure } | ||
| ::: | ||
| :::: | ||
| ``` | ||
|
|
||
| ## Product badges | ||
|
|
||
| Every regular (non-hub) page that declares one or more `products:` in its frontmatter automatically gets a clickable badge above its H1, linking to that product's hub page. The badge → hub URL mapping is set per product in [`config/products.yml`](../configure/site/products.md): | ||
|
|
||
| ```yaml | ||
| products: | ||
| kibana: | ||
| display: 'Kibana' | ||
| versioning: 'stack' | ||
| hub: 'products/kibana/9.0' # path slug -- relative to site root | ||
| ``` | ||
|
|
||
| When `hub:` is null, no badge renders for that product. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Intro callout | ||
|
|
||
| A small white panel with a teal accent bar — used for "getting started" callouts directly under the hero. | ||
|
|
||
| ## Basic | ||
|
|
||
| ```markdown | ||
| :::{intro} | ||
| **New to Kibana?** [Take the tutorial](/tutorial) — a 30-minute, hands-on walk-through of Discover, dashboards, and ES|QL. | ||
| ::: | ||
| ``` | ||
|
|
||
| Body is rendered as inline markdown. Use bold, links, and emphasis freely; keep it to one or two short paragraphs. | ||
|
|
||
| ## When to use | ||
|
|
||
| `{intro}` is the standard "front door" panel between the [`{hero}`](hero.md) and the [`{on-this-page}`](on-this-page.md) chip. It's optional — skip it when the hero already says what readers need to know next. | ||
|
|
||
| It is **not** an admonition. For caution / note / tip-style callouts inside body content, use the existing [admonitions](admonitions.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
narrative.current: hub-pageshardcodes a demo branch — will break builds when that branch is merged or deleted.Once this config lands on
mainand thehub-pagesbranch is eventually merged/cleaned up, every assembler build will fail trying to check out a non-existent ref. This should be reverted to the previous stable value (or use the appropriate production branch/ref) before merging tomain.🤖 Prompt for AI Agents