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
+19-10Lines changed: 19 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,17 @@
2
2
3
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
4
5
+
## Who needs to be involved
6
+
7
+
Generally, each release requires the following people:
8
+
9
+
* A member of the **docs team** to make the config changes in a docs-builder PR
10
+
* A member of the **docs engineering** or **docs tech leads** team to support publishing those changes to staging and prod.
11
+
12
+
Before you start your release, you should identify who from each of these teams will facilitate the release.
13
+
14
+
## Release process
15
+
5
16
Follow these steps to release a new documentation version.
6
17
7
18
:::{tip}
@@ -79,15 +90,13 @@ See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for mo
79
90
80
91
::::
81
92
82
-
::::{step} [docs-builder PR] Approve and merge the config change
83
-
84
-
_This action must be performed by docs engineering._
93
+
::::{step} [docs-builder PR] Merge the config change
85
94
86
-
Merge the `versions.yml` changes and any assembler and legacy URL mapping changes.
95
+
Merge the `versions.yml` changes and any assembler and legacy URL mapping changes. Anyone from the docs team can merge the PR, but it must be approved by docs engineering or docs tech leads.
87
96
88
-
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`.
97
+
Optionally, docs engineering can 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`.
89
98
90
-
This action also runs on a cron job, but you can trigger it manually if needed.
99
+
This action also runs on a cron job, but can be triggered manually if the change is time-sensitive.
91
100
92
101
:::{important}
93
102
Do not merge the production PR until release day!
@@ -97,9 +106,9 @@ Do not merge the production PR until release day!
97
106
98
107
::::{step} After feature freeze: merge the config change to staging
99
108
100
-
_This action must be performed by docs engineering._
109
+
_This action must be performed by docs engineering or docs tech leads._
1. Approve and merge [the `prod` configuration update PR](https://github.com/elastic/docs-internal-workflows/pulls).
115
124
2. Manually [invoke the release automation to production](https://github.com/elastic/docs-internal-workflows/actions/workflows/assembler-build.prod.yml).
116
125
3. Let the requester or docs release coordinator know the docs have been updated.
0 commit comments