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.

• Planned (if the lifecycle is preview, beta, or ga)

  Example: Stack Planned

• Deprecation planned (if the lifecycle is deprecated)

  Example: Stack Deprecation planned

• Removal planned (if the lifecycle is removed)

  Example: Stack Removal planned

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.