docs-builder
Loading

Quick reference

The applies_to directive uses the following format:

<key>: <lifecycle> <version>

This page provides minimal reference information on the applies_to directive. For more detailed information, refer to Applies to.

applies_to accepts the following keys in this structure:

Note

The products key and its subkeys are used to indicate feature availability and applicability. The similarly named products frontmatter field is used to drive elastic.co search filters.

applies_to accepts the following lifecycle states:

  • preview
  • beta
  • ga
  • deprecated
  • removed
  • unavailable

applies_to accepts the following version formats:

  • Major.Minor
  • Major.Minor.Patch
Note

Regardless of the version format used in the source file, the version number will always be rendered in the Major.Minor.Patch format.