Skip to content

Rox33164 dita rework install central ocp#108841

Open
agantony wants to merge 9 commits intoopenshift:rhacs-docs-mainfrom
agantony:ROX33164-dita-rework-install-central-ocp
Open

Rox33164 dita rework install central ocp#108841
agantony wants to merge 9 commits intoopenshift:rhacs-docs-mainfrom
agantony:ROX33164-dita-rework-install-central-ocp

Conversation

@agantony
Copy link
Contributor

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

Agil Antony and others added 4 commits March 23, 2026 16:51
Applied LLM-guided DITA refactoring to fix AsciiDocDITA issues:

- ShortDescription: Added [role="_abstract"] to 18 modules
- ContentType/DocumentTitle: Added SNIPPET metadata to common-attributes.adoc
- TaskStep: Added list continuation (+) markers for multi-block procedure steps
- BlockTitle/TaskTitle: Changed ".Next Steps" to ".Next steps" for DITA compatibility

Files modified:
- 18 modules with short description additions
- 6 modules with TaskStep list continuation fixes
- 2 modules with BlockTitle/TaskTitle fixes
- 1 module (common-attributes.adoc) with content type metadata

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Added abstract paragraph to adding-helm-repository.adoc
- Restructured NOTE blocks in prerequisites and procedure steps to comply with DITA TaskStep rules
- Removed mid-step NOTE in install-central-operator.adoc
- Moved NOTE to end of prerequisites section in install-central-operator-external-db.adoc

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Attached NOTE to final procedure step in install-central-operator.adoc
- Converted NOTE to inline text in prerequisites in install-central-operator-external-db.adoc
  (DITA does not support complex blocks in prerequisite lists)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…rator-external-db.adoc

Added list continuation marker (+) to properly attach NOTE block to the
last procedure step for DITA TaskStep compliance.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 23, 2026
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Mar 23, 2026

🤖 Mon Mar 23 13:54:06 - Prow CI generated the docs preview:
https://108841--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

Agil Antony and others added 2 commits March 23, 2026 19:13
Applied LLM-guided DITA fixes to configuration documentation modules:

- ShortDescription: Added [role="_abstract"] paragraphs to 15 modules
- AuthorLine: Resolved by proper abstract paragraph formatting

Files modified:
- additional-trusted-certificate-authorities-public-config.adoc
- advanced-customization-public-config.adoc
- central-private-config.adoc
- central-public-config.adoc
- customization-public-config.adoc
- default-network-policies-public-config.adoc
- environment-variables-public-config.adoc
- image-public-config.adoc
- image-pull-secrets-private-config.adoc
- image-pull-secrets-public-config.adoc
- policy-as-code-public-config.adoc
- proxy-configuration-private-config.adoc
- scanner-private-config.adoc
- scanner-v4-public-config.adoc
- stackrox-scanner-public-config.adoc

Note: common-attributes.adoc excluded per user request

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@openshift-ci openshift-ci bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 23, 2026
@openshift-ci
Copy link

openshift-ci bot commented Mar 23, 2026

@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.

Apply RedHat style guide fixes across configuration reference modules:

- Convert passive voice to active voice
- Replace 'modify' with 'change' per simple language rules
- Replace 'provide' with 'give' or 'offer' per simple language rules
- Remove self-referential text ('This section')
- Wrap PascalCase term 'PgBouncer' in backticks
- Fix repeated word 'the the' in scanner-private-config.adoc

Fixed 24 style violations across 9 files to improve clarity and consistency
with Red Hat documentation standards.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants