Skip to content

[RHDHBUGS-831]: Update prerequisites to include specific RBAC roles and permissions#2047

Open
themr0c wants to merge 17 commits intoredhat-developer:mainfrom
themr0c:rhdhbugs-831-prerequisite-rbac-permissions
Open

[RHDHBUGS-831]: Update prerequisites to include specific RBAC roles and permissions#2047
themr0c wants to merge 17 commits intoredhat-developer:mainfrom
themr0c:rhdhbugs-831-prerequisite-rbac-permissions

Conversation

@themr0c
Copy link
Copy Markdown
Member

@themr0c themr0c commented Apr 14, 2026

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): 1.6
Issue: https://issues.redhat.com/browse/RHDHBUGS-831
Preview: N/A

Summary

Audited all 217 procedure modules with .Prerequisites sections and standardized vague permission language across four categories:

  • Category B (App config access): Replaced "sufficient permissions", "administrator permissions", "administrator access" with standard {configuring-book-link} prerequisite (20 modules)
  • Category C (RHDH RBAC): Replaced vague "required permissions" / "policy administrator role" with specific RBAC permission names like policy.entity.create, scaffolder.task.create, catalog.entity.read (13 modules)
  • 183 modules already had specific enough prerequisites and were left unchanged

35 module files updated across shared, observability, and plugin management procedures.

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Apr 14, 2026

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2047/ @ 4/15/2026, 6:27:45 PM

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Apr 14, 2026

Content Quality Assessment Results

CQA Report

  • CQA-00a: Orphaned modules
  • CQA-00b: Directory structure
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure
  • CQA-03: Verify content type metadata
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements
  • CQA-06: Verify assemblies follow official template (one user story)
  • CQA-07: Verify TOC depth (max 3 levels)
  • CQA-08: Verify short description content quality
  • CQA-09: Verify short description format
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-11: Verify procedure prerequisites
  • CQA-12: Verify grammar and style (Vale)
  • CQA-13: Verify content matches declared type
  • CQA-14: Verify no broken links
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 19 pass, 0 fail


Automated CQA check run on the entire repository — 2026-04-15 18:26:18 UTC

themr0c and others added 10 commits April 15, 2026 18:53
…ns audit

Add design spec and implementation plan for auditing all 217 procedure
modules with prerequisites and standardizing permission language.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ing modules

Standardize permission prerequisites for authentication, RBAC,
and user provisioning procedure modules.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…modules

Standardize permission prerequisites for plugin management,
catalog operations, and software template procedure modules.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ng shared modules

Standardize permission prerequisites for customization, localization,
user features, and remaining shared procedure modules.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Standardize permission prerequisites for orchestrator, observability,
configure, install, upgrade, integration, and getting-started modules.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
themr0c and others added 3 commits April 15, 2026 18:53
These are working documents, not part of the deliverable.
Product name attributes, content type metadata, file rename for title
alignment, and minor formatting corrections.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Product name attributes (AWS), content type metadata, abstract markers,
title-chain link attribute, and additional formatting corrections.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@themr0c themr0c force-pushed the rhdhbugs-831-prerequisite-rbac-permissions branch from 596de0b to 2623add Compare April 15, 2026 16:53
@sonarqubecloud
Copy link
Copy Markdown

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants