Skip to content

Commit c9e680d

Browse files
authored
Improve internal docs snippet (#2059)
Updating the snippet based on the one we use for docs-content-internal.
1 parent 4df5dab commit c9e680d

File tree

1 file changed

+30
-9
lines changed

1 file changed

+30
-9
lines changed

README.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,15 +102,36 @@ jobs:
102102
To set up the tool to publish to GitHub Pages, use the following configuration.
103103
104104
```yaml
105-
environment:
106-
name: github-pages
107-
url: ${{ steps.deployment.outputs.page_url }}
108-
steps:
109-
- uses: actions/checkout@v4
110-
111-
- name: Publish Github
112-
uses: elastic/docs-builder/actions/publish@main
113-
id: deployment
105+
name: Build the docs
106+
107+
on:
108+
push:
109+
branches:
110+
- main
111+
workflow_dispatch:
112+
113+
permissions:
114+
contents: read
115+
pages: write
116+
id-token: write
117+
118+
jobs:
119+
docs:
120+
runs-on: ubuntu-latest
121+
environment:
122+
name: github-pages
123+
url: ${{ steps.deployment.outputs.page_url }}
124+
125+
steps:
126+
- name: Check out the repo
127+
uses: actions/checkout@v4
128+
129+
- name: Publish Github
130+
uses: elastic/docs-builder/actions/publish@main
131+
id: deployment
132+
with:
133+
continue-on-error: "true"
134+
private: true
114135
```
115136
116137
This single action will build and validate the documentation before publishing.

0 commit comments

Comments
 (0)