[RHIDP#10991]: Document custom transformers for user provisioning#1767
Open
themr0c wants to merge 11 commits intoredhat-developer:mainfrom
Open
[RHIDP#10991]: Document custom transformers for user provisioning#1767themr0c wants to merge 11 commits intoredhat-developer:mainfrom
themr0c wants to merge 11 commits intoredhat-developer:mainfrom
Conversation
Collaborator
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1767/ @ 03/20/26 15:22:47 |
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
8dae077 to
a02f687
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
a02f687 to
425812f
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
425812f to
dc5f5ef
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
dc5f5ef to
045c875
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
045c875 to
887feca
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
887feca to
bc58a65
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
bc58a65 to
41b651b
Compare
themr0c
added
Peer review needed 📖
Technical review needed 🔩
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
41b651b to
36194a1
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
36194a1 to
f943ab1
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
f943ab1 to
08abbb6
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
08abbb6 to
5eedc2f
Compare
Convert Verification sections from unnumbered to numbered lists in GitHub, Azure, and GitLab custom transformer modules. Fix Azure module referencing GitHub instead of Azure in verification step. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1767/ @ 03/20/26 15:48:37 |
- Shorten assembly abstracts to under 300 chars
- Add [role="_abstract"] to all four modules
- Add _{context} suffix to all module IDs
- Replace hardcoded "Azure" with {azure-short} attribute
- Replace hardcoded "Backstage" with {backstage} attribute
- Attach [IMPORTANT] blocks to last procedure step with +
- Convert LDAP verification list to numbered
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Content Quality Assessment ResultsAutomated CQA check run on the entire repository |
CQA-10 derives the module ID and filename from the title text.
Using {azure-short} in the title resolves to empty during that process,
producing a broken ID. Keep Azure hardcoded in the title only.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Content Quality Assessment ResultsAutomated CQA check run on the entire repository |
The ID is explicitly set, so the attribute in the title won't affect it. This satisfies CQA-16 (no hardcoded product names). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Content Quality Assessment ResultsAutomated CQA check run on the entire repository |
The _title_to_id_form function maps AsciiDoc attributes to their
ID-friendly equivalents. Add {azure-short} -> azure so titles using
this attribute derive correct IDs and filenames.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Content Quality Assessment ResultsAutomated CQA check run on the entire repository |
Collaborator
Shellcheck Analysis ResultsChanged shell scripts in this PR: 19 Scripts analyzed:
Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
The LDAP provisioning module is included in the RHBK assembly, so the LDAP custom transformer module belongs there too, after the RHBK custom transformer. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Shellcheck Analysis ResultsChanged shell scripts in this PR: 19 Scripts analyzed:
Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
Collaborator
Content Quality Assessment ResultsCQA Summary Checklist
Total: 19 checks | 15 passed | 4 with issues To auto-fix what can be auto-fixed, run: To fix remaining issues, copy-paste this prompt to Claude: Automated CQA check run on the entire repository |
Collaborator
Shellcheck Analysis ResultsChanged shell scripts in this PR: 22 Scripts analyzed:
Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
The prerequisite xref pointed to a non-existent ID. Updated to
reference the correct enable-user-provisioning-with-ldap_{context}.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Content Quality Assessment ResultsAutomated CQA check run on the entire repository |
Collaborator
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1767/ @ 03/20/26 16:20:49 |
|
Collaborator
Content Quality Assessment ResultsCQA Summary Checklist
Total: 19 checks | 15 passed | 4 with issues To auto-fix what can be auto-fixed, run: To fix remaining issues, copy-paste this prompt to Claude: Automated CQA check run on the entire repository |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s): 1.5+
Issue: https://redhat.atlassian.net/browse/RHIDP-10991
Preview: N/A
Summary
Add documentation for creating custom transformers to provision users from external identity providers (GitHub, Azure, GitLab, LDAP) to the RHDH software catalog.
New modules
proc-create-a-custom-transformer-to-provision-users-from-github-to-the-software-catalog.adocproc-create-a-custom-transformer-to-provision-users-from-azure-to-the-software-catalog.adocproc-create-a-custom-transformer-to-provision-users-from-gitlab-to-the-software-catalog.adocproc-create-a-custom-transformer-to-provision-users-from-ldap-to-the-software-catalog.adocUpdated assemblies
Each custom transformer module is included in the corresponding authentication assembly:
assembly-enable-authentication-with-github.adocassembly-enable-authentication-with-microsoft-azure.adocassembly-enable-authentication-with-gitlab.adocassembly-enable-authentication-with-rhbk.adoc(LDAP custom transformer)CQA compliance
All new modules pass CQA checks. Includes a fix to CQA-10
_title_to_id_form()to handle{azure-short}attribute mapping.