@@ -8,7 +8,7 @@ The product documentation portal can be found at: https://docs.nvidia.com/datace
88## Building the Container
99
1010This step is optional if your only goal is to build the documentation.
11- As an alternative to building the container, you can run ` docker pull ghcr.io/nvidia/cloud-native-docs:4 ` .
11+ As an alternative to building the container, you can run ` docker pull ghcr.io/nvidia/cloud-native-docs:0.5.1 ` .
1212
1313Refer to < https://gitlab.com/nvidia/cloud-native/cnt-docs/container_registry > to find the most recent tag.
1414
@@ -55,7 +55,7 @@ The resulting HTML pages are located in the `_build/docs/.../latest/` directory
5555More information about the ` repo docs ` command is available from
5656< http://omniverse-docs.s3-website-us-east-1.amazonaws.com/repo_docs/0.20.3/index.html > .
5757
58- Also, the Github CI for this project builds the documentation on every merge into the default branch (` main ` ).
58+ The GitHub CI for this project builds the documentation on every merge into the default branch (` main ` ).
5959The documentation from the current default branch (` main ` ) is available at < https://docs.nvidia.com/datacenter/cloud-native/ > .
6060Documentation in the default branch is under development and unstable.
6161
@@ -156,7 +156,7 @@ Only tags are published to docs.nvidia.com.
156156 The first three fields of the semantic version are used.
157157 For a "do over," push a tag like ` gpu-operator-v23.3.1-1 ` .
158158
159- Always tag the openshift docset and for each new gpu-operator docset release.
159+ Always tag the openshift docset for each new gpu-operator docset release.
160160
1611611 . Push the tag to the repository.
162162
@@ -178,7 +178,7 @@ If the commit message includes `/not-latest`, then only the documentation in the
178178
1791791 . Update ` .github/workflows/docs-build.yaml ` and increment the ` env.TAG ` value.
180180
181- 1 . Update ` .gitlab-ci.yml ` and set the same value-- prefixed by ` ghcr.io... ` -- in the ` variables.BUILDER_IMAGE ` field.
181+ 1 . Update ` .gitlab-ci.yml ` and set the same value ( prefixed by ` ghcr.io... ` ) in the ` variables.BUILDER_IMAGE ` field.
182182
1831831 . Optional: [ Build the container and docs] ( #building-the-container ) locally and confirm the update works as intended.
184184
@@ -190,7 +190,7 @@ If the commit message includes `/not-latest`, then only the documentation in the
1901901 . After you merge the pull request, the ` docs-build.yaml ` action detects that the newly incremented ` env.TAG `
191191 container is not in the registry, builds the container with that tag and pushes it to the GitHub registry.
192192
193- When you tag a commit to publish, Github CI pulls image from the ` variables.BUILDER_IMAGE ` value,
193+ When you tag a commit to publish, GitHub CI pulls image from the ` variables.BUILDER_IMAGE ` value,
194194 builds the documentation, and that HTML is delivered to docs.nvidia.com.
195195
196196## License and Contributing
0 commit comments