|
| 1 | +# Release a new documentation version |
| 2 | + |
| 3 | +When a new version of the Elastic Stack (or another versioned product) is released, the docs site must be updated to recognize it. This process primarily involves updating version metadata in the shared site configuration. |
| 4 | + |
| 5 | +Follow these steps to release a new documentation version. |
| 6 | + |
| 7 | +:::::{stepper} |
| 8 | + |
| 9 | +::::{step} Update `versions.yml` |
| 10 | + |
| 11 | +The `versions.yml` file defines the **base** (minimum) and **current** (latest) versions of each versioned product family. |
| 12 | + |
| 13 | +Example: |
| 14 | + |
| 15 | +```yaml |
| 16 | +versioning_systems: |
| 17 | + stack: &stack |
| 18 | + base: 9.0 |
| 19 | + current: 9.1.0 |
| 20 | +``` |
| 21 | +
|
| 22 | +- Update the `current` version to reflect the newly released version. |
| 23 | +- Only update the `base` version if you're dropping support for an older version. |
| 24 | + |
| 25 | +Refer to [`versions.yml`](../configure/site/versions.md) for more information. |
| 26 | + |
| 27 | +:::: |
| 28 | + |
| 29 | +::::{step} (Optional) Update legacy URL mappings |
| 30 | + |
| 31 | +If you're releasing a version older than the current `base`, or restoring support for a previously removed version, you may need to update the `legacy-url-mappings.yml` file. |
| 32 | + |
| 33 | +This file maps legacy URL paths (like `en/elasticsearch/reference/`) to the list of versions that exist at that path. |
| 34 | + |
| 35 | +For example, to release a new 8.19 version of the Elastic Stack: |
| 36 | + |
| 37 | +```diff |
| 38 | +- stack: &stack [ '9.0+', '8.18', '8.17', '8.16', '8.15', '8.14', '8.13', '8.12', '8.11', '8.10', '8.9', '8.8', '8.7', '8.6', '8.5', '8.4', '8.3', '8.2', '8.1', '8.0', '7.17' ] |
| 39 | ++ stack: &stack [ '9.0+', '8.19', '8.18', '8.17', '8.16', '8.15', '8.14', '8.13', '8.12', '8.11', '8.10', '8.9', '8.8', '8.7', '8.6', '8.5', '8.4', '8.3', '8.2', '8.1', '8.0', '7.17' ] |
| 40 | +``` |
| 41 | + |
| 42 | +See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for more information. |
| 43 | + |
| 44 | +:::: |
| 45 | + |
| 46 | +::::{step} Release a new version of docs-builder |
| 47 | + |
| 48 | +Version updates and content set additions require a release of docs-builder. |
| 49 | +Contact the Docs Eng team for assistance. |
| 50 | + |
| 51 | +:::: |
| 52 | + |
| 53 | +::::{step} Confirm `applies_to` metadata |
| 54 | + |
| 55 | +Cumulative documentation relies on version metadata through `applies_to` blocks, which use version definitions in `versions.yml`. |
| 56 | + |
| 57 | +Check the built output to ensure `applies_to` changes are correctly rendering. |
| 58 | + |
| 59 | +:::: |
0 commit comments