Skip to content

Commit 7019ca4

Browse files
kquinn1204claude
andcommitted
TELCODOCS-2806 Fix DITA compatibility issues in DPU Operator docs
Fix AsciiDocDITA errors and warnings across the DPU Operator assembly and its included modules: add missing short description abstract, fix content type case, replace unsupported block title, use conscious language, fix grammar, and convert to proper description list format. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ab61508 commit 7019ca4

6 files changed

Lines changed: 16 additions & 13 deletions

File tree

modules/nw-dpu-configuring-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ spec:
3535
----
3636
+
3737
* `metadata.name`: Specifies the name of the Custom Resource, which must be `dpu-operator-config`.
38-
* `spec.logLevel`: Sets the desired logging verbosity in the operator container logs. The value `0` is the default setting.
38+
* `spec.logLevel`: Sets the required logging verbosity in the Operator container logs. The value `0` is the default setting.
3939
4040
. Create the resource by running the following command:
4141
+

modules/nw-dpu-creating-a-sfc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ spec:
5454
----
5555
+
5656
* `metadata.name.annotations.k8s.v1.cni.cncf.io/networks`: The value `dpunfcni-conf` specifies the name of the `NetworkAttachmentDefinition` resource. The DPU Operator creates this resource during installation to configure the DPU networking.
57-
* `spec.nodeSelector`: The `nodeSelector` is the primary mechanism for scheduling this workload. The DPU Operator creates and maintains the label: `dpu.config.openshift.io/dpuside: "dpu"`. This label ensures the pod is scheduled directly onto the DPU's processing unit.
57+
* `spec.nodeSelector`: The `nodeSelector` is the primary mechanism for scheduling this workload. The DPU Operator creates and maintains the label: `dpu.config.openshift.io/dpuside: "dpu"`. This label ensures the pod is scheduled directly onto the DPU processing unit.
5858
* `spec.containers.name`: The name of the container.
5959
* `spec.containers.image`: The container image to pull and run.
6060

modules/nw-dpu-intro-installing-operator.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
//
33
// * networking/networking_operators/installing-dpu-operator.adoc
44

5-
:_mod-docs-content-type: Concept
5+
:_mod-docs-content-type: CONCEPT
66
[id="overview-installing-dpu-operator_{context}"]
77
= Installing the DPU Operator
88

99
[role="_abstract"]
10-
You can install the Data Processing Unit (DPU) Operator on both host and DPU clusters to manage device lifecycle and network attachments using the CLI or web console.
10+
You can install the Data Processing Unit (DPU) Operator on both host and DPU clusters to manage device lifecycle and network attachments by using the CLI or web console.
1111

12-
Cluster administrators can install the DPU Operator on the host cluster and all DPU clusters using the {product-title} CLI or the web console. The DPU Operator manages the lifecycle, DPU devices, and network attachments for all supported DPUs."
12+
Cluster administrators can install the DPU Operator on the host cluster and all DPU clusters by using the {product-title} CLI or the web console. The DPU Operator manages the lifecycle, DPU devices, and network attachments for all supported DPUs.
1313

1414
[NOTE]
1515
====

modules/nw-dpu-operator-uninstall.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To uninstall the DPU Operator, you must first delete any running DPU workloads.
1818
1919
.Procedure
2020

21-
. Delete the `DpuOperatorConfig` CR that was created by running the following command
21+
. Delete the `DpuOperatorConfig` CR by running the following command:
2222
+
2323
[source,terminal]
2424
----
@@ -48,7 +48,7 @@ $ oc delete OperatorGroup dpu-operators -n openshift-dpu-operator
4848
$ oc get csv -n openshift-dpu-operator
4949
----
5050
+
51-
.Example output
51+
The following example shows the output:
5252
+
5353
[source,terminal]
5454
----

modules/nw-monitoring-dpu-status.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ worker-host-marvell-41 Ready worker 4d v1.32.9
4444
worker-host-ptl-243 Ready worker 3d23h v1.32.9
4545
----
4646
+
47-
This output shows three master nodes, and three worker nodes identified by the worker-host prefix, for example, `worker-host-ipu-219`. Each worker node contains a DPU identified by the ocpcluster-dpu prefix, for example, `ocpcluster-dpu-ipu-219`.
47+
This output shows three control plane nodes, and three worker nodes identified by the worker-host prefix, for example, `worker-host-ipu-219`. Each worker node has a DPU identified by the ocpcluster-dpu prefix, for example, `ocpcluster-dpu-ipu-219`.
4848

4949
. Run the following command to report on the status of the DPUs:
5050
+
@@ -65,10 +65,12 @@ intel-ipu-dpu Intel IPU E2100 true
6565
marvell-dpu-0000-87-00.0-host Marvell DPU false worker-host-marvell-41 True
6666
marvell-dpu-ipu Marvell DPU true worker-dpu-marvell-41 True
6767
----
68-
* `DPU PRODUCT`:Displays the vendor or type of DPU, for example, Intel or Marvell.
69-
* `DPU SIDE`:Indicates whether the DPU is operating on the host side (`false`) or the DPU side (`true`). Each physical DPU is represented twice.
70-
* `MODE NAME`:The name of the node where the DPU is located. This is the host worker node for `false` entries and the DPU node for `true` entries.
71-
* `STATUS`:Indicates whether the DPU is functioning correctly (`True`) or has issues (`False`).
68+
where:
69+
70+
`DPU PRODUCT`:: Displays the vendor or type of DPU, for example, Intel or Marvell.
71+
`DPU SIDE`:: Indicates whether the DPU is operating on the host side (`false`) or the DPU side (`true`). Each physical DPU is represented twice.
72+
`MODE NAME`:: The name of the node where the DPU is located. This is the host worker node for `false` entries and the DPU node for `true` entries.
73+
`STATUS`:: Indicates whether the DPU is functioning correctly (`True`) or has issues (`False`).
7274
+
7375
[NOTE]
7476
====

networking/networking_operators/dpu-operator/dpu-operator.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
As a cluster administrator, you can add the DPU Operator to your cluster to manage DPU devices and network attachments.
9+
[role="_abstract"]
10+
As a cluster administrator, you can add the Data Processing Unit (DPU) Operator to your cluster to manage DPU devices and network attachments.
1011

1112
--
1213
:FeatureName: The DPU Operator

0 commit comments

Comments
 (0)