Explorar o código

Update release checklist to include building public docs

Jeremy Stretch hai 1 ano
pai
achega
83da49cfa3
Modificáronse 1 ficheiros con 10 adicións e 0 borrados
  1. 10 0
      docs/development/release-checklist.md

+ 10 - 0
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 <https://netboxlabs.com/docs>. 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 <https://netboxlabs.com/docs/netbox/en/stable/> has been updated.