Skip to content

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

Merged
agantony merged 1 commit into
openshift:rhacs-docs-mainfrom
agantony:ROX33164-dita-rework-installing-roxctl-netpol
Jul 20, 2026
Merged

[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fixing DITA errors in cli/command-reference/roxctl-netpol.adoc#111782
agantony merged 1 commit into
openshift:rhacs-docs-mainfrom
agantony:ROX33164-dita-rework-installing-roxctl-netpol

Conversation

@agantony

Copy link
Copy Markdown
Contributor

Version(s):
4.9+

Issue:
https://redhat.atlassian.net/browse/ROX-33164

Link to docs preview:

SME review: NA

Additional information:

  • Cherrypick to:
    • rhacs-docs-4.10
    • rhacs-docs-4.9

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 18, 2026
@openshift-ci-robot

openshift-ci-robot commented May 18, 2026

Copy link
Copy Markdown

@agantony: This pull request references ROX-33164 which is a valid jira issue.

Details

In response to this:

Version(s):
4.9+

Issue:
https://redhat.atlassian.net/browse/ROX-33164

Link to docs preview:

SME review: NA

Additional information:

  • Cherrypick to:
    • rhacs-docs-4.10
    • rhacs-docs-4.9

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.

@agantony agantony self-assigned this May 18, 2026
@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 18, 2026
@agantony agantony added RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.9 rhacs-docs-4.10 and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 18, 2026
@ocpdocs-previewbot

Copy link
Copy Markdown

🤖 Mon May 18 08:33:37 - Prow CI generated the docs preview:
https://111782--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@openshift-ci

openshift-ci Bot commented May 18, 2026

Copy link
Copy Markdown

@agantony: all tests passed!

Full PR test history. Your PR dashboard.

Details

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 kubernetes-sigs/prow repository. I understand the commands that are listed here.

@agantony agantony removed their assignment May 18, 2026
@agantony

agantony commented May 18, 2026

Copy link
Copy Markdown
Contributor Author

📋 PR Summary

Type: DITA Modular Refactoring for CLI Reference
Files Changed: 16 files (+279, -158)
Pattern: CLI Reference Assembly with 3-Level Hierarchy

This PR refactors roxctl-netpol.adoc to follow Red Hat modular documentation standards and resolve DITA conversion errors.


✅ What Was Done

Assembly Refactoring

  • ✅ Extracted inline content (usage, available commands) into separate modules
  • ✅ Added assembly abstract with descriptive text
  • ✅ Established proper module hierarchy with correct leveloffset values

Module Splitting

  • roxctl netpol generate: Split into CONCEPT + usage + options (3 modules)
  • roxctl netpol connectivity: Split into CONCEPT + usage (2 modules)
  • roxctl netpol connectivity map: Split into CONCEPT + usage + options (3 modules at leveloffset +3)
  • roxctl netpol connectivity diff: Split into CONCEPT + usage + options (3 modules at leveloffset +3)

DITA Compliance

  • ✅ Added [role="_abstract"] to all modules
  • ✅ Converted parent modules from REFERENCE to CONCEPT
  • ✅ Set proper content types (CONCEPT/REFERENCE)
  • ✅ Updated shared module options-inherited-from-the-parent-command.adoc

Content Quality

  • ✅ No content loss during refactoring
  • ✅ Build check passed
  • ✅ Vale linting completed

📂 Module Hierarchy

roxctl-netpol.adoc (assembly)
├── roxctl-netpol-overview.adoc (+1)
├── roxctl-netpol-usage.adoc (+2)
├── roxctl-netpol-available-commands.adoc (+2)
├── options-inherited-from-the-parent-command.adoc (+1)
├── roxctl-netpol-generate.adoc (+1)
│   ├── roxctl-netpol-generate-usage.adoc (+2)
│   └── roxctl-netpol-generate-options.adoc (+2)
└── roxctl-netpol-connectivity.adoc (+1)
    ├── roxctl-netpol-connectivity-usage.adoc (+2)
    ├── roxctl-netpol-connectivity-map.adoc (+2)
    │   ├── roxctl-netpol-connectivity-map-usage.adoc (+3)
    │   └── roxctl-netpol-connectivity-map-options.adoc (+3)
    └── roxctl-netpol-connectivity-diff.adoc (+2)
        ├── roxctl-netpol-connectivity-diff-usage.adoc (+3)
        └── roxctl-netpol-connectivity-diff-options.adoc (+3)

🧪 Review Guide

Main Assembly

📄 Preview: https://111782--ocpdocs-pr.netlify.app/openshift-acs/latest/cli/command-reference/roxctl-netpol.html

Check:

  • Assembly abstract appears at the top
  • Table of contents renders correctly
  • All sections in proper hierarchy
  • Usage syntax visible
  • Available commands table present
  • Inherited options section appears

Command Sections

roxctl netpol generate

Location: Scroll to "roxctl netpol generate" heading in the preview

Verify:

  • Command description (abstract)
  • Usage section with syntax example
  • Options table with all flags

Modules:

  • roxctl-netpol-generate.adoc (CONCEPT)
  • roxctl-netpol-generate-usage.adoc (REFERENCE)
  • roxctl-netpol-generate-options.adoc (REFERENCE)
roxctl netpol connectivity

Location: Scroll to "roxctl netpol connectivity" heading

Verify:

  • Command description
  • Usage section
  • Two subcommands documented

Modules:

  • roxctl-netpol-connectivity.adoc (CONCEPT)
  • roxctl-netpol-connectivity-usage.adoc (REFERENCE)
roxctl netpol connectivity map (subcommand)

Location: Nested under "roxctl netpol connectivity"

Verify:

  • Subcommand description
  • Usage section
  • Options table
  • Proper nesting level (H3/H4, not H2)

Modules (leveloffset=+3):

  • roxctl-netpol-connectivity-map.adoc (CONCEPT, +2)
  • roxctl-netpol-connectivity-map-usage.adoc (REFERENCE, +3)
  • roxctl-netpol-connectivity-map-options.adoc (REFERENCE, +3)
roxctl netpol connectivity diff (subcommand)

Location: Nested under "roxctl netpol connectivity"

Verify:

  • Subcommand description
  • Usage section
  • Options table
  • Matches hierarchy of map subcommand

Modules (leveloffset=+3):

  • roxctl-netpol-connectivity-diff.adoc (CONCEPT, +2)
  • roxctl-netpol-connectivity-diff-usage.adoc (REFERENCE, +3)
  • roxctl-netpol-connectivity-diff-options.adoc (REFERENCE, +3)

📊 Stats

Metric Count
Files modified 16
New modules created 10
Parent modules updated 4
Shared modules updated 1
Assembly updated 1
Lines added +279
Lines removed -158
Net change +121

🔗 Related PRs

This PR follows the same modular refactoring pattern as:

  • #111737 - roxctl-declarative-config

All implement Red Hat modular documentation standards for CLI reference assemblies with DITA compliance.


✅ Ready for Review

This PR is ready for review and merge. All content has been preserved, DITA compliance achieved, and build checks passed.


@jlprevatt jlprevatt left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@agantony
agantony merged commit c9aa445 into openshift:rhacs-docs-main Jul 20, 2026
2 checks passed
@agantony

Copy link
Copy Markdown
Contributor Author

/cherrypick rhacs-docs-4.11

@agantony

Copy link
Copy Markdown
Contributor Author

/cherrypick rhacs-docs-4.10

@agantony

Copy link
Copy Markdown
Contributor Author

/cherrypick rhacs-docs-4.9

@openshift-cherrypick-robot

Copy link
Copy Markdown

@agantony: new pull request created: #115830

Details

In response to this:

/cherrypick rhacs-docs-4.11

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 kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

Copy link
Copy Markdown

@agantony: new pull request created: #115831

Details

In response to this:

/cherrypick rhacs-docs-4.10

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 kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

Copy link
Copy Markdown

@agantony: new pull request created: #115832

Details

In response to this:

/cherrypick rhacs-docs-4.9

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 kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.9 rhacs-docs-4.10

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants