Skip to content

Commit 4530ecb

Browse files
authored
Merge pull request #26 from stackabletech/docs/update-readme
Add instructions for how to build a new platform version
2 parents cefef48 + 1834d03 commit 4530ecb

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,13 @@ The site is deployed at https://crds.stackable.tech with Netlify.
2222

2323
The `static/halfmoon-variables.css` file is from the halfmoon UI framework, v1.1.1.
2424
There was a slight modification for navbar alignment.
25+
26+
### How to add a new platform release
27+
28+
The docs are built for all the repos and branches configured in the `repos.yaml` file.
29+
so if this file is updated and merged into main, the automated Netlify build will automatically build
30+
new documentation for any changes. Instructions:
31+
32+
- Add the new {major}.{minor}.{patch} version for all `repos` as well as a `platformVersion` to the `repos.yaml` file.
33+
- Merge these changes into main.
34+
- Wait 5 minutes for the Netlify build to update the page. You can also manually run the "Trigger Netlify build hook" GitHub action to trigger a build.

0 commit comments

Comments
 (0)