[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fixing DITA errors in cli/command-reference/roxctl-sensor.adoc

cli/command-reference/roxctl-sensor.adoc

@@ -6,41 +6,17 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-Deploy {rh-rhacs-first} services in secured clusters.
+[role="_abstract"]
+Use the `roxctl sensor` command to deploy {rh-rhacs-first} services in secured clusters. This reference covers the command syntax, available subcommands, and configuration options.
 
-.Usage
-[source,terminal]
-----
-$ roxctl sensor [command] [flags]
-----
+//roxctl sensor overview
+include::modules/roxctl-sensor-overview.adoc[leveloffset=+1]
 
-.Available commands
-[cols="2,2",options="header"]
-|===
-|Command |Description
+include::modules/roxctl-sensor-usage.adoc[leveloffset=+2]
 
-|`generate`       
-|Generate files to deploy {product-title-short} services in secured clusters.
+include::modules/roxctl-sensor-available-commands.adoc[leveloffset=+2]
 
-|`generate-certs` 
-|Download a YAML file with renewed certificates for Sensor, Collector, and Admission controller.
-
-|`get-bundle`     
-|Download a bundle with the files to deploy {product-title-short} services in a cluster.
-|===
-
-
-.Options
-[cols="2,2",options="header"]
-|===
-|Option |Description
-
-|`--retry-timeout duration`
-|Set the timeout after which API requests are retried. A value of zero means that the entire request duration is waited for without retrying. The default value is `20s`.
-
-|`-t`, `--timeout duration`
-|Set the timeout for API requests representing the maximum duration of a request. The default value is `1m0s`.
-|===
+include::modules/roxctl-sensor-options.adoc[leveloffset=+2]
 
 //Options inherited from the parent command
 :commandname: roxctl sensor
@@ -50,12 +26,32 @@ include::modules/options-inherited-from-the-parent-command.adoc[leveloffset=+1]
 //roxctl sensor generate
 include::modules/roxctl-sensor-generate.adoc[leveloffset=+1]
 
+include::modules/roxctl-sensor-generate-usage.adoc[leveloffset=+2]
+
+include::modules/roxctl-sensor-generate-options.adoc[leveloffset=+2]
+
 include::modules/roxctl-sensor-generate-k8s.adoc[leveloffset=+2]
 
+include::modules/roxctl-sensor-generate-k8s-usage.adoc[leveloffset=+3]
+
+include::modules/roxctl-sensor-generate-k8s-options.adoc[leveloffset=+3]
+
 include::modules/roxctl-sensor-generate-openshift.adoc[leveloffset=+2]
 
+include::modules/roxctl-sensor-generate-openshift-usage.adoc[leveloffset=+3]
+
+include::modules/roxctl-sensor-generate-openshift-options.adoc[leveloffset=+3]
+
 //roxctl sensor get-bundle
 include::modules/roxctl-sensor-get-bundle.adoc[leveloffset=+1]
 
+include::modules/roxctl-sensor-get-bundle-usage.adoc[leveloffset=+2]
+
+include::modules/roxctl-sensor-get-bundle-options.adoc[leveloffset=+2]
+
 //roxctl sensor generate-certs
-include::modules/roxctl-sensor-generate-certs.adoc[leveloffset=+1]
+include::modules/roxctl-sensor-generate-certs.adoc[leveloffset=+1]
+
+include::modules/roxctl-sensor-generate-certs-usage.adoc[leveloffset=+2]
+
+include::modules/roxctl-sensor-generate-certs-options.adoc[leveloffset=+2]

modules/roxctl-sensor-available-commands.adoc

@@ -0,0 +1,24 @@
+// Module included in the following assemblies:
+//
+// * cli/command-reference/roxctl-sensor.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="roxctl-sensor-available-commands_{context}"]
+= Available commands
+
+[role="_abstract"]
+Available commands for the `roxctl sensor` command.
+
+[cols="2,2",options="header"]
+|===
+|Command |Description
+
+|`generate`
+|Generate files to deploy {product-title-short} services in secured clusters.
+
+|`generate-certs`
+|Download a YAML file with renewed certificates for Sensor, Collector, and Admission controller.
+
+|`get-bundle`
+|Download a bundle with the files to deploy {product-title-short} services in a cluster.
+|===

modules/roxctl-sensor-generate-certs-options.adoc

@@ -0,0 +1,19 @@
+// Module included in the following assemblies:
+//
+// * cli/command-reference/roxctl-sensor.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="roxctl-sensor-generate-certs-options_{context}"]
+= Options
+
+[role="_abstract"]
+Options for the `roxctl sensor generate-certs` command.
+
+.Options
+[cols="2,2",options="header"]
+|===
+|Option |Description
+
+|`--output-dir string`
+|Specify the output directory for the YAML file. The default value is `.` (the current working directory).
+|===

modules/roxctl-sensor-generate-certs-usage.adoc

@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * cli/command-reference/roxctl-sensor.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="roxctl-sensor-generate-certs-usage_{context}"]
+= roxctl sensor generate-certs usage
+
+[role="_abstract"]
+Usage syntax for the `roxctl sensor generate-certs` command.
+
+.Usage
+[source,terminal]
+----
+$ roxctl sensor generate-certs <cluster_details> [flags]
+----
+
+where:
+
+--
+`<cluster_details>`:: Specifies the cluster name or ID.
+--

modules/roxctl-sensor-generate-certs.adoc

@@ -1,30 +1,10 @@
 // Module included in the following assemblies:
 //
-// * command-reference/roxctl-sensor.adoc
+// * cli/command-reference/roxctl-sensor.adoc
 
-:_mod-docs-content-type: REFERENCE
+:_mod-docs-content-type: CONCEPT
 [id="roxctl-sensor-generate-certs_{context}"]
 = roxctl sensor generate-certs
 
-Download a YAML file with renewed certificates for Sensor, Collector, and Admission controller.
-
-.Usage
-[source,terminal]
-----
-$ roxctl sensor generate-certs <cluster_details> [flags]
-----
-
-where:
-
---
-`<cluster_details>`:: Specifies the cluster name or ID.
---
-
-.Options
-[cols="2,2",options="header"]
-|===
-|Option |Description
-
-|`--output-dir string`
-|Specify the output directory for the YAML file. The default value is `.`.
-|===
+[role="_abstract"]
+Download a YAML file with renewed certificates for Sensor, Collector, and Admission controller.

modules/roxctl-sensor-generate-k8s-options.adoc

@@ -0,0 +1,19 @@
+// Module included in the following assemblies:
+//
+// * cli/command-reference/roxctl-sensor.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="roxctl-sensor-generate-k8s-options_{context}"]
+= Options
+
+[role="_abstract"]
+Options for the `roxctl sensor generate k8s` command.
+
+.Options
+[cols="6,3",options="header"]
+|===
+|Option |Description
+
+|`--admission-controller-listen-on-events`
+|Enable admission controller webhook to listen to Kubernetes events. The default value is `true`.
+|===

modules/roxctl-sensor-generate-k8s-usage.adoc

@@ -0,0 +1,16 @@
+// Module included in the following assemblies:
+//
+// * cli/command-reference/roxctl-sensor.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="roxctl-sensor-generate-k8s-usage_{context}"]
+= roxctl sensor generate k8s usage
+
+[role="_abstract"]
+Usage syntax for the `roxctl sensor generate k8s` command.
+
+.Usage
+[source,terminal]
+----
+$ roxctl sensor generate k8s [flags]
+----

modules/roxctl-sensor-generate-k8s.adoc

@@ -1,24 +1,10 @@
 // Module included in the following assemblies:
 //
-// * command-reference/roxctl-sensor.adoc
+// * cli/command-reference/roxctl-sensor.adoc
 
-:_mod-docs-content-type: REFERENCE
+:_mod-docs-content-type: CONCEPT
 [id="roxctl-sensor-generate-k8s_{context}"]
 = roxctl sensor generate k8s
 
-Generate the required files to deploy {product-title-short} services in a Kubernetes cluster.
-
-.Usage
-[source,terminal]
-----
-$ roxctl sensor generate k8s [flags]
-----
-
-.Options
-[cols="6,3",options="header"]
-|===
-|Option |Description
-
-|`--admission-controller-listen-on-events`
-|Enable admission controller webhook to listen to Kubernetes events. The default value is `true`.
-|===
+[role="_abstract"]
+Generate the required files to deploy {product-title-short} services in a Kubernetes cluster.

modules/roxctl-sensor-generate-openshift-options.adoc

@@ -0,0 +1,25 @@
+// Module included in the following assemblies:
+//
+// * cli/command-reference/roxctl-sensor.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="roxctl-sensor-generate-openshift-options_{context}"]
+= Options
+
+[role="_abstract"]
+Options for the `roxctl sensor generate openshift` command.
+
+.Options
+[cols="6,3",options="header"]
+|===
+|Option |Description
+
+|`--admission-controller-listen-on-events false|true|auto[=true]`
+|Enable or disable the admission controller webhook to listen to Kubernetes events. The default value is `auto`.
+
+|`--disable-audit-logs false|true|auto[=true]`
+|Enable or disable audit log collection for runtime detection. The default value is `auto`.
+
+|`--openshift-version int`
+|Specify the {osp} major version for which you want to generate the deployment files.
+|===

modules/roxctl-sensor-generate-openshift-usage.adoc

@@ -0,0 +1,16 @@
+// Module included in the following assemblies:
+//
+// * cli/command-reference/roxctl-sensor.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="roxctl-sensor-generate-openshift-usage_{context}"]
+= roxctl sensor generate openshift usage
+
+[role="_abstract"]
+Usage syntax for the `roxctl sensor generate openshift` command.
+
+.Usage
+[source,terminal]
+----
+$ roxctl sensor generate openshift [flags]
+----

modules/roxctl-sensor-generate-openshift.adoc

@@ -1,30 +1,10 @@
 // Module included in the following assemblies:
 //
-// * command-reference/roxctl-sensor.adoc
+// * cli/command-reference/roxctl-sensor.adoc
 
-:_mod-docs-content-type: REFERENCE
+:_mod-docs-content-type: CONCEPT
 [id="roxctl-sensor-generate-openshift_{context}"]
 = roxctl sensor generate openshift
 
-Generate the required files to deploy {product-title-short} services in a {osp} cluster.
-
-.Usage
-[source,terminal]
-----
-$ roxctl sensor generate openshift [flags]
-----
-
-.Options
-[cols="6,3",options="header"]
-|===
-|Option |Description
-
-|`--admission-controller-listen-on-events false|true|auto[=true]`
-|`Enable or disable the admission controller webhook to listen to Kubernetes events`. The default value is `auto`.
-
-|`--disable-audit-logs false|true|auto[=true]`
-|Enable or disable audit log collection for runtime detection. The default value is `auto`.
-
-|`--openshift-version int`
-|Specify the {osp} major version for which you want to generate the deployment files.
-|===
+[role="_abstract"]
+Generate the required files to deploy {product-title-short} services in a {osp} cluster.