docs: update all notes and warnings and fix lists

tobiasgiese · dpf-release · commit e7493362b970 · 2025-08-22T07:25:42.000Z
* docs: update all notes and warnings and fix lists

* docs: update all notes and warnings and fix lists

Update rendered docs to be ready for nvdocs.

Signed-off-by: Tobias Giese &lt;tgiese@nvidia.com&gt;

(cherry picked from commit 809c526aff946b58bbea0d80c7c1754758e347b5)

98de087f docs: update all notes and warnings and fix lists

Co-authored-by: Tobias Giese &lt;tgiese@nvidia.com&gt;

Based on release-v25.7@61c6b942ed13d90bc11d0ba206a161926e54a987
diff --git a/docs/public/user-guides/host-trusted/prerequisites/host-network-configuration-prerequisite.md b/docs/public/user-guides/host-trusted/prerequisites/host-network-configuration-prerequisite.md
@@ -77,9 +77,7 @@ network:
         route-metric: 5
   version: 2
 ```
-> Note:
-> 
-> Please ensure that the configuration on `br-dpu` matches the configuration on your DHCP server. You may need additional configurations to make the DHCP procedure work. For example:
+> [!NOTE] Please ensure that the configuration on `br-dpu` matches the configuration on your DHCP server. You may need additional configurations to make the DHCP procedure work. For example:
 > 1. Set `macaddress` to explicitly assign a MAC address to `br-dpu`
 > 2. Set `dhcp-identifier: mac` to use MAC address as the DHCP client identifier
 
@@ -114,9 +112,7 @@ network:
           - "xxx"
   version: 2
 ```
-> Note:
-> 
-> The metric of the default route must be at least 2
+> [!NOTE] The metric of the default route must be at least 2
 
 
 ## Host Routes and network acceleration
diff --git a/docs/public/user-guides/host-trusted/use-cases/hbn-ovnk/README.md b/docs/public/user-guides/host-trusted/use-cases/hbn-ovnk/README.md
@@ -2,8 +2,7 @@
 title: "OVN Kubernetes with Host Based Networking"
 ---
 
-> Note:
-> Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform) and moving to the `docs/public/user-guides/hbn_ovn/README.md` for better formatting of the code.
+> [!NOTE] Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform) and moving to the `docs/public/user-guides/hbn_ovn/README.md` for better formatting of the code.
 
 In this configuration OVN Kubernetes is offloaded to the DPU and combined with [NVIDIA Host Based Networking (HBN)](https://docs.nvidia.com/doca/sdk/doca+hbn+service+guide/index.html).
 
@@ -251,9 +250,7 @@ spec:
 
 Before deploying the DPF Operator, ensure that Helm is properly configured according to the [Helm prerequisites](../../../../getting-started/helm-prerequisites.md).  
 
-> [!WARNING]
->
-> This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
+> [!WARNING] This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
 
 After applying the additional dependencies you MUST ensure that the KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT
 environment variables are set in the node-feature-discovery-worker DaemonSet.  
diff --git a/docs/public/user-guides/host-trusted/use-cases/hbn/README.md b/docs/public/user-guides/host-trusted/use-cases/hbn/README.md
@@ -3,8 +3,7 @@ title: "Host Based Networking"
 ---
 
 
-> Note:
-> Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform) and moving to the `docs/public/user-guides/hbn_only/README.md` for better formatting of the code.
+> [!NOTE] Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform) and moving to the `docs/public/user-guides/hbn_only/README.md` for better formatting of the code.
 
 
 In this configuration [NVIDIA Host Based Networking (HBN)](https://docs.nvidia.com/doca/sdk/doca+hbn+service+guide/index.html) is installed as a DPUService.
@@ -140,9 +139,7 @@ spec:
 
 Before deploying the DPF Operator, ensure that Helm is properly configured according to the [Helm prerequisites](../../../../getting-started/helm-prerequisites.md).
 
-> [!WARNING]
-> 
-> This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
+> [!WARNING] This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
 
 #### Deploy the DPF Operator
 
diff --git a/docs/public/user-guides/host-trusted/use-cases/ovnk/README.md b/docs/public/user-guides/host-trusted/use-cases/ovnk/README.md
@@ -2,14 +2,11 @@
 title: "OVN Kubernetes"
 ---
 
-> Note:
-> Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform) and moving to the `docs/public/user-guides/ovn_only/README.md` for better formatting of the code.
+> [!NOTE] Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform) and moving to the `docs/public/user-guides/ovn_only/README.md` for better formatting of the code.
 
 In this configuration OVN Kubernetes is offloaded to the DPU.
 
-> [!WARNING]  
->
-> Due to several known issues regarding the stability of this specific deployment 
+> [!WARNING] Due to several known issues regarding the stability of this specific deployment 
 > use-case (OVN Kubernetes), it should be considered a proof-of-concept in this release.  
 >
 > Please use it at your own risk!
@@ -259,9 +256,7 @@ spec:
 
 Before deploying the DPF Operator, ensure that Helm is properly configured according to the [Helm prerequisites](../../../../getting-started/helm-prerequisites.md).  
 
-> [!WARNING]
->
-> This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
+> [!WARNING] This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
 
 After applying the additional dependencies you MUST ensure that the KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT
 environment variables are set in the node-feature-discovery-worker DaemonSet.  
diff --git a/docs/public/user-guides/host-trusted/use-cases/passthrough/README.md b/docs/public/user-guides/host-trusted/use-cases/passthrough/README.md
@@ -3,8 +3,7 @@ title: "DPU Passthrough in DPF Host Trusted"
 ---
 
 
-> Note:
-> Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform)
+> [!NOTE] Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform)
 > and moving to the `docs/public/user-guides/host-trusted/use-cases/passthrough/README.md` for better
 > formatting of the code.
 
@@ -126,9 +125,7 @@ spec:
 Before deploying the DPF Operator, ensure that Helm is properly configured according
 to the [Helm prerequisites](../../../../getting-started/helm-prerequisites.md).
 
-> [!WARNING]
->
-> This is a critical prerequisite step that must be completed for the DPF Operator
+> [!WARNING] This is a critical prerequisite step that must be completed for the DPF Operator
 > to function properly.
 
 #### Deploy the DPF Operator
diff --git a/docs/public/user-guides/zero-trust/use-cases/hbn/README.md b/docs/public/user-guides/zero-trust/use-cases/hbn/README.md
@@ -3,8 +3,7 @@ title: "HBN in DPF Zero Trust"
 ---
 
 
-> Note:
-> Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform)
+> [!NOTE] Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform)
 > and moving to the `docs/public/user-guides/zero-trust/use-cases/hbn/README.md` for better formatting of
 > the code.
 
@@ -178,9 +177,7 @@ kubectl create secret generic -n dpf-operator-system bmc-shared-password --from-
 Before deploying the DPF Operator, ensure that Helm is properly configured according to the
 [Helm prerequisites](../../../../getting-started/helm-prerequisites.md).
 
-> [!WARNING]
->
-> This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
+> [!WARNING] This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
 
 #### Deploy the DPF Operator
 
diff --git a/docs/public/user-guides/zero-trust/use-cases/passthrough/README.md b/docs/public/user-guides/zero-trust/use-cases/passthrough/README.md
@@ -3,8 +3,7 @@ title: "DPU Passthrough in DPF Zero Trust"
 ---
 
 
-> Note:
-> Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform)
+> [!NOTE] Follow this guide from the source GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform)
 > and moving to the `docs/public/user-guides/zero-trust/use-cases/passthrough/README.md` for better formatting of
 > the code.
 
@@ -155,9 +154,7 @@ kubectl create secret generic -n dpf-operator-system bmc-shared-password --from-
 Before deploying the DPF Operator, ensure that Helm is properly configured according to the
 [Helm prerequisites](../../../../getting-started/helm-prerequisites.md).
 
-> [!WARNING]
->
-> This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
+> [!WARNING] This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
 
 #### Deploy the DPF Operator
 
diff --git a/docs/public/user-guides/zero-trust/use-cases/vpc/README.md b/docs/public/user-guides/zero-trust/use-cases/vpc/README.md
@@ -2,9 +2,7 @@
 title: "OVN VPC Service Deployment Guide"
 ---
 
-> [!NOTE]  
->
-> OVN VPC service is considered tech preview and is not recommended for
+> [!NOTE] OVN VPC service is considered tech preview and is not recommended for
 > production use.
 
 This configuration provides instructions for deploying the NVIDIA DOCA Platform Framework (DPF) on high-performance,
@@ -184,9 +182,7 @@ kubectl create secret generic -n dpf-operator-system bmc-shared-password --from-
 Before deploying the DPF Operator, ensure that Helm is properly configured according to the
 [Helm prerequisites](../../../../getting-started/helm-prerequisites.md).
 
-> [!WARNING]
->
-> This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
+> [!WARNING] This is a critical prerequisite step that must be completed for the DPF Operator to function properly.
 
 #### Deploy the DPF Operator
 
@@ -760,27 +756,27 @@ administrator depending on the infrastructure.
 
 The following verification commands may need to be run multiple times to ensure the condition is met.
 
-1. Wait for DPU `OSInstalled` condition to become `ready`
+**1.** Wait for DPU `OSInstalled` condition to become `ready`
 
 ```shell
 kubectl wait --for=condition=OSInstalled --namespace dpf-operator-system dpu --all
 ```
 
-2. Ensure `Rebooted` condition type has `reason=WaitingForManualPowerCycleOrReboot`
+**2.** Ensure `Rebooted` condition type has `reason=WaitingForManualPowerCycleOrReboot`
 
 ```shell
 kubectl wait --namespace dpf-operator-system dpu --all --for=jsonpath='{.status.conditions[?(@.type=="Rebooted")].reason}'=WaitingForManualPowerCycleOrReboot
 ```
 
-3. Power cycle DPU worker hosts - manual operation by the user
+**3.** Power cycle DPU worker hosts - manual operation by the user
 
-4. Once all nodes have rebooted, remove `provisioning.dpu.nvidia.com/dpunode-external-reboot-required` annotation from `DPUNodes`
+**4.** Once all nodes have rebooted, remove `provisioning.dpu.nvidia.com/dpunode-external-reboot-required` annotation from `DPUNodes`
 
 ```shell
 kubectl -n dpf-operator-system annotate dpunode --all provisioning.dpu.nvidia.com/dpunode-external-reboot-required-
 ```
 
-5. Ensure `DPUs` are ready
+**5.** Ensure `DPUs` are ready
 
 ```shell
 kubectl wait --for=condition=ready --namespace dpf-operator-system dpus --all
@@ -1172,7 +1168,6 @@ kubectl -n dpf-operator-system delete pvc bfb-pvc
 kubectl delete pv bfb-pv
 ```
 
-> [!NOTE]  
-> There can be a race condition with deleting the underlying Kamaji cluster which runs the DPU cluster control
+> [!NOTE]   There can be a race condition with deleting the underlying Kamaji cluster which runs the DPU cluster control
 > plane in this guide. If that happens it may be necessary to remove finalizers manually from `DPUCluster` and `Datastore`
 > objects.
