You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contribute/release-new-version.md
+37-6Lines changed: 37 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ Follow these steps to release a new documentation version.
8
8
9
9
::::{step} Update `versions.yml`
10
10
11
+
_This action can be performed by any member of the docs team. It's also [automated](https://github.com/elastic/docs-builder/actions/workflows/updatecli.yml) for many products._
12
+
11
13
The `versions.yml` file defines the **base** (minimum) and **current** (latest) versions of each versioned product family.
12
14
13
15
Example:
@@ -28,28 +30,57 @@ Refer to [`versions.yml`](../configure/site/versions.md) for more information.
28
30
29
31
::::{step} (Optional) Update legacy URL mappings
30
32
33
+
_This action can be performed by any member of the docs team._
34
+
31
35
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
36
33
37
This file maps legacy URL paths (like `en/elasticsearch/reference/`) to the list of versions that exist at that path.
34
38
35
39
For example, to release the 8.19 version of the Elastic Stack, update the `stack` versions array to include the new version number:
See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for more information.
46
+
47
+
::::
48
+
49
+
::::{step} Approve and merge the config change
50
+
51
+
_This action must be performed by docs engineering._
52
+
53
+
Merge the `versions.yml` changes and any legacy URL mapping changes.
54
+
55
+
Optionally, invoke the [Synchronize version & config updates](https://github.com/elastic/docs-internal-workflows/actions/workflows/update-assembler-version.yml) action manually on `docs-internal-workflows`, which opens two configuration update PRs: `staging`and `prod`.
56
+
57
+
This action also runs on a cron job, but you can trigger it manually if needed.
58
+
41
59
:::{important}
42
-
The first version in the `mappings` list is treated as the "current" version in documentation version dropdown.
60
+
Do not merge the production PR until release day!
43
61
:::
44
62
45
-
See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for more information.
63
+
::::
64
+
65
+
::::{step} After feature freeze: merge the config change to staging
66
+
67
+
_This action must be performed by docs engineering._
2. Manually [invoke the release automation to production](https://github.com/elastic/docs-internal-workflows/actions/workflows/assembler-build.prod.yml).
83
+
3. Let the requester or docs release coordinator know the docs have been updated.
0 commit comments