Skip to content

Commit 61be1e4

Browse files
Describe how to release the doc repo. (#157)
Signed-off-by: Dean Roehrich <[email protected]> Co-authored-by: Blake Devcich <[email protected]>
1 parent ff4bf7c commit 61be1e4

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/repo-guides/release-nnf-sw/readme.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,16 @@ that everything is current on `master` for `nnf-deploy`.
183183

184184
12. Follow steps 6-7 from the previous section to finalize the release of `nnf-deploy`.
185185

186-
**Please review documenation for changes you may have made**
186+
## Release `NearNodeFlash.github.io`
187+
188+
**Please review and update the documentation for changes you may have made.**
189+
190+
After nnf-deploy has a release tag, you may release the documentation. Use the same steps found above in "Release Each Component". Note that the default branch for this repo is "main" instead of "master".
191+
192+
Give this release a tag that matches the nnf-deploy release, to show that they go together. Create the release by using the "Create release" or "Draft a new release" button in the GUI, or by using the `gh release create` CLI command. Whether using the GUI or the CLI, mark the release as "latest" and select the appropriate option to generate release notes.
193+
194+
Wait for the `mike` tool in `.github/workflow/release.yaml` to finish building the new doc. You can check its status by going to the `gh-pages` branch in the repo. When you visit the release at [https://nearnodeflash.github.io](https://nearnodeflash.github.io), you should see the new release in the drop-down menu and the new release should be the default display.
195+
187196
**The software is now released!**
188197

189198
## Clone a release

0 commit comments

Comments
 (0)