Skip to content

Commit 99a1bc2

Browse files
committed
missing assembler step
1 parent 51bddee commit 99a1bc2

File tree

2 files changed

+43
-9
lines changed

2 files changed

+43
-9
lines changed

docs/contribute/branching-strategy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ After it has been established that a repository should publish from a version br
4646
* Otherwise, keeping it set to `main` is also an option since this is where the content is initially developed and merged. This is the default.
4747
4. In the assembler PR, add the `ci` label. After CI runs, confirm that the intended version branches are publishing to the link service. When links are being published as intended, they can be found at the following URL, where `repo` is your repo name and `branch` is your newly configured branch:
4848

49-
```text
50-
elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/<repo>/<branch>/links.json
51-
```
49+
```text
50+
elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/<repo>/<branch>/links.json
51+
```
5252
5. Rerun the `validate-assembler` check on the PR.
5353
6. After checks pass and the docs engineering team approves, you can merge the PR.
5454

docs/contribute/release-new-version.md

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@ When a new version of the Elastic Stack (or another versioned product) is releas
44

55
Follow these steps to release a new documentation version.
66

7-
:::::{stepper}
7+
:::{tip}
8+
The docs-builder PR steps can be bundled into a single PR.
9+
:::
10+
11+
:::::{stepper}
812

9-
::::{step} Update `versions.yml`
13+
::::{step} [docs-builder PR] Update `versions.yml`
1014

1115
_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._
1216

@@ -24,11 +28,40 @@ versioning_systems:
2428
- Update the `current` version to reflect the newly released version.
2529
- Only update the `base` version if you're dropping support for an older version.
2630

27-
Refer to [`versions.yml`](../configure/site/versions.md) for more information.
31+
Refer to [`versions.yml`](/configure/site/versions.md) for more information.
32+
33+
::::
34+
35+
::::{step} [docs-builder PR] (Optional) Bump the version branch
36+
_This action can be performed by any member of the docs team._
37+
38+
If you use the [tagged branching strategy](/contribute/branching-strategy.md), and your release corresponds with a new branch in the repository that holds your documentation, then you also need to bump the `current` and `next` branch in the docs configuration.
39+
40+
This step is not always required, depending on your branching strategy. For example, if you only have branches for major versions of your product (e.g. 1 and 2), and you're already publishing your docs from the `1` branch, then you don't need to bump the version branch to release version 1.2 or 1.2.3 of your documentation.
41+
42+
1. In `assembler.yml`, specifying the new `current` and `next` branches for your repository:
43+
44+
```yml
45+
your-product:
46+
current: 1.1
47+
next: 1.2
48+
```
49+
50+
Some people use `main` or `master` for their `next` branch. In this case, the `next` value doesn't need to be changed.
51+
52+
2. Tag the PR with the `ci` label. After CI runs, confirm that the intended version branches are publishing to the link service. When links are being published as intended, they can be found at the following URL, where repo is your repo name and branch is your newly configured branch:
53+
54+
```
55+
elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/<repo>/<branch>/links.json
56+
```
57+
58+
3. Rerun the `validate-assembler` check on the PR.
59+
2860

61+
[Learn more about changing the published branch](/contribute/branching-strategy.md#how-to-change-the-published-branch).
2962
::::
3063

31-
::::{step} (Optional) Update legacy URL mappings
64+
::::{step} [docs-builder PR] (Optional) Update legacy URL mappings
3265

3366
_This action can be performed by any member of the docs team._
3467

@@ -46,11 +79,11 @@ See [`legacy-url-mappings.yml`](../configure/site/legacy-url-mappings.md) for mo
4679

4780
::::
4881

49-
::::{step} Approve and merge the config change
82+
::::{step} [docs-builder PR] Approve and merge the config change
5083

5184
_This action must be performed by docs engineering._
5285

53-
Merge the `versions.yml` changes and any legacy URL mapping changes.
86+
Merge the `versions.yml` changes and any assembler and legacy URL mapping changes.
5487

5588
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`.
5689

@@ -91,3 +124,4 @@ Cumulative documentation relies on version metadata through `applies_to` blocks,
91124
Check the built output to ensure `applies_to` changes are correctly rendering.
92125

93126
::::
127+
:::::

0 commit comments

Comments
 (0)