[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fixing DITA errors in cli/command-reference/roxctl-cluster.adoc#111778
Conversation
|
@agantony: This pull request references ROX-33164 which is a valid jira issue. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
🤖 Sat May 16 11:52:13 - Prow CI generated the docs preview: |
|
@agantony: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
PR #111778 Review GuideTitle: [RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fixing DITA errors in cli/command-reference/roxctl-cluster.adoc Issue: https://redhat.atlassian.net/browse/ROX-33164 PR: #111778 Summary of ChangesThis PR fixes DITA compatibility errors in the roxctl cluster CLI reference documentation by extracting inline assembly content and splitting the parent module with inline Usage and Options into separate modules following Red Hat modular documentation standards. Statistics
Changes by File1. cli/command-reference/roxctl-cluster.adoc (Assembly - Modified)Type: Assembly restructuring
Before (inline content in assembly): Commands related to a cluster.
.Usage
[source,terminal]
----
$ roxctl cluster [command] [flags]
----
.Available commands
[cols="2,2",options="header"]
|===
|Command |Description
|`delete` |Remove Sensor from Central.
|===
.Options
[cols="2,2",options="header"]
|===
|Option |Description
|`--retry-timeout duration` |Set the retry timeout...
|`-t`, `--timeout duration` |Set the timeout...
|===
//roxctl cluster delete
include::modules/roxctl-cluster-delete.adoc[leveloffset=+1]After (proper module includes): [role="_abstract"]
Use the `roxctl cluster` command to manage cluster operations and remove Sensors from Central.
This reference covers the command syntax, available subcommands, and configuration options.
//roxctl cluster overview
include::modules/roxctl-cluster-overview.adoc[leveloffset=+1]
include::modules/roxctl-cluster-usage.adoc[leveloffset=+2]
include::modules/roxctl-cluster-available-commands.adoc[leveloffset=+2]
include::modules/roxctl-cluster-options.adoc[leveloffset=+2]
//Options inherited from the parent command
:commandname: roxctl cluster
include::modules/options-inherited-from-the-parent-command.adoc[leveloffset=+1]
:!commandname:
//roxctl cluster delete
include::modules/roxctl-cluster-delete.adoc[leveloffset=+1]
include::modules/roxctl-cluster-delete-usage.adoc[leveloffset=+2]
include::modules/roxctl-cluster-delete-options.adoc[leveloffset=+2]2. modules/roxctl-cluster-overview.adoc (New Module - Created)Type: CONCEPT module (parent) Content:
DITA Compliance:
Leveloffset: +1 (renders as H2) 3. modules/roxctl-cluster-usage.adoc (New Module - Created)Type: REFERENCE module Content:
DITA Compliance:
Leveloffset: +2 (renders as H3 under overview) 4. modules/roxctl-cluster-available-commands.adoc (New Module - Created)Type: REFERENCE module Content:
DITA Compliance:
Leveloffset: +2 (renders as H3 under overview) 5. modules/roxctl-cluster-options.adoc (New Module - Created)Type: REFERENCE module Content:
Content improvement: Minor wording fix in
DITA Compliance:
Leveloffset: +2 (renders as H3 under overview) 6. modules/roxctl-cluster-delete.adoc (Parent Module - Modified)Type: CONCEPT module (changed from REFERENCE) Before (REFERENCE with inline content): :_mod-docs-content-type: REFERENCE
[id="roxctl-cluster-delete_{context}"]
= roxctl cluster delete
Remove Sensor from Central.
.Usage
[source,terminal]
----
$ roxctl cluster delete [flags]
----
.Options
[cols="2,2",options="header"]
|===
|Option |Description
|`--name string` |Specify the cluster name to delete.
|===After (CONCEPT with title + abstract only): :_mod-docs-content-type: CONCEPT
[id="roxctl-cluster-delete_{context}"]
= roxctl cluster delete
[role="_abstract"]
Remove Sensor from Central.Changes:
DITA Compliance:
7. modules/roxctl-cluster-delete-usage.adoc (New Module - Created)Type: REFERENCE module Content:
Leveloffset: +2 (renders as H3 under "roxctl cluster delete") 8. modules/roxctl-cluster-delete-options.adoc (New Module - Created)Type: REFERENCE module Content:
Leveloffset: +2 (renders as H3 under "roxctl cluster delete") 9. modules/options-inherited-from-the-parent-command.adoc (Shared Module - Modified)Type: REFERENCE module (shared across multiple assemblies) Line 28:
Before: = {commandname} command options inherited from the parent command
The `{commandname}` command supports the following options inherited from the parent `roxctl` command:After: = {commandname} command options inherited from the parent command
[role="_abstract"]
The `{commandname}` command supports the following options inherited from the parent `roxctl` command:Rationale: DITA requires the first paragraph after the title to be marked as the abstract/short description. Structural ChangesAssembly StructureBefore (non-modular): After (fully modular): Hierarchy:
DITA Compliance Improvements
Before:
After:
Step-by-Step Review GuideStep 1: Review the Main Assembly PageWhat to check: Assembly structure, module includes, rendering, improved abstract 📄 Preview Link: https://111778--ocpdocs-pr.netlify.app/openshift-acs/latest/cli/command-reference/roxctl-cluster.html Review checklist:
Step 2: Verify the Assembly-Level ModulesOverview Module📄 Preview Link: https://111778--ocpdocs-pr.netlify.app/openshift-acs/latest/cli/command-reference/roxctl-cluster.html#roxctl-cluster-overview_roxctl-cluster Review checklist:
Usage Module📄 Preview Link: https://111778--ocpdocs-pr.netlify.app/openshift-acs/latest/cli/command-reference/roxctl-cluster.html#roxctl-cluster-usage_roxctl-cluster Review checklist:
Available Commands ModuleReview checklist:
Assembly-Level Options Module📄 Preview Link: https://111778--ocpdocs-pr.netlify.app/openshift-acs/latest/cli/command-reference/roxctl-cluster.html#roxctl-cluster-options_roxctl-cluster Review checklist:
Step 3: Review the Parent Command Moduleroxctl cluster delete📄 Preview Link: https://111778--ocpdocs-pr.netlify.app/openshift-acs/latest/cli/command-reference/roxctl-cluster.html#roxctl-cluster-delete_roxctl-cluster Review checklist:
Usage Module:
Options Module:
Step 4: Review the Inherited Options SectionReview checklist:
Step 5: Cross-Check the Assembly Structure📄 Preview Link: https://111778--ocpdocs-pr.netlify.app/openshift-acs/latest/cli/command-reference/roxctl-cluster.html Review checklist:
Step 6: Validate DITA Compliance (Technical Review)Files to validate:
Validation steps:
Expected Rendering BehaviorBefore (Non-DITA-Compliant)
After (DITA-Compliant)
Review Priority ChecklistHigh Priority (Must Review)
Medium Priority (Should Review)
Low Priority (Nice to Review)
Approval ChecklistBefore approving this PR, confirm:
Testing & ValidationBuild Test./scripts/prow-smoke-test.sh -a openshift-acs "Red Hat Advanced Cluster Security" "4.10"DITA Validationvale --config=.vale.ini cli/command-reference/roxctl-cluster.adoc modules/roxctl-cluster-*.adocExpected result: No AsciiDocDITA errors Visual Inspection
Questions for Reviewers
Additional ContextJira Issue: ROX-33164 This PR is part of a larger DITA rework initiative following the pattern from PRs #111737, #111774-111777. The changes follow the Red Hat modular documentation pattern:
Impact: This change also improves the shared File Summary
Total: 9 files (6 new, 3 modified), +117/-44 lines Generated with AI Code Tools |
Version(s):
4.9+
Issue:
https://redhat.atlassian.net/browse/ROX-33164
Link to docs preview:
SME review: NA
Additional information:
rhacs-docs-4.10rhacs-docs-4.9