Skip to content

Commit 1f3a934

Browse files
committed
Syntactic sugar
1 parent b099659 commit 1f3a934

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/migration/guide/how-to-set-up-docs-previews.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ This guide will help you set up docs previews for your GitHub repository.
55
## GitHub Workflows
66

77
The docs preview system consists of three GitHub Workflows:
8-
- `docs-build.yml`: Build the docs on a PR
9-
- `docs-deploy.yml`: Deploy the docs to our preview environment
10-
- `docs-cleanup.yml`: Cleanup the docs after a PR is merged or closed
8+
- [`docs-build.yml`](#build): **Build** the docs on a PR
9+
- [`docs-deploy.yml`](#deploy): **Deploy** the docs to our preview environment
10+
- [`docs-cleanup.yml`](#cleanup): **Cleanup** the docs after a PR is merged or closed
1111

1212

1313
### Build
@@ -37,7 +37,7 @@ jobs:
3737
pull-requests: read
3838
```
3939
40-
1. The naming is important, don't change it
40+
1. The naming is important so that the `docs-deploy` workflow is triggered.
4141
2. This should be the path to your docs folder.
4242
3. Reusable workflow: [elastic/docs-builder/.github/workflows/preview-build.yml](https://github.com/elastic/docs-builder/blob/main/.github/workflows/preview-build.yml)
4343

@@ -58,7 +58,8 @@ name: docs-deploy
5858
5959
on:
6060
workflow_run:
61-
workflows: [docs-build] <1>
61+
workflows:
62+
- docs-build <1>
6263
types:
6364
- completed
6465
@@ -71,7 +72,7 @@ jobs:
7172
deployments: write
7273
actions: read
7374
```
74-
1. The name of the previous workflow.
75+
1. The name of the previously mentioned `docs-build` workflow.
7576
2. Reusable workflow: [elastic/docs-builder/.github/workflows/preview-deploy.yml](https://github.com/elastic/docs-builder/blob/main/.github/workflows/preview-deploy.yml)
7677
3. No need to read the code.
7778

0 commit comments

Comments
 (0)