Skip to content

Dimensions docs-builder edition #2567

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.

Sign up for GitHub

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

Open
shainaraskas wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Dimensions docs-builder edition #2567

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 11 additions & 8 deletions docs/syntax/applies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,25 @@

### Page level

Page level annotations are added in the YAML frontmatter, starting with the `applies_to` key and following the [key-value reference](#key-value-reference). For example:
Page level annotations are added in the YAML frontmatter, starting with the `applies_to` key and following the [key-value reference](#key-value-reference).

All documentation pages must include an `applies_to` tag in the YAML frontmatter.

:::{note}
In the page front matter, you should only refer to one dimension (stack/serverless, deployment, or product). Refer to the [cumulative documentation guidelines](https://www.elastic.co/docs/contribute-docs/how-to/cumulative-docs/guidelines#dimensions) for details.
:::

For example:

```yaml
---
applies_to:
stack: ga
deployment:
ece: ga
---
```

:::{important}
All documentation pages must include an `applies_to` tag in the YAML frontmatter.
:::

For more examples, refer to [Page annotation examples](#page-annotation-examples).

Check failure on line 51 in docs/syntax/applies.md

View workflow job for this annotation

GitHub Actions / build 

`page-annotation-examples` does not exist in syntax/applies.md.

Check failure on line 51 in docs/syntax/applies.md

View workflow job for this annotation

GitHub Actions / build 

`page-annotation-examples` does not exist in syntax/applies.md.

### Section level

Expand Down Expand Up @@ -221,8 +226,6 @@
```yaml
applies_to:
stack: preview 9.1, ga 9.4
deployment:
ece: deprecated 9.2, removed 9.8
```

:::{include} _snippets/versioned-lifecycle.md
Expand Down
Loading