From 83da49cfa3950f5acb1e48bb5aa9943999a782cf Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 12 Jun 2024 12:28:27 -0400 Subject: [PATCH] Update release checklist to include building public docs --- docs/development/release-checklist.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/development/release-checklist.md b/docs/development/release-checklist.md index 4f6e2f25f..91162f08a 100644 --- a/docs/development/release-checklist.md +++ b/docs/development/release-checklist.md @@ -126,3 +126,13 @@ VERSION = 'v3.3.2-dev' ``` Commit this change with the comment "PRVB" (for _post-release version bump_) and push the commit upstream. + +### Update the Public Documentation + +After a release has been published, the public NetBox documentation needs to be updated. This is accomplished by running two actions on the [netboxlabs-docs](https://github.com/netboxlabs/netboxlabs-docs) repository. + +First, run the `build-site` action, by navigating to Actions > build-site > Run workflow. This process compiles the documentation along with an overlay for integration with the documentation portal at . The job should take about two minutes. + +Once the documentation files have been compiled, they must be published by running the `deploy-kinsta` action. Select the desired deployment environment (staging or production) and specify `latest` as the deploy tag. + +Finally, verify that the documentation at has been updated.