Skip to content

[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fix DITA errors in operating/manage-user-access/configuring-identity-providers/connecting-azure-ad-to-rhacs-using-sso-configuration.adoc#112852

Open
agantony wants to merge 1 commit into
openshift:rhacs-docs-mainfrom
agantony:ROX33164-dita-rework-configuring-identity-providers/connecting-azure-ad-to-rhacs-using-sso-configuration
Open

[RHACS] [Docs] [rhacs-docs-main] ROX-33164: Fix DITA errors in operating/manage-user-access/configuring-identity-providers/connecting-azure-ad-to-rhacs-using-sso-configuration.adoc#112852
agantony wants to merge 1 commit into
openshift:rhacs-docs-mainfrom
agantony:ROX33164-dita-rework-configuring-identity-providers/connecting-azure-ad-to-rhacs-using-sso-configuration

Conversation

@agantony

@agantony agantony commented Jun 5, 2026

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.11
    • rhacs-docs-4.10
    • rhacs-docs-4.9

…identity-providers/connecting-azure-ad-to-rhacs-using-sso-configuration.adoc
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 5, 2026
@openshift-ci-robot

openshift-ci-robot commented Jun 5, 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.11
    • 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 added RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.9 rhacs-docs-4.10 rhacs-docs-4.11 Label for PRs that apply to RHACS 4.11 labels Jun 5, 2026
@openshift-ci openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 5, 2026
@ocpdocs-previewbot

Copy link
Copy Markdown

@openshift-ci

openshift-ci Bot commented Jun 5, 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

Copy link
Copy Markdown
Contributor Author

PR Review Summary

Changes Made

This PR addresses DITA errors in the Azure AD SSO configuration documentation. The changes include:

  • 2 files modified (1 assembly, 1 module - new)
  • Module hierarchy updates: Assembly restructured with new module for group claims configuration
  • DITA compliance fixes: Added shortdesc abstracts, modularized content
  • Content improvements: Extracted group claims content from assembly into dedicated procedure module

Summary of Changes

File Location Changes Before/After
operating/manage-user-access/configuring-identity-providers/connecting-azure-ad-to-rhacs-using-sso-configuration.adoc Assembly Removed inline group claims content, added new module include, reorganized structure 26 lines → 22 lines (-4)
modules/adding-group-claims-tokens-saml-apps.adoc New module Created new procedure module with group claims configuration content moved from assembly 15 lines (new)

Key structural changes:

  • Assembly now cleaner with group claims procedure extracted to module
  • Better separation of procedural content from assembly orchestration
  • Improved modular structure enables better DITA conversion

Navigation Guide - Review Changes

Follow these steps to review the changes using the Netlify preview:

Step 1: Review Assembly Structure

Preview URL: https://112852--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-user-access/configuring-identity-providers/connecting-azure-ad-to-rhacs-using-sso-configuration.html

What to verify:

  • Assembly shortdesc displays correctly
  • No inline procedure content in assembly body
  • Table of contents includes all sections
  • Module hierarchy is logical

Step 2: Review Adding Group Claims to Tokens Procedure

Preview URL: https://112852--ocpdocs-pr.netlify.app/openshift-acs/latest/operating/manage-user-access/configuring-identity-providers/connecting-azure-ad-to-rhacs-using-sso-configuration.html#adding-group-claims-tokens-saml-apps_connecting-azure-ad-to-rhacs-using-sso-configuration

What to verify:

  • Group claims procedure displays with proper heading level
  • Shortdesc abstract renders correctly
  • Procedure steps are clearly numbered
  • UI navigation instructions are accurate
  • Content reads naturally as procedural material
  • All procedure steps render correctly

Verification Checklists

Structural Verification

  • Assembly has no inline procedure content
  • Group claims module included at appropriate level
  • Table of contents is complete and accurate
  • Heading levels are appropriate
  • Module appears in logical position within assembly

Content Verification

  • Group claims procedure content moved from assembly to module
  • All content from original assembly preserved in module
  • Module has role="_abstract" on shortdesc
  • Procedure steps are complete and accurate
  • All substitutions render correctly

DITA Compliance Verification

  • New module has :_mod-docs-content-type: PROCEDURE
  • Shortdesc abstract uses [role="_abstract"]
  • Module ID follows naming conventions with context suffix
  • Assembly comment headers are present
  • Procedure steps use proper numbered list format

Quick Visual Review Guide

Key visual elements to check:

  1. Assembly page layout: Clean structure with modular content
  2. Group claims procedure: Displays with proper heading and steps
  3. Module shortdesc: Abstract displays as lead-in text
  4. Procedure steps: Clear numbering and navigation instructions
  5. Table of contents: Shows complete structure
  6. Content flow: Logical progression through Azure AD configuration

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 rhacs-docs-4.11 Label for PRs that apply to RHACS 4.11 size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants