docs: fix highlight box formatting for cross-platform compatibility

killianmuldoon · dpf-release · commit c71730c19e6a · 2025-08-23T07:25:19.000Z
* docs: fix highlight box formatting for cross-platform compatibility

* docs: fix highlight box formatting for cross-platform compatibility

Ensure proper rendering of note and warning blocks across both Confluence/nvdocs
and GitHub by adding required line breaks after highlight box markers and
removing trailing spaces. This prevents rendering issues that occur when
highlight boxes are not properly terminated.

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

(cherry picked from commit c350b9b7a9198522f903f662deb9c4d0b808cec0)

4f612777 docs: fix highlight box formatting for cross-platform compatibility

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

Based on release-v25.7@4298cefcad70183d68841cf164ff45d68d496098
diff --git a/docs/public/README.md b/docs/public/README.md
@@ -4,7 +4,8 @@ title: "DOCA Platform Framework"
 
 [TOC]
 
-> [!NOTE] The source for this documentation is the GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform/) under `docs/public/`.
+> [!NOTE]
+> The source for this documentation is the GitHub repo at [github.com/NVIDIA/doca-platform](https://github.com/NVIDIA/doca-platform/) under `docs/public/`.
 
 ## Introduction
 
diff --git a/docs/public/advanced-configuration/dpuservices/ovnvpc/README.md b/docs/public/advanced-configuration/dpuservices/ovnvpc/README.md
@@ -2,7 +2,8 @@
 title: "DOCA VPC OVN Service"
 ---
 
-> [!NOTE] The OVN VPC service is considered a tech preview and is not recommended for production use.
+> [!NOTE]
+> The OVN VPC service is considered a tech preview and is not recommended for production use.
 
 [TOC]
 
@@ -146,7 +147,8 @@ spec:
 ```
 </details>
 
-> [!NOTE] `ovn-nb-endpoint` should be set to an IP address through which the OVN service is accessible (e.g. the IP of a control plane node).
+> [!NOTE]
+> `ovn-nb-endpoint` should be set to an IP address through which the OVN service is accessible (e.g. the IP of a control plane node).
 
 ### DPUVPC
 
@@ -181,7 +183,8 @@ spec:
 ```
 </details>
 
-> [!NOTE] A DPU node can belong to at most one DPUVPC, as selected by the `spec.nodeSelector` field.
+> [!NOTE]
+> A DPU node can belong to at most one DPUVPC, as selected by the `spec.nodeSelector` field.
 
 ### DPUVirtualNetwork
 
@@ -237,7 +240,8 @@ A DPUServiceInterface defines a network interface for DPUs that can be used by w
 
 Supported interface types: `PF`, `VF`, `Service`.
 
-> [!NOTE] A DPUServiceInterface of type `Service` is intended for advanced use cases where a DPUService network interface needs to be connected to a virtual network. see *Advanced Use-Cases* section below
+> [!NOTE]
+> A DPUServiceInterface of type `Service` is intended for advanced use cases where a DPUService network interface needs to be connected to a virtual network. see *Advanced Use-Cases* section below
 
 <details markdown="1"><summary>Reference Example</summary>
 
@@ -686,7 +690,8 @@ The following conditions are used to indicate the status of the virtual network:
 
 #### DPUServiceInterface
 
-> [!NOTE] Due to a DPF limitation, the overall readiness of a DPUServiceInterface does not reflect the readiness of the individual ServiceInterfaces for each DPU. Refer to the ServiceInterface section below.
+> [!NOTE]
+> Due to a DPF limitation, the overall readiness of a DPUServiceInterface does not reflect the readiness of the individual ServiceInterfaces for each DPU. Refer to the ServiceInterface section below.
 
 ```yaml
 apiVersion: svc.dpu.nvidia.com/v1alpha1
diff --git a/docs/public/advanced-configuration/zero-trust-advanced-configuration.md b/docs/public/advanced-configuration/zero-trust-advanced-configuration.md
@@ -106,7 +106,8 @@ spec:
 
 Create a `DPUNode` resource for each host that has a DPU:
 
-> [!NOTE] The `.spec.dpus` field contains the names of each DPUDevice attached to the node. Currently, DPF only supports
+> [!NOTE]
+> The `.spec.dpus` field contains the names of each DPUDevice attached to the node. Currently, DPF only supports
 > setting a single DPU for each DPUNode.
 
 ```yaml
diff --git a/docs/public/developer-guides/api/dpfoperatorconfig.md b/docs/public/developer-guides/api/dpfoperatorconfig.md
@@ -16,7 +16,7 @@ them according to the configuration.
 This basic config example enables the Kamaji cluster manager and sets the PVC name of the BFB PVC which is necessary for
 the provisioning controller to download the bf-bundle.
 
-> [!NOTE]  
+> [!NOTE]
 > In the current implementation the `DPFOperatorConfig` resource is a singleton. This means that only one instance of
 > this resource can exist in the cluster. If you try to create a second instance, the controllers will not work as
 > expected.
diff --git a/docs/public/getting-started/dpf-host-trusted.md b/docs/public/getting-started/dpf-host-trusted.md
@@ -58,7 +58,6 @@ helm repo update
 ### 2. Install the DPF Operator
 
 > [!NOTE]
->
 > Ensure you have completed the [Helm Prerequisites Guide](./helm-prerequisites.md) before proceeding with the DPF
 > Operator installation.
 
diff --git a/docs/public/getting-started/dpf-zero-trust.md b/docs/public/getting-started/dpf-zero-trust.md
@@ -58,7 +58,6 @@ helm repo update
 ### 2. Install the DPF Operator
 
 > [!NOTE]
->
 > Ensure you have completed the [Helm Prerequisites Guide](./helm-prerequisites.md) before proceeding with the DPF
 > Operator installation.
 
diff --git a/docs/public/release-notes/v25.1.0.md b/docs/public/release-notes/v25.1.0.md
@@ -12,7 +12,7 @@ and orchestration of NVIDIA BlueField DPUs in Kubernetes environments.
 
 ### Fixed Issues from previous release
 
-> [!NOTE]  
+> [!NOTE]
 > Detailed information about the fixed issues can be found in the [release notes for v24.10](./v24.10.0.md).
 
 * Avoid race condition when multiple DPUDeployments depend on same objects
@@ -36,7 +36,7 @@ and orchestration of NVIDIA BlueField DPUs in Kubernetes environments.
 
 #### Hardware and Software Requirements
 
-> [!NOTE]  
+> [!NOTE]
 > Refer to [Prerequisites](../user-guides/host-trusted/prerequisites/README.md) for detailed requirements.
 
 * DPU Hardware: NVIDIA BlueField-3 DPUs
diff --git a/docs/public/release-notes/v25.1.1.md b/docs/public/release-notes/v25.1.1.md
@@ -7,7 +7,7 @@ and orchestration of NVIDIA BlueField DPUs in Kubernetes environments.
 
 ### Fixed Issues from previous release
 
-> [!NOTE]  
+> [!NOTE]
 > Detailed information about the fixed issues can be found in the [release notes for v25.1](./v25.1.0.md).
 
 ### Known issues with new workarounds
@@ -41,7 +41,7 @@ and orchestration of NVIDIA BlueField DPUs in Kubernetes environments.
 
 #### Hardware and Software Requirements
 
-> [!NOTE]  
+> [!NOTE]
 > Refer to [Prerequisites](../user-guides/host-trusted/prerequisites/README.md)  for detailed requirements.
 
 * DPU Hardware: NVIDIA BlueField-3 DPUs
diff --git a/docs/public/release-notes/v25.7.0.md b/docs/public/release-notes/v25.7.0.md
@@ -70,9 +70,7 @@ DPUs in Kubernetes environments.
 
 > [!NOTE]
 > For Host Trusted mode: Refer to [Host Trusted Prerequisites](../user-guides/host-trusted/prerequisites/system.md) for detailed requirements.
-
-
-> [!NOTE]
+> 
 > For Zero Trust mode: Refer to [Zero Turst Prerequisites](../user-guides/zero-trust/prerequisites/system.md) for detailed requirements. In addition,
 > notice
 > the [additional requirements for deploying via Redfish](../advanced-configuration/zero-trust-advanced-configuration.md).
diff --git a/docs/public/troubleshooting/dpfctl.md b/docs/public/troubleshooting/dpfctl.md
@@ -83,7 +83,7 @@ Available Commands:
 | dpuvpcs        | Describe DPF DPUVPCs and VPC related resources |
 | storage        | Describe DPF Storage resources                 |
 
-> [!NOTE]  
+> [!NOTE]
 > Available flags can be found with `dpfctl describe --help`.
 
 By default, `dpfctl describe` provides an overview of key **DPU-related resources and their conditions**.
@@ -210,7 +210,7 @@ NAME                                                                   NAMESPACE
 │ │               └─Ready                                                                   True         Success  31s
 ```
 
-> [!NOTE]  
+> [!NOTE]
 > The flag `--expand-resources` is currently supported only for `DPUServices`. Further support for other resources will
 > be added in future releases.
 
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,8 +77,9 @@ 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:
-> 1. Set `macaddress` to explicitly assign a MAC address to `br-dpu`
+> [!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
 
 ### Option 2: Set br-dpu statically
@@ -112,7 +113,8 @@ 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,7 +2,8 @@
 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)
+> [!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/hbn-ovnk/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,7 +252,8 @@ 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,7 +3,8 @@ 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)
+> [!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/hbn/README.md` for better formatting of the code.
 
 
@@ -140,7 +141,8 @@ 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,12 +2,14 @@
 title: "OVN Kubernetes"
 ---
 
-> [!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/ovnk/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!
@@ -257,7 +259,8 @@ 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,7 +3,8 @@ 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.
 
@@ -125,7 +126,8 @@ 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,7 +3,8 @@ 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.
 
@@ -177,7 +178,8 @@ 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,7 +3,8 @@ 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.
 
@@ -154,7 +155,8 @@ 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,7 +2,8 @@
 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,
@@ -182,7 +183,8 @@ 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
 
@@ -1168,6 +1170,7 @@ 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.
