Skip to content

Commit 3fcca51

Browse files
Document pre documentation release step to update component versions in docs
Signed-off-by: Furkat Gofurov <[email protected]>
1 parent 4acde94 commit 3fcca51

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/release.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,15 @@ These commit messages are usually hard to understand for those that are not very
9191
9292
### Rancher Turtles Community Documentation
9393
94+
#### Update component versions in documentation
95+
96+
Before publishing a new version of the documentation, component versions used in the documentation must be updated.
97+
98+
1. Navigate to the Rancher Turtles Docs repository: [rancher/turtles-docs](https://github.com/rancher/turtles-docs)
99+
2. Go to `Actions` and start a new run of `Update Component Versions`.
100+
3. Look up the correct component versions from the [rancher/turtles](https://github.com/rancher/turtles) repository and fill them into the input fields. If any input fields are left blank, the workflow will retain the currently documented versions for those components.
101+
4. This will generate a new PR in the same repository that updates the documentation with the specified versions.
102+
94103
#### Generate changelog from Turtles release notes
95104
96105
Before publishing a new version of the documentation, a new [Changelog](https://turtles.docs.rancher.com/turtles/next/en/changelogs/index.html) must be generated to include the new release.

0 commit comments

Comments
 (0)