From 512c94ceb75f556a8133094d170d2119d5567161 Mon Sep 17 00:00:00 2001 From: Fred Rolland Date: Tue, 12 Mar 2024 13:57:48 +0200 Subject: [PATCH] Add linkcheck target Signed-off-by: Fred Rolland --- README.md | 21 ++++++++++++++++++--- docs/advanced-configurations.rst | 2 +- docs/customizations/helm.rst | 2 +- docs/k8s-baremetal-ethernet.rst | 10 +++++----- docs/multi-network-pod.rst | 2 +- repo.toml | 6 +++++- 6 files changed, 31 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 545eebe..2316e90 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ # NVIDIA Network Operator Documentation -Note: -For official documentation, go to: https://docs.nvidia.com/networking/software/cloud-orchestration/index.html +For official documentation, go to: -Latest documentation generated from this repo: https://mellanox.github.io/network-operator-docs/ +https://docs.nvidia.com/networking/software/cloud-orchestration/index.html + + +Latest documentation generated from this repo: + +https://mellanox.github.io/network-operator-docs/ + +## Build docs To generate the docs run: @@ -13,3 +19,12 @@ To generate the docs run: Generated files will be under `_build/docs/nvidia_network_operator/latest/` +## Check external links + +To check external links, run: + +```bash +./repo.sh docs -b linkcheck +``` + +Note that some links with anchors are reported as broken though they are working correctly. \ No newline at end of file diff --git a/docs/advanced-configurations.rst b/docs/advanced-configurations.rst index afc1aec..ec8ced0 100644 --- a/docs/advanced-configurations.rst +++ b/docs/advanced-configurations.rst @@ -96,7 +96,7 @@ HTTP Proxy Configuration for Openshift -------------------------------------- For Openshift, it is recommended to use the cluster-wide Proxy object to provide proxy information for the cluster. -Please follow the procedure described in `Configuring the Cluster-wide Proxy `_ via the Red Hat Openshift public documentation. The NVIDIA Network Operator will automatically inject proxy related ENV into the driver container, based on the information present in the cluster-wide Proxy object. +Please follow the procedure described in `Configuring the Cluster-wide Proxy `_ via the Red Hat Openshift public documentation. The NVIDIA Network Operator will automatically inject proxy related ENV into the driver container, based on the information present in the cluster-wide Proxy object. ------------------------ HTTP Proxy Configuration diff --git a/docs/customizations/helm.rst b/docs/customizations/helm.rst index 06c8056..04cf1bb 100644 --- a/docs/customizations/helm.rst +++ b/docs/customizations/helm.rst @@ -815,7 +815,7 @@ NVIDIA IPAM Plugin .. warning:: - Supported X.509 certificate management system should be available in the cluster to enable the validation webhook. Currently, the supported systems are `certmanager `_ and `Openshift certificate management `_. + Supported X.509 certificate management system should be available in the cluster to enable the validation webhook. Currently, the supported systems are `certmanager `_ and `Openshift certificate management `_. ============================ NVIDIA NIC Feature Discovery diff --git a/docs/k8s-baremetal-ethernet.rst b/docs/k8s-baremetal-ethernet.rst index 9ff04c3..fc9018c 100644 --- a/docs/k8s-baremetal-ethernet.rst +++ b/docs/k8s-baremetal-ethernet.rst @@ -43,7 +43,7 @@ Kubernetes Prerequisites Install kubernetes Version 1.18, or newer. You may use the following references to Install Kubernetes with deployment tools: - `Bootstrapping clusters with kubeadm `_ -- `Installing Kubernetes with Kubespray `_ +- `Installing Kubernetes with Kubespray `_ It is recommended to use Kubernetes Version 1.18 with the following features enabled. This will ensure the best NUMA alignment between the NIC PCI and the CPU, and better utilize SR-IOV performance: @@ -96,7 +96,7 @@ RoCE Namespace Aware Prior to Kernel Version 5.3.0, all RDMA devices were visible in all network namespaces. Kernel Version 5.3.0 or NVIDIA OFED Version 4.7 introduce network namespace isolation of RDMA devices. When the RDMA system is set to exclusive, this feature ensures that the RDMA device is bound to a particular net namespace and visible only to it. -To learn how to enable RoCE Namespace Aware by using RDMA CNI, see `here `_. +To learn how to enable RoCE Namespace Aware by using RDMA CNI, see `here `_. 1. Set the RDMA system to "exclusive". This should be done on the host preparation stage: @@ -286,7 +286,7 @@ To enable OVN Kubernetes CNI with ConnectX, see `OVN Kubernetes CNI with OVS off Antrea ------ -For Antrea CNI configuration instructions, see `Antrea CNI with OVS Offload `_. +For Antrea CNI configuration instructions, see `Antrea CNI with OVS Offload `_. ================ RoCE Shared Mode @@ -301,7 +301,7 @@ Kubernetes Prerequisite Install Kubernetes Version 1.16 or above. You may use the following references when installing Kubernetes with deployment tools: - `Bootstrapping Clusters with Kubeadm `_ -- `Installing Kubernetes with Kubespray `_ +- `Installing Kubernetes with Kubespray `_ ---------------------------------- Deploying the Shared Device Plugin @@ -329,7 +329,7 @@ Create the `rdma-shared.yaml` configMap for the shared device plugin: kubectl create -f rdma-shared.yaml kubectl create -f https://raw.githubusercontent.com/Mellanox/k8s-rdma-shared-dev-plugin/master/images/k8s-rdma-shared-dev-plugin-ds.yaml -For advanced macvlan CNI configuration see following `instructions `_. +For advanced macvlan CNI configuration see following `instructions `_. Supported IPAM (IP Address Management) operations: diff --git a/docs/multi-network-pod.rst b/docs/multi-network-pod.rst index c229552..d078ae5 100644 --- a/docs/multi-network-pod.rst +++ b/docs/multi-network-pod.rst @@ -35,7 +35,7 @@ Below is a list of well known cluster network CNI providers: * - Calico - https://github.com/projectcalico/calico * - Flannel - - https://github.com/coreos/flannel + - https://github.com/flannel-io/flannel * - Canal - https://github.com/projectcalico/canal * - ovn-kubernetes diff --git a/repo.toml b/repo.toml index 61f0ac9..5ea5d83 100644 --- a/repo.toml +++ b/repo.toml @@ -12,4 +12,8 @@ copyright_start = 2024 social_media_set = [] social_media = [] favicon = "${root}/assets/favicon.ico" -logo = "${root}/assets/nvidia-logo-white.png" \ No newline at end of file +logo = "${root}/assets/nvidia-logo-white.png" + +[repo_docs.builds.linkcheck] +build_by_default = false +output_format = "linkcheck"