Loading

Applies to

Elastic Stack 9.1.0 ECE Discontinued 9.2.0 ECK 9.0.0 Elastic Cloud Hosted Beta 9.1.0 Self Managed Unavailable 9.3.0 Serverless Elasticsearch Beta 9.1.0 Serverless Observability Discontinued 9.2.0 Serverless Security 9.0.0 Coming 9.5.0 Discontinued 9.7.0

Allows you to annotate a page or section's applicability.

<life-cycle> [version], <life-cycle> [version]

Taking a mandatory life-cycle with an optional version.

  • preview
  • beta
  • development
  • deprecated
  • coming
  • discontinued
  • unavailable
  • ga

Can be in either major.minor or major.minor.patch format

coming 9.5, discontinued 9.7
discontinued 9.2.0
all

all and empty string mean generally available for all active versions

applies_to:
  serverless: all

all and empty string can also be specified at a version level

applies_to:
  stack: beta all
  serverless: beta

Both are equivalent, note all just means we won't be rendering the version portion in the html.

Applies To Model

The above model is projected to the following structured yaml.

---
applies_to:
  stack:
  deployment:
    eck:
    ess:
    ece:
    self:
  serverless:
    security:
    elasticsearch:
    observability:
  product:
---

This allows you to annotate various facets as defined in New versioning

Using yaml frontmatter pages can explicitly indicate to each deployment targets availability and lifecycle status

---
applies_to:
  stack: ga 9.1
  deployment:
    eck: ga 9.0
    ess: beta 9.1
    ece: discontinued 9.2.0
    self: unavailable 9.3.0
  serverless:
    security: ga 9.0.0
    elasticsearch: beta 9.1.0
    observability: discontinued 9.2.0
  product: coming 9.5, discontinued 9.7
---

Elastic Stack 9.1.0 ECE Discontinued 9.2.0 ECK 9.0.0 Elastic Cloud Hosted Beta 9.1.0 Self Managed Unavailable 9.3.0 Serverless Elasticsearch Beta 9.1.0 Serverless Observability Discontinued 9.2.0 Serverless Security 9.0.0 Coming 9.5.0 Discontinued 9.7.0

A header may be followed by an {applies_to} directive which will contextualize the applicability of the section further.

Note

the {applies_to} directive MUST be preceded by a heading directly.

Note that this directive needs triple backticks since its content is literal. See also Syntax guide > Literal directives

```{applies_to}
stack: ga 9.1
```

In order to play even better with markdown editors the following is also supported:

```yaml {applies_to}
stack: ga 9.1
```

This will allow the yaml inside the {applies-to} directive to be fully highlighted.

Inline applies to can be placed anywhere using the following syntax

This can live inline {applies_to}`section: <life-cycle> [version]`

An inline version example would be Elastic Stack Beta 9.1.0 this allows you to target elements more concretely visually.

A common use case would be to place them on definition lists:

Fruit Elastic Stack Technical Preview 9.1.0
A sweet and fleshy product of a tree or other plant that contains seed and can be eaten as food. Common examples include apples, oranges, and bananas. Most fruits are rich in vitamins, minerals and fiber.
Applies Technical Preview 9.1.0
A sweet and fleshy product of a tree or other plant that contains seed and can be eaten as food. Common examples include apples, oranges, and bananas. Most fruits are rich in vitamins, minerals and fiber.

A specialized {preview} role exist to quickly mark something as a technical preview. It takes a required version number as argument.

Property {preview}`<version>`
:   definition body

Elastic Stack 9.1.0

Elastic Stack 9.1.0 ECK 9.0.0 Elastic Cloud Hosted Beta 9.1.0

ECE Discontinued 9.2.0 Self Managed Unavailable 9.3.0

Serverless 9.0.0

Serverless Elasticsearch Beta 9.1.0 Serverless Observability Discontinued 9.2.0 Serverless Security 9.0.0

Elastic Stack 9.1.0