Skip to content

Commit 1ba27fe

Browse files
committed
fixed incorrect steps
1 parent ccfe038 commit 1ba27fe

File tree

1 file changed

+26
-21
lines changed

1 file changed

+26
-21
lines changed

docs/contribute/release-new-version.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,24 @@ When a new version of the Elastic Stack (or another versioned product) is releas
1010

1111
Generally, each release requires the following people:
1212

13-
* A member of the **docs team** to make the config changes in a docs-builder PR
14-
* A member of the **docs engineering** or **docs tech leads** team to support publishing those changes to staging and prod.
13+
* A member of the **docs team** to perform release prep
14+
* A member of the **docs engineering** team to support publishing those changes to staging and prod.
1515

1616
Before you start your release, you should identify who from each of these teams will facilitate the release.
1717

1818
## Release process
1919

20-
Follow these steps to release a new documentation version.
20+
Follow these steps to release a new documentation version. There are two phases to releasing a new version:
2121

22-
:::{tip}
23-
The docs-builder PR steps can be bundled into a single PR.
24-
:::
22+
* **Release prep**: Prepare the relevant docs-builder changes. This can be done anytime before release day, and can be performed by any member of the docs team.
23+
* **Release day activities**: Merge your changes and push them to our staging and production environments. These steps must be performed on release day, and require support from docs engineering.
24+
25+
26+
### Release prep
27+
28+
Anytime before release day, you can prepare the release-related changes. These changes can be bundled into a single PR.
29+
30+
Do not merge these changes until release day.
2531

2632
:::::{stepper}
2733

@@ -94,40 +100,39 @@ See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for mo
94100

95101
::::
96102

103+
:::::
104+
105+
### Release day activities
106+
107+
Merge your changes and push them to our staging and production environments on release day.
108+
109+
:::::{stepper}
110+
97111
::::{step} [docs-builder PR] Merge the config change
98112

99113
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.
100114

101-
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`.
115+
Optionally, docs engineering or docs tech leads 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`.
102116

103117
This action also runs on a cron job, but can be triggered manually if the change is time-sensitive.
104-
105-
:::{important}
106-
Do not merge the production PR until release day!
107-
:::
108-
109118
::::
110119

111-
::::{step} After feature freeze: merge the config change to staging
120+
::::{step} Merge the config change to staging
112121

113-
_This action must be performed by docs engineering or docs tech leads._
122+
_This action must be performed by docs engineering._
114123

115124
1. Approve and merge [the `staging` configuration update PR](https://github.com/elastic/docs-internal-workflows/pulls).
116125
2. Optionally, manually [invoke the release automation to staging](https://github.com/elastic/docs-internal-workflows/actions/workflows/assembler-build.staging.yml).
117126

118127
This action also runs on a cron job, but can be triggered manually if the change is time-sensitive.
119128

120-
If you need to release to production right away, make sure that the workflow run is green and wait for 10 to 15 minutes for any alerts to be raised. Docs tech leads should check with docs eng before proceeding.
121-
122-
:::{important}
123-
Do not merge the production PR until release day!
124-
:::
129+
Before you merge the config change to prod in the next step, make sure that the workflow run is green and wait for 10 to 15 minutes for any alerts to be raised.
125130

126131
::::
127132

128-
::::{step} Release day: merge the config change to prod and release to production
133+
::::{step} Merge the config change to prod and release to production
129134

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

132137
1. Approve and merge [the `prod` configuration update PR](https://github.com/elastic/docs-internal-workflows/pulls).
133138
2. Manually [invoke the release automation to production](https://github.com/elastic/docs-internal-workflows/actions/workflows/assembler-build.prod.yml). Monitor it to make sure that it's green.

0 commit comments

Comments
 (0)