versions.yml

The versions.yml file specifies which versions of each product should be recognized as the minimum (base) and the latest (current) in documentation builds.

This example sets the Elastic Stack base and current versions while also assigning them to a variable that can be accessed with *stack

versioning_systems:
  stack: &stack
    base: 9.0
    current: 9.0.4
		

Versions set in this file are surfaced to the user via applies_to tags.

applies_to tags are rendered as badges in the documentation output. They reproduce the "key + lifecycle status + version" indicated in the content sources.

Specifically for versioned products, badges will display differently when the applies_to key specifies a product version that has not been released to our customers yet.

The following table shows how badges for versioned products are displayed based on the release status for each lifecycle value. Hover over the example badges for the tooltip text.

This is computed at build time (there is a docs build every 30 minutes). The documentation team tracks and maintains released versions for these products centrally in versions.yml.

When multiple lifecycle statuses and versions are specified in the sources, several badges are shown.

See Write cumulative documentation for more information.

Like products.yml (which provides {{product.<id>}} substitutions), versions.yml exposes version numbers as substitution variables so you can reference current or next versions without hardcoding.

Use {{version.<system> | <mutation>}} to display version numbers. Mutations let you derive related versions from the current value:

This is useful for documentation that references version-specific behavior without needing updates on every release:

This feature is available in {{version.stack | M.M}} and later.
Upgrade to {{version.stack | M+1 | M.M}} for the next major release.
		

For the full list of available mutations, see substitution mutations.