Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .agents/skills/docs-hub-whats-new/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
name: docs-hub-whats-new
disable-model-invocation: true
description: Refresh the What's new cards on Elastic product hub pages. Use when updating hub-whats-new.yml after a stack release, or when the user asks to refresh hub What's new content.
---

# Refresh hub What's new cards

Update `hub-whats-new.yml` at the docs-content repo root. Hub pages render that file with `{whats-new}` and `:product: elasticsearch`, `kibana`, or `logstash`.

The Elastic Stack hub does not use this file. It links to product and solution release notes with a regular `{card-group}`.

## When to run

After a stack minor GA (for example 9.5.0), or when the user asks to refresh the hub cards. Patch releases (9.5.1) usually do not change the cards unless a highlight was wrong.

## Sources (in this order)

Read these. Do not scrape changelog YAML, docs-builder internals, or unpublished bundles.

1. **Published release notes** for the target minor. Use the rendered pages, not GitHub source that may lag:
- [Elasticsearch](https://www.elastic.co/docs/release-notes/elasticsearch)
- [Kibana](https://www.elastic.co/docs/release-notes/kibana)
- [Logstash](https://www.elastic.co/docs/release-notes/logstash)
2. **Official what's-new blog** for the same minor, for example [Elastic 9.5](https://www.elastic.co/blog/whats-new-elastic-9-5-0). Use the blog to decide which items are the story of the release. Confirm each item against the published release notes before you keep it.
3. **Existing docs pages** in this repo (or `repo://` targets in other docs repos) for the `link:` on each card. Every link must resolve.

If the blog and the release notes disagree, the published release notes win for facts. The blog wins for which items belong on the hub.

## What to write

Schema: [what's new directive](https://elastic.github.io/docs-builder/syntax/whats-new/).

For each of `elasticsearch`, `kibana`, and `logstash`:

- Keep `id: whats-new` so the hub hero can jump to the panel.
- One `release-links` entry pointing at that product's release notes.
- One `upgrade-link` pointing at that product's upgrade page.
- Four or five `items`. Mark **one** item `featured: true`.
- `date` is the minor version, for example `9.5`.
- `tag` is a short category (Storage, Dashboards, Monitoring).
- `title` and `description` are sentence case, present tense, second person or impersonal. No em dashes. Do not use "click" or "choose".

Check warning on line 42 in .agents/skills/docs-hub-whats-new/SKILL.md

View workflow job for this annotation

GitHub Actions / build / vale

Elastic.QuotesPunctuation: Place punctuation inside closing quotation marks.
- Say "Generally available" or "Technical preview" in the description when the release notes do.

## Links

Every `release-links[].url`, `upgrade-link.url`, and `items[].link` must be one of:

- Site-absolute with `.md`, for example `/manage-data/data-store/columnar.md`
- Cross-repo, for example `elasticsearch://reference/query-languages/promql.md`

Do not use `https://www.elastic.co/docs/...` for pages this site publishes. Do not use relative paths.

Confirm the file exists before you add the link. For docs-content pages, `git cat-file -e HEAD:<path>` or a working-tree glob. For other repos, use the `repo://` form and confirm the path in that repo.

If a highlight has no documentation page yet, link to the product release notes and add a `Pending links` note in the PR body.

## What not to do

- Do not invent highlights that are not in the published release notes or the blog.
- Do not copy changelog YAML entries wholesale. Those lists are complete; the hub is a short story.
- Do not add an Elastic Stack key to this file.
- Do not edit `{whats-new}` on the hub Markdown pages. Those pages only name the product key.

## PR

Title: `Refresh hub What's new cards for <version>`.

Body must list the items you kept, the sources you read (release notes URLs and blog URL), and any pending links.
8 changes: 8 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@
/extend/ @elastic/core-docs
/get-started/ @elastic/core-docs

# Product hub pages. File rules replace the directory fallback (last match wins).
/products/ @elastic/docs
/products/elasticsearch.md @elastic/developer-docs @elastic/admin-docs
/products/kibana.md @elastic/ski-docs @elastic/admin-docs
/products/logstash.md @elastic/ski-docs
/products/elastic-stack.md @elastic/core-docs @elastic/ski-docs
/hub-whats-new.yml @elastic/developer-docs @elastic/ski-docs @elastic/core-docs

/manage-data/ @elastic/admin-docs
/manage-data/data-store/ @elastic/admin-docs @elastic/developer-docs
/manage-data/ingest/ @elastic/ski-docs
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/docs-ai-menu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -165,12 +165,12 @@ jobs:

| Team Label | Owns | Keywords / URL paths |
|---|---|---|
| `Team:Admin` | Elasticsearch admin, cluster mgmt, cloud, deployment docs | Cluster management, index management, auth, roles, API keys, network security, cluster security, snapshots, ILM, data lifecycle, CCR, CCS, licensing, subscriptions, upgrade, monitoring, Elastic Cloud, ECE, ECK, serverless. Paths: `deploy-manage/`, `cloud-account/`, `manage-data/` (except `manage-data/ingest/`), `serverless/`, `troubleshoot/deployments/`, `troubleshoot/elasticsearch/` |
| `Team:Experience` | Kibana, observability solution, security solution | Kibana, dashboards, visualizations, Discover, observability, security, APM UI, maps, canvas, Lens, alerting, rules, cases, SIEM, endpoint security, detection rules, security analytics. Paths: `explore-analyze/` (default), `solutions/observability/`, `solutions/security/`, `reference/kibana/`, `reference/observability/`, `reference/security/` |
| `Team:Developer` | Elasticsearch developer, search solution docs | Elasticsearch APIs, ES|QL, query DSL, search features, relevance, vector search, semantic search, inference APIs, connectors, developer tools, clients, search applications, App Search, Workplace Search. Paths: `solutions/search/`, `reference/elasticsearch/clients/`, `reference/search/`, `reference/machine-learning/`, `explore-analyze/ai-features/`, `explore-analyze/cross-cluster-search/`, `explore-analyze/cross-project-search/`, `explore-analyze/transforms/` |
| `Team:Ingest` | Data ingestion, Fleet, APM agents docs | Fleet, Elastic Agent, Beats, Logstash, pipelines, integrations, data streams, APM agents, APM server, OpenTelemetry. Paths: `manage-data/ingest/`, `reference/apm-agents/`, `reference/fleet/`, `reference/ingestion-tools/`, `solutions/observability/apm/apm-agents/`, `solutions/observability/apm/apm-server/`, `solutions/observability/apm/ingest/`, `solutions/observability/apm/opentelemetry/` |
| `Team:Admin` | Elasticsearch admin, cluster mgmt, cloud, deployment docs | Cluster management, index management, auth, roles, API keys, network security, cluster security, snapshots, ILM, data lifecycle, CCR, CCS, licensing, subscriptions, upgrade, monitoring, Elastic Cloud, ECE, ECK, serverless. Paths: `deploy-manage/`, `cloud-account/`, `manage-data/` (except `manage-data/ingest/`), `serverless/`, `troubleshoot/deployments/`, `troubleshoot/elasticsearch/`, `products/elasticsearch.md` |
| `Team:Experience` | Kibana, observability solution, security solution | Kibana, dashboards, visualizations, Discover, observability, security, APM UI, maps, canvas, Lens, alerting, rules, cases, SIEM, endpoint security, detection rules, security analytics. Paths: `explore-analyze/` (default), `solutions/observability/`, `solutions/security/`, `reference/kibana/`, `reference/observability/`, `reference/security/`, `products/kibana.md` |
| `Team:Developer` | Elasticsearch developer, search solution docs | Elasticsearch APIs, ES|QL, query DSL, search features, relevance, vector search, semantic search, inference APIs, connectors, developer tools, clients, search applications, App Search, Workplace Search. Paths: `solutions/search/`, `reference/elasticsearch/clients/`, `reference/search/`, `reference/machine-learning/`, `explore-analyze/ai-features/`, `explore-analyze/cross-cluster-search/`, `explore-analyze/cross-project-search/`, `explore-analyze/transforms/`, `products/elasticsearch.md` |
| `Team:Ingest` | Data ingestion, Fleet, APM agents docs | Fleet, Elastic Agent, Beats, Logstash, pipelines, integrations, data streams, APM agents, APM server, OpenTelemetry. Paths: `manage-data/ingest/`, `reference/apm-agents/`, `reference/fleet/`, `reference/ingestion-tools/`, `solutions/observability/apm/apm-agents/`, `solutions/observability/apm/apm-server/`, `solutions/observability/apm/ingest/`, `solutions/observability/apm/opentelemetry/`, `products/logstash.md` |
| `Team:DocsEng` | Docs infrastructure | Docs build system, CI/CD, website rendering, broken navigation, docs-builder bugs, elastic.co website issues not related to content. Paths: `.github/workflows/`, `.github/scripts/` |
| `Team:Projects` | Internal projects, docs initiatives | Internal documentation projects, content strategy, information architecture, get-started guides. Paths: `get-started/` |
| `Team:Projects` | Internal projects, docs initiatives | Internal documentation projects, content strategy, information architecture, get-started guides. Paths: `get-started/`, `products/elastic-stack.md`, `products/` |

**Shared ownership**: Some paths have shared ownership (e.g., `/explore-analyze/machine-learning/` is shared by Developer and Experience). Pick the team whose keywords best match the issue content.
**Internal projects**: If the issue seems related to an internal documentation project, initiative, or content strategy effort, apply `Team:Projects`.
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/docs-triage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ jobs:

| Team Label | Owns | Keywords / URL paths |
|---|---|---|
| `Team:Admin` | Elasticsearch admin, cluster mgmt, cloud, deployment docs | Cluster management, index management, auth, roles, API keys, network security, cluster security, snapshots, ILM, data lifecycle, CCR, CCS, licensing, subscriptions, upgrade, monitoring, Elastic Cloud, ECE, ECK, serverless. Paths: `deploy-manage/`, `cloud-account/`, `manage-data/` (except `manage-data/ingest/`), `serverless/`, `troubleshoot/deployments/`, `troubleshoot/elasticsearch/` |
| `Team:Experience` | Kibana, observability solution, security solution | Kibana, dashboards, visualizations, Discover, observability, security, APM UI, maps, canvas, Lens, alerting, rules, cases, SIEM, endpoint security, detection rules, security analytics. Paths: `explore-analyze/` (default), `solutions/observability/`, `solutions/security/`, `reference/kibana/`, `reference/observability/`, `reference/security/` |
| `Team:Developer` | Elasticsearch developer, search solution docs | Elasticsearch APIs, ES|QL, query DSL, search features, relevance, vector search, semantic search, inference APIs, connectors, developer tools, clients, search applications, App Search, Workplace Search. Paths: `solutions/search/`, `reference/elasticsearch/clients/`, `reference/search/`, `reference/machine-learning/`, `explore-analyze/ai-features/`, `explore-analyze/cross-cluster-search/`, `explore-analyze/cross-project-search/`, `explore-analyze/transforms/` |
| `Team:Ingest` | Data ingestion, Fleet, APM agents docs | Fleet, Elastic Agent, Beats, Logstash, pipelines, integrations, data streams, APM agents, APM server, OpenTelemetry. Paths: `manage-data/ingest/`, `reference/apm-agents/`, `reference/fleet/`, `reference/ingestion-tools/`, `solutions/observability/apm/apm-agents/`, `solutions/observability/apm/apm-server/`, `solutions/observability/apm/ingest/`, `solutions/observability/apm/opentelemetry/` |
| `Team:Admin` | Elasticsearch admin, cluster mgmt, cloud, deployment docs | Cluster management, index management, auth, roles, API keys, network security, cluster security, snapshots, ILM, data lifecycle, CCR, CCS, licensing, subscriptions, upgrade, monitoring, Elastic Cloud, ECE, ECK, serverless. Paths: `deploy-manage/`, `cloud-account/`, `manage-data/` (except `manage-data/ingest/`), `serverless/`, `troubleshoot/deployments/`, `troubleshoot/elasticsearch/`, `products/elasticsearch.md` |
| `Team:Experience` | Kibana, observability solution, security solution | Kibana, dashboards, visualizations, Discover, observability, security, APM UI, maps, canvas, Lens, alerting, rules, cases, SIEM, endpoint security, detection rules, security analytics. Paths: `explore-analyze/` (default), `solutions/observability/`, `solutions/security/`, `reference/kibana/`, `reference/observability/`, `reference/security/`, `products/kibana.md` |
| `Team:Developer` | Elasticsearch developer, search solution docs | Elasticsearch APIs, ES|QL, query DSL, search features, relevance, vector search, semantic search, inference APIs, connectors, developer tools, clients, search applications, App Search, Workplace Search. Paths: `solutions/search/`, `reference/elasticsearch/clients/`, `reference/search/`, `reference/machine-learning/`, `explore-analyze/ai-features/`, `explore-analyze/cross-cluster-search/`, `explore-analyze/cross-project-search/`, `explore-analyze/transforms/`, `products/elasticsearch.md` |
| `Team:Ingest` | Data ingestion, Fleet, APM agents docs | Fleet, Elastic Agent, Beats, Logstash, pipelines, integrations, data streams, APM agents, APM server, OpenTelemetry. Paths: `manage-data/ingest/`, `reference/apm-agents/`, `reference/fleet/`, `reference/ingestion-tools/`, `solutions/observability/apm/apm-agents/`, `solutions/observability/apm/apm-server/`, `solutions/observability/apm/ingest/`, `solutions/observability/apm/opentelemetry/`, `products/logstash.md` |
| `Team:DocsEng` | Docs infrastructure | Docs build system, CI/CD, website rendering, broken navigation, docs-builder bugs, elastic.co website issues not related to content. Paths: `.github/workflows/`, `.github/scripts/` |
| `Team:Projects` | Internal projects, docs initiatives | Internal documentation projects, content strategy, information architecture, get-started guides. Paths: `get-started/` |
| `Team:Projects` | Internal projects, docs initiatives | Internal documentation projects, content strategy, information architecture, get-started guides. Paths: `get-started/`, `products/elastic-stack.md`, `products/` |

**Shared ownership**: Some paths have shared ownership (e.g., `/explore-analyze/machine-learning/` is shared by Developer and Experience). Pick the team whose keywords best match the issue content.
**Internal projects**: If the issue seems related to an internal documentation project, initiative, or content strategy effort, apply `Team:Projects`.
Expand Down
3 changes: 2 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Keep this file lean: it points to the [`contribute-docs/`](contribute-docs/index

## About this repo

This is the source for the narrative user documentation published at <https://www.elastic.co/docs/>, built by [docs-builder](https://elastic.github.io/docs-builder/) from MyST Markdown. For the products and versions it covers, what belongs here versus in the code repos, and the repo layout, see the [README](README.md).
This is the source for the narrative user documentation published at <https://www.elastic.co/docs/>, built by [docs-builder](https://elastic.github.io/docs-builder/) from MyST Markdown. For the products and versions it covers, what belongs here versus in the code repos, and the repo layout, see the [README](README.md). Product hub pages live in [`products/`](products/) (`layout: hub`). Refresh their What's new cards with the `docs-hub-whats-new` skill.

## Core principles

Expand Down Expand Up @@ -55,6 +55,7 @@ The **Elastic docs skills** (from <https://github.com/elastic/elastic-docs-skill
| Page opening (H1, intro, requirements) | `docs-page-opening-optimizer` |
| Code sample validation | `docs-validate-code-samples` |
| Redirects | `docs-redirects` |
| Refresh hub What's new cards | `docs-hub-whats-new` |

The **elastic-docs MCP**, when available, searches the published corpus, finds related pages, and checks coherence.

Expand Down
2 changes: 2 additions & 0 deletions docset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ exclude:
- 'README.md'
- 'AGENTS.md'
- 'AI.md'
- '.agents/**'
- 'CLAUDE.md'
- 'GEMINI.md'
- 'changelog/**'
Expand Down Expand Up @@ -135,6 +136,7 @@ cross_links:
toc:
- file: index.md
- toc: get-started
- toc: products
- toc: solutions
- toc: manage-data
- toc: explore-analyze
Expand Down
1 change: 1 addition & 0 deletions frontmatter.config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ valid_items:
type: string
valid_values:
- archive
- hub
- landing-page
- not-found
- key: navigation_title
Expand Down
Loading
Loading