OBSDOCS-3707: Rename Install section to imperative tone and fix DITA violations - #117281
OBSDOCS-3707: Rename Install section to imperative tone and fix DITA violations#117281johnwilkins wants to merge 3 commits into
Conversation
Rename category and assemblies from gerund to imperative form: - Category: "Installing logging" → "Install" - Assembly titles: All use imperative tone (Install, Configure, Create, Verify) - File names: All match imperative titles Fix DITA 10-link violation in configure-object-storage-for-lokistack.adoc: - Removed 3 H2 headings from object-storage-permissions-requirements.adoc - Replaced with bold text to maintain visual hierarchy - Assembly now has 9 total links (8 includes + 1 Additional resources) Files renamed (6): - verifying-cluster-prerequisites → verify-cluster-prerequisites - configuring-storage-for-lokistack → configure-object-storage-for-lokistack - installing-the-loki-operator → install-the-loki-operator - installing-the-red-hat-openshift-logging-operator → install-the-red-hat-openshift-logging-operator - installing-the-cluster-observability-operator → install-the-cluster-observability-operator - creating-the-lokistack → create-the-lokistack Cross-references updated: 88 occurrences across 41 files Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
openshift-ci-robot
added
the
jira/valid-reference
|
@johnwilkins: This pull request references OBSDOCS-3707 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. |
openshift-ci
Bot
added
the
size/L
|
🤖 Wed Aug 05 00:52:31 - Prow CI generated the docs preview: |
- Update topic map File entries to match renamed assemblies - Fix broken include path in uninstalling-logging.adoc Signed-off-by: John Wilkins <jowilkin@redhat.com>
Fixes broken includes in install-the-loki-operator.adoc assembly. Signed-off-by: John Wilkins <jowilkin@redhat.com>
|
@johnwilkins: 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. |
3 participants
Summary
Rename Install section assemblies and category from gerund to imperative tone, following the same pattern as Configure section cleanup (PR #117163).
Changes
Category rename
Assembly renames (6 files)
verifying-cluster-prerequisites.adoc→verify-cluster-prerequisites.adocconfiguring-storage-for-lokistack.adoc→configure-object-storage-for-lokistack.adocinstalling-the-loki-operator.adoc→install-the-loki-operator.adocinstalling-the-red-hat-openshift-logging-operator.adoc→install-the-red-hat-openshift-logging-operator.adocinstalling-the-cluster-observability-operator.adoc→install-the-cluster-observability-operator.adoccreating-the-lokistack.adoc→create-the-lokistack.adocDITA compliance fix
Fixed DITA 10-link violation in
configure-object-storage-for-lokistack.adoc:==H2 headings frommodules/object-storage-permissions-requirements.adocCross-references updated
Impact
Files changed: 41 (6 renamed, 35 modified)
Category: Imperative tone
All assembly titles: Imperative tone
DITA compliance: ✅ All assemblies ≤10 navigation links
Build validation: ✅ Prow smoke test passed
Testing
git mvRelated: #116570, #117163