Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
9ed2003
fix: upgrade @opentelemetry/exporter-trace-otlp-http from 0.215.0 to …
snyk-bot Jun 4, 2026
d115285
Fix: files with `_snippets` in their name incorrectly treated as snip…
Copilot Jun 5, 2026
50bea38
Enable nav search override on staging (#3474)
Mpdreamz Jun 5, 2026
3b81271
chore: Update config/versions.yml elasticsearch-client-ruby 9.4.1 (#3…
elastic-observability-automation[bot] Jun 5, 2026
b86c5ee
Add quick reference to applies_to syntax page (#3475)
leemthompo Jun 5, 2026
182938f
[storybook] Storybook directive, for inline story rendering (#2910)
clintandrewhall Jun 8, 2026
b015bef
fix(cli-reference): preserve supplemental frontmatter (#3488)
theletterf Jun 10, 2026
9c4e40f
feat(cli-reference): support title overrides (#3487)
theletterf Jun 10, 2026
d11e18d
fix(cli-reference): use segment path instead of segment/index.md for …
theletterf Jun 11, 2026
b75b08b
fix(page-card): apply UrlPathPrefix to resolved URLs (#3490)
theletterf Jun 11, 2026
080afb1
build(deps-dev): bump joi in /src/Elastic.Documentation.Site (#3491)
dependabot[bot] Jun 15, 2026
ac42e18
Bump AWSSDK.S3 from 4.0.23.3 to 4.0.23.4 (#3483)
dependabot[bot] Jun 15, 2026
615ae15
Bump AWSSDK.DynamoDBv2 from 4.0.18.4 to 4.0.18.5 (#3482)
dependabot[bot] Jun 15, 2026
d8afb5d
build(deps): bump actions/checkout from 6 to 6.0.2 in /.github/workfl…
dependabot[bot] Jun 15, 2026
94eef47
build(deps): bump zustand in /src/Elastic.Documentation.Site (#3480)
dependabot[bot] Jun 15, 2026
6fa3f9f
build(deps): bump @opentelemetry/instrumentation (#3479)
dependabot[bot] Jun 15, 2026
ddeb48d
build(deps): bump actions/checkout from 6 to 6.0.2 (#3478)
dependabot[bot] Jun 15, 2026
d68e69d
build(deps-dev): bump typescript-eslint (#3477)
dependabot[bot] Jun 15, 2026
716e12c
fix: upgrade @opentelemetry/exporter-trace-otlp-http from 0.215.0 to …
snyk-bot Jun 4, 2026
e1905e9
Merge remote-tracking branch 'origin/snyk-upgrade-113f013d01e96e09b54…
Copilot Jun 15, 2026
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
2 changes: 1 addition & 1 deletion .github/workflows/assembler-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ jobs:
}

- name: Checkout
uses: actions/checkout@v6
uses: actions/checkout@v6.0.2
with:
ref: ${{ steps.pr-details.outputs.result || github.event.pull_request.head.sha }}
persist-credentials: false
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-changelog-scrubber-lambda.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
env:
BINARY_PATH: .artifacts/docs-lambda-changelog-scrubber/release_linux-x64/bootstrap
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
ref: ${{ inputs.ref }}
persist-credentials: false
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-link-index-updater-lambda.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
env:
BINARY_PATH: .artifacts/docs-lambda-index-publisher/release_linux-x64/bootstrap
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
ref: ${{ inputs.ref }}
persist-credentials: false
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
validate-assembler:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false

Expand All @@ -42,7 +42,7 @@ jobs:
env:
MSBuildNoWarn: IDE0032
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false

Expand Down Expand Up @@ -77,7 +77,7 @@ jobs:
run:
working-directory: src/Elastic.Documentation.Site
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false

Expand Down Expand Up @@ -127,7 +127,7 @@ jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false

Expand All @@ -148,7 +148,7 @@ jobs:
- macos-latest
- windows-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false
- name: 'Windows only, set TEMP to the same drive'
Expand Down Expand Up @@ -201,7 +201,7 @@ jobs:
contents: read
id-token: write
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/create-major-tag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
create-major-tag:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: true
- name: Get major version
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs-preview-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ jobs:
steps:
- name: Checkout
if: github.event_name == 'push'
uses: actions/checkout@v6
uses: actions/checkout@v6.0.2
with:
ref: ${{ github.event.pull_request.head.sha || github.ref }}
persist-credentials: false
Expand Down Expand Up @@ -211,7 +211,7 @@ jobs:
if: >
env.MATCH == 'true'
&& needs.check.outputs.any_modified != 'false'
uses: actions/checkout@v6
uses: actions/checkout@v6.0.2
with:
ref: ${{ github.event.pull_request.head.sha || github.ref }}
persist-credentials: false
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/license.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/prerelease.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
steps:
- id: repo-basename
run: 'echo "value=`basename ${{ github.repository }}`" >> $GITHUB_OUTPUT'
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false
- name: Setup Pages
Expand Down Expand Up @@ -56,7 +56,7 @@ jobs:
major-version: ${{ steps.bootstrap.outputs.major-version }}

steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
major-version: ${{ steps.bootstrap.outputs.major-version }}

steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
ref: ${{ needs.release-drafter.outputs.tag_name }}
persist-credentials: false
Expand Down Expand Up @@ -188,7 +188,7 @@ jobs:
major-version: ${{ steps.bootstrap.outputs.major-version }}

steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
ref: ${{ needs.release-drafter.outputs.tag_name }}
persist-credentials: false
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/required-labels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false
- name: Wait for PR to be ready (if just opened)
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/smoke-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ jobs:
landing-page-path-output: ""

steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false
- name: Bootstrap Action Workspace
uses: ./.github/actions/bootstrap

- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
repository: ${{ matrix.repository }}
path: test-repo
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/updatecli.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
bump:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v6.0.2
with:
persist-credentials: false

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/zizmor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@v6
uses: actions/checkout@v6.0.2
with:
persist-credentials: false

Expand Down
4 changes: 2 additions & 2 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@
<PackageVersion Include="Aspire.Hosting" Version="13.0.0" />
<PackageVersion Include="Aspire.Hosting.Testing" Version="13.0.0" />
<PackageVersion Include="AWSSDK.Core" Version="4.0.7.3" />
<PackageVersion Include="AWSSDK.DynamoDBv2" Version="4.0.18.4" />
<PackageVersion Include="AWSSDK.DynamoDBv2" Version="4.0.18.5" />
<PackageVersion Include="AWSSDK.SQS" Version="4.0.2.32" />
<PackageVersion Include="AWSSDK.S3" Version="4.0.23.3" />
<PackageVersion Include="AWSSDK.S3" Version="4.0.23.4" />
<PackageVersion Include="Elastic.OpenTelemetry" Version="1.3.0" />
<PackageVersion Include="Microsoft.Extensions.Configuration.UserSecrets" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="10.0.8" />
Expand Down
2 changes: 1 addition & 1 deletion config/versions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ versioning_systems:
current: 9.4.0
elasticsearch-client-ruby:
base: 9.0
current: 9.4.0
current: 9.4.1
elasticsearch-client-rust:
base: 9.0
current: 9.1.0-alpha.1
Expand Down
4 changes: 4 additions & 0 deletions docs/_docset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ subs:

features:
primary-nav: false

storybook:
registry: https://ci-artifacts.kibana.dev/storybooks/pr-272388/storybook-docs/docs_registry.json

suppress:
- AutolinkElasticCoDocs
Expand Down Expand Up @@ -149,6 +152,7 @@ toc:
- file: lists.md
- file: task-lists.md
- file: line_breaks.md
- file: storybook.md
- file: links.md
- file: list-sub-pages.md
- file: page-card.md
Expand Down
12 changes: 12 additions & 0 deletions docs/cli/cli-reference-how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,16 @@ toc:
folder: cli-reference
```

Use `title:` to customize the generated CLI root page title, and `navigation_title:` to customize the sidebar and breadcrumb label without changing generated command examples:

```yaml
toc:
- cli: cli-schema.json
folder: cli-reference
title: Elastic CLI reference
navigation_title: CLI reference
```

Use `children:` to prepend hand-written pages — installation guides, conceptual overviews, or quick-start tutorials — before the auto-generated reference. All schema-generated pages follow the listed children:

```yaml
Expand Down Expand Up @@ -101,4 +111,6 @@ Your CLI reference section is live. As your CLI evolves, regenerate the schema a
|---|---|
| `cli: <path>` | Path to the schema JSON, relative to `docset.yml` |
| `folder: <path>` | Supplemental docs folder; also sets the URL prefix |
| `title: <title>` | Optional generated CLI root page title |
| `navigation_title: <title>` | Optional generated CLI root navigation label |
| `children:` | Regular toc items prepended before generated pages |
20 changes: 20 additions & 0 deletions docs/cli/cli-supplemental-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Supplemental files let you enrich any auto-generated CLI reference page with con

**Validation is strict.** Any supplemental file whose name does not match a known namespace or command produces a build error, so renamed or removed commands can never leave orphaned docs behind silently.

**Frontmatter is preserved as metadata.** Add YAML frontmatter to set page metadata such as `description`, `applies_to`, or `navigation_title`. It is passed through to the generated page and is not rendered as supplemental description text.

## File naming

Two naming styles are supported and can coexist in the same folder.
Expand Down Expand Up @@ -48,6 +50,24 @@ cli/

The heading structure of a supplemental file controls what it contributes to the generated page.

### Frontmatter

Use frontmatter for page metadata:

```markdown
---
description: Use the Elastic CLI to call Elasticsearch REST APIs from the command line.
applies_to:
stack: preview
---

## Description

The `elastic stack es` command group exposes Elasticsearch REST APIs as CLI commands.
```

The metadata remains metadata. The generated page uses the `## Description` section, or the schema description if the file only contains frontmatter.

### No headings

A file with no `##` headings replaces the auto-generated description entirely:
Expand Down
28 changes: 20 additions & 8 deletions docs/syntax/applies.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
# Applies to

Starting with Elastic Stack 9.0, ECE 4.0, and ECK 3.0, documentation follows a [cumulative approach](https://www.elastic.co/docs/contribute-docs/how-to/cumulative-docs): instead of creating separate pages for each product and release, we update a single page with product- and version-specific details over time.
Elastic documentation on [elastic.co/docs](https://www.elastic.co/docs) follows a [cumulative](https://www.elastic.co/docs/contribute-docs/how-to/cumulative-docs) model. We don't maintain versioned branches or separate copies of a page for each release. Instead, every page covers all supported versions, and writers use `applies_to` metadata to tag content with the versions, products, deployment models, and lifecycle states it applies to.

To support this, source files use a tagging system to indicate:
:::{tip}
You can use the [applies-to-tagging](https://github.com/elastic/elastic-docs-skills/tree/main/skills/authoring/applies-to-tagging) skill in Claude Code to validate and generate `applies_to` tags. [**Learn more**](https://github.com/elastic/elastic-docs-skills/tree/main#elastic-docs-skills)
:::

* Which Elastic products and deployment models the content applies to.
* When a feature changes state relative to the base version.
## Quick reference

This is what the `applies_to` metadata is for. It can be used at the [page](#page-level), [section](#section-level), or [inline](#inline-level) level to specify applicability with precision.
When documenting a new feature or behavior, answer these two questions:

:::{note}
For detailed guidance, refer to [Write cumulative documentation](https://www.elastic.co/docs/contribute-docs/how-to/cumulative-docs).
:::
1. **Where should I add `applies_to` metadata?** Find where your changes sit on the page and match to a type below.
2. **What keys and values do I use?** Refer to the [key-value reference](#key-value-reference) for the full list of valid keys, lifecycles, and version formats.

### Where should I put the `applies_to` metadata?

| When | Use |
|------|-----|
| You're creating a new page | [Frontmatter](#page-level) |
| You're adding a new section to an existing page | [Section-level annotation](#section-level) |
| You're adding a single new item to a list or definition term | [Inline annotation](#inline-level) |
| You're marking a single item as a technical preview | [Preview shorthand](#inline-level) |
| You need to show entirely different content for each variant, not just tag the same content | [Versioned tabs](applies-switch.md) |
| You're adding a version-specific note, tip, or warning | [Admonition annotation](admonitions.md) |
| You're adding a version-specific dropdown | [Dropdown annotation](dropdowns.md) |

## Syntax reference

Expand Down
3 changes: 2 additions & 1 deletion docs/syntax/directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ The following directives are available:
- [Math](math.md) - Mathematical expressions and equations
- [Page cards](page-card.md) - Full-width clickable navigation rows
- [Settings](automated_settings.md) - Configuration blocks
- [Storybook](storybook.md) - Embedded Storybook stories
- [Stepper](stepper.md) - Step-by-step content
- [Tabs](tabs.md) - Tabbed content organization
- [Tables](tables.md) - Data tables
- [Version blocks](version-variables.md) - API version information
- [Version blocks](version-variables.md) - API version information
4 changes: 2 additions & 2 deletions docs/syntax/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Elastic Docs V3 uses a custom implementation of [MyST](https://mystmd.org/) (Mar

If you know [Markdown](https://commonmark.org), you already know most of what you need. If not, the CommonMark project offers a [10-minute tutorial](https://commonmark.org/help/).

When you need more than basic Markdown, you can use _directives_ to add features like callouts, tabs, and diagrams. To learn how directives work in general, including how to add options and arguments and nest multiple directives, refer to [How directives work](directives.md). For a full list of available directives, refer to the sidebar.
When you need more than basic Markdown, you can use _directives_ to add features like callouts, tabs, diagrams, and embedded Storybook stories. To learn how directives work in general, including how to add options and arguments and nest multiple directives, refer to [How directives work](directives.md). For a full list of available directives, refer to the sidebar.

## GitHub Flavored Markdown support

Expand All @@ -25,4 +25,4 @@ V3 supports some GitHub Flavored Markdown extensions:
**Not supported:**
- Automatic URL linking: https://www.elastic.co
- Links must use standard Markdown syntax: [Elastic](https://www.elastic.co)
- Using a subset of HTML
- Using a subset of HTML
Loading
Loading