Skip to content

Commit 098efc2

Browse files
committed
jan feedback
1 parent 99a1bc2 commit 098efc2

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

docs/contribute/release-new-version.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
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.
44

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+
516
Follow these steps to release a new documentation version.
617

718
:::{tip}
@@ -79,15 +90,13 @@ See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for mo
7990

8091
::::
8192

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
8594

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.
8796

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`.
8998

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.
91100

92101
:::{important}
93102
Do not merge the production PR until release day!
@@ -97,9 +106,9 @@ Do not merge the production PR until release day!
97106

98107
::::{step} After feature freeze: merge the config change to staging
99108

100-
_This action must be performed by docs engineering._
109+
_This action must be performed by docs engineering or docs tech leads._
101110

102-
Merge [the `staging` configuration update PR](https://github.com/elastic/docs-internal-workflows/pulls).
111+
Approve and merge [the `staging` configuration update PR](https://github.com/elastic/docs-internal-workflows/pulls).
103112

104113
:::{important}
105114
Do not merge the production PR until release day!
@@ -109,9 +118,9 @@ Do not merge the production PR until release day!
109118

110119
::::{step} Release day: merge the config change to prod and release to production
111120

112-
_This action must be performed by docs engineering. For most products, this change must be merged on release day._
121+
_This action must be performed by docs engineering or docs tech leads. For most products, this change must be merged on release day._
113122

114-
1. Merge [the `prod` configuration update PR](https://github.com/elastic/docs-internal-workflows/pulls).
123+
1. Approve and merge [the `prod` configuration update PR](https://github.com/elastic/docs-internal-workflows/pulls).
115124
2. Manually [invoke the release automation to production](https://github.com/elastic/docs-internal-workflows/actions/workflows/assembler-build.prod.yml).
116125
3. Let the requester or docs release coordinator know the docs have been updated.
117126

0 commit comments

Comments
 (0)