diff --git a/.github/workflows/docs-build-pr.yaml b/.github/workflows/docs-build-pr.yaml index faf265e1e..afb6d4def 100644 --- a/.github/workflows/docs-build-pr.yaml +++ b/.github/workflows/docs-build-pr.yaml @@ -2,7 +2,7 @@ name: docs-build-pr on: pull_request: - branches: [ main ] + branches: [ main, release-* ] types: [ opened, synchronize ] env: diff --git a/.github/workflows/docs-build.yaml b/.github/workflows/docs-build.yaml index 3cabdaa50..8bed223da 100644 --- a/.github/workflows/docs-build.yaml +++ b/.github/workflows/docs-build.yaml @@ -10,7 +10,7 @@ on: env: REGISTRY: ghcr.io IMAGE_NAME: ${{ github.repository }} - TAG: 0.5.0 + TAG: 0.5.1 GH_TOKEN: ${{ github.token }} concurrency: diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 630d73bff..fa2993909 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,7 +1,7 @@ variables: CONTAINER_TEST_IMAGE: "${CI_REGISTRY_IMAGE}:${CI_COMMIT_REF_SLUG}" - CONTAINER_RELEASE_IMAGE: "${CI_REGISTRY_IMAGE}:0.5.0" - BUILDER_IMAGE: ghcr.io/nvidia/cloud-native-docs:0.5.0 + CONTAINER_RELEASE_IMAGE: "${CI_REGISTRY_IMAGE}:0.5.1" + BUILDER_IMAGE: ghcr.io/nvidia/cloud-native-docs:0.5.1 PUBLISHER_IMAGE: "${CI_REGISTRY_PUBLISHER}/publisher:3.1.0" stages: diff --git a/README.md b/README.md index b16cd2ec8..89ab57086 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ Use the `Dockerfile` in the repository (under the `docker` directory) to generat 1. Build the docs: + Use the alias `build-docs` or the full command: + ```bash ./repo docs ``` @@ -49,6 +51,8 @@ Use the `Dockerfile` in the repository (under the `docker` directory) to generat The resulting HTML pages are located in the `_build/docs/.../latest/` directory of your repository clone. +If you are using WSL on Windows, the URL looks like . + More information about the `repo docs` command is available from . @@ -136,6 +140,20 @@ Always update the openshift docset when there is a new gpu-operator docset versi The documentation for the older releases is not removed, readers are just less likely to browse the older releases. + GPU Operator has changed to minor-only version branches. + Consequently, patch releases are documented within the same branch for that minor version. + In the `/versions1.json` file, you can use just the first two fields of the semantic version. + For example: + + ```bash + { + "url": "../25.10", + "version": "25.10" + }, + ``` + + The three most-recent minor are supported. + ### Tagging for Publication Changes to the default branch are not published on docs.nvidia.com. @@ -147,11 +165,21 @@ Only tags are published to docs.nvidia.com. *Example* ```text - gpu-operator-v23.3.1 + container-toolkit-v1.17.8 ``` The first three fields of the semantic version are used. - For a "do over," push a tag like `gpu-operator-v23.3.1-1`. + For a "do over," push a tag like `container-toolkit-v1.17.8-1`. + + For GPU Operator, use only the first two fields of the semantic version. + + *Example* + + ```text + gpu-operator-v25.10 + ``` + + For a "do over," push a tag like `gpu-operator-v25.10-2`. Always tag the openshift docset and for each new gpu-operator docset release. diff --git a/css/custom.css b/css/custom.css index 7d075cce1..207757d00 100644 --- a/css/custom.css +++ b/css/custom.css @@ -4,4 +4,23 @@ */ html[data-theme=light] .highlight .go { font-style:unset -} \ No newline at end of file +} + +.bd-page-width { + max-width: 176rem; + } + + .bd-main { + flex: 1 1 auto; + } + + .bd-main .bd-content .bd-article-container { + max-width: 100%; + } + + .bd-sidebar-secondary { + /* flex: 0 0 auto; */ + flex-basis: 15%; + min-width: var(--pst-sidebar-secondary); + } + \ No newline at end of file diff --git a/docker/Dockerfile b/docker/Dockerfile index 547de0e73..e15da489e 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -21,7 +21,10 @@ RUN --mount=type=bind,source=.,destination=/x,rw /x/tools/packman/python.sh -m p -t /tmp/extension \ sphinx-copybutton \ nvidia-sphinx-theme \ - pydata-sphinx-theme + pydata-sphinx-theme \ + linuxdoc RUN (cd /tmp/extension; tar cf - . ) | (cd /var/tmp/packman/chk/sphinx/4.5.0.2-py3.7-linux-x86_64/; tar xf -) RUN rm -rf /tmp/extension + +RUN --mount=type=bind,target=/work echo 'alias build-docs="./repo docs"' >> ~/.bashrc diff --git a/gpu-operator/life-cycle-policy.rst b/gpu-operator/life-cycle-policy.rst index e00c4965d..ef9bace97 100644 --- a/gpu-operator/life-cycle-policy.rst +++ b/gpu-operator/life-cycle-policy.rst @@ -47,7 +47,7 @@ The product life cycle and versioning are subject to change in the future. .. note:: - - Upgrades are only supported within a major release or to the next major release. + Upgrades are only supported within a major release or to the next major release. .. list-table:: Support Status for Releases :header-rows: 1 @@ -81,17 +81,31 @@ The following table shows the operands and default operand versions that corresp When post-release testing confirms support for newer versions of operands, these updates are identified as *recommended updates* to a GPU Operator version. Refer to :ref:`Upgrading the NVIDIA GPU Operator` for more information. -.. list-table:: - :header-rows: 1 +**D** = Default driver, **R** = Recommended driver + +.. flat-table:: + :header-rows: 2 - * - Component - - Version + * - :rspan:`1` Component + - :cspan:`4` GPU Operator Version - * - NVIDIA GPU Operator - - ${version} + * - v25.3.4 + - v25.3.3 + - v25.3.2 + - v25.3.1 + - v25.3.0 * - NVIDIA GPU Driver |ki|_ - - | `580.82.07 `_ (default, recommended) + - | `580.82.07 `_ (**D**, **R**) + | `580.65.06 `_ + | `575.57.08 `_ + | `570.172.08 `_ + | `570.158.01 `_ + | `570.148.08 `_ + | `535.261.03 `_ + | `550.163.01 `_ + | `535.247.01 `_ + - | `580.82.07 `_ (**D**, **R**) | `580.65.06 `_ | `575.57.08 `_ | `570.172.08 `_ @@ -100,53 +114,100 @@ Refer to :ref:`Upgrading the NVIDIA GPU Operator` for more information. | `535.261.03 `_ | `550.163.01 `_ | `535.247.01 `_ + - | `580.65.06 `_ (**R**) + | `575.57.08 `_ + | `570.172.08 `_ (**D**) + | `570.158.01 `_ + | `570.148.08 `_ + | `535.261.03 `_ + | `550.163.01 `_ + | `535.247.01 `_ + - | `580.65.06 `_ (**R**) + | `575.57.08 `_ + | `570.172.08 `_ (**D**) + | `570.158.01 `_ + | `570.148.08 `_ + | `535.261.03 `_ + | `550.163.01 `_ + | `535.247.01 `_ + - | `580.65.06 `_ (**R**) + | `575.57.08 `_ + | `570.172.08 `_ (**D**) + | `570.158.01 `_ + | `570.148.08 `_ + | `550.163.01 `_ + | `535.261.03 `_ + | `535.247.01 `_ * - NVIDIA Driver Manager for Kubernetes - - `v0.8.1 `__ + - :cspan:`1` `v0.8.1 `__ + - :cspan:`2` `v0.8.0 `__ * - NVIDIA Container Toolkit - - `1.17.8 `__ + - :cspan:`3` `1.17.8 `__ + - `1.17.5 `__ * - NVIDIA Kubernetes Device Plugin - - `0.17.4 `__ + - :cspan:`1` `0.17.4 `__ + - `0.17.3 `__ + - `0.17.2 `__ + - `0.17.1 `__ * - DCGM Exporter - - `4.3.1-4.4.0 `__ + - :cspan:`1` `4.3.1-4.4.0 `__ + - :cspan:`1` `4.2.3-4.1.3 `__ + - `4.1.1-4.0.4 `__ * - Node Feature Discovery - - `v0.17.3 `__ + - :cspan:`3` `v0.17.3 `__ + - `v0.17.2 `__ * - | NVIDIA GPU Feature Discovery | for Kubernetes - - `0.17.4 `__ + - :cspan:`1` `0.17.4 `__ + - `0.17.3 `__ + - `0.17.3 `__ + - `0.17.1 `__ * - NVIDIA MIG Manager for Kubernetes - - `0.12.3 `__ + - :cspan:`1` `0.12.3 `__ + - `0.12.2 `__ + - :cspan:`1` `0.12.1 `__ * - DCGM - - `4.3.1 `__ + - :cspan:`1` `4.3.1 `__ + - :cspan:`1` `4.2.3 `__ + - `4.1.1-2 `__ * - Validator for NVIDIA GPU Operator - - ${version} + - v25.3.4 + - v25.3.3 + - v25.3.2 + - v25.3.1 + - v25.3.0 * - NVIDIA KubeVirt GPU Device Plugin - - `v1.4.0 `__ + - :cspan:`1` `v1.4.0 `__ + - :cspan:`2` `v1.3.1 `__ * - NVIDIA vGPU Device Manager - - `v0.4.0 `__ + - :cspan:`1` `v0.4.0 `__ + - :cspan:`2` `v0.3.0 `__ * - NVIDIA GDS Driver |gds|_ - - `2.20.5 `__ + - :cspan:`4` `2.20.5 `__ * - NVIDIA Kata Manager for Kubernetes - - `v0.2.3 `__ + - :cspan:`4` `v0.2.3 `__ * - | NVIDIA Confidential Computing | Manager for Kubernetes - - v0.1.1 + - :cspan:`4` v0.1.1 * - NVIDIA GDRCopy Driver - - `v2.5.1 `__ + - :cspan:`1` `v2.5.1 `__ + - :cspan:`1` `v2.5.0 `__ + - `v2.4.4 `__ .. _known-issue: diff --git a/repo.toml b/repo.toml index 483f6f9f4..7f9ed0afa 100644 --- a/repo.toml +++ b/repo.toml @@ -28,6 +28,7 @@ sphinx_conf_py_extra = """ ] templates_path = ['${root}/templates'] extensions.extend([ + "linuxdoc.rstFlatTable", "sphinx.ext.autosectionlabel", "sphinx_copybutton", ]) @@ -167,7 +168,7 @@ docs_root = "${root}/gpu-operator" project = "gpu-operator" name = "NVIDIA GPU Operator" version = "25.3" -source_substitutions = { version = "v25.3.4", recommended = "580.82.07" } +source_substitutions = { minor_version = "25.3", version = "v25.3.4", recommended = "580.82.07" } copyright_start = 2020 sphinx_exclude_patterns = [ "life-cycle-policy.rst",