Skip to content

[RHIDP#RHDHBUGS-3359]: Add missing Common icons reference section (release-1.10) - #2507

Open
rh-tokeefe wants to merge 7 commits into
redhat-developer:release-1.10from
rh-tokeefe:RHDHBUGS-3359B
Open

[RHIDP#RHDHBUGS-3359]: Add missing Common icons reference section (release-1.10)#2507
rh-tokeefe wants to merge 7 commits into
redhat-developer:release-1.10from
rh-tokeefe:RHDHBUGS-3359B

Conversation

@rh-tokeefe

Copy link
Copy Markdown
Member

IMPORTANT: Do Not Merge.
This PR requires review and approval before merging.

Version(s): 1.10

Issue: RHDHBUGS-3359

Preview: N/A

Summary

Cherry-pick of PR #2382 (release-1.9) to release-1.10, plus scorecard-specific additions:

  • Add common icons reference module with RHDH and Backstage system icon tables
  • Add data-encoded URIs to supported icon formats
  • Replace duplicate icon type table in QuickAccessCard module with xref to common icons reference
  • Remove bare GitHub link from QuickAccessCard icon table
  • Add cross-book xref from scorecard icon configuration to common icons reference (1.10-only)

🤖 Generated with Claude Code

@rhdh-bot

rhdh-bot commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 35/35 titles | 76s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2507/


Content Quality Assessment

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

19 checks: 19 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.


Updated 2026-08-05 17:02:12 UTC

rh-tokeefe and others added 5 commits August 4, 2026 16:50
Created ref-common-icons-for-customization.adoc to document the
predefined system icon identifiers available in RHDH. This fixes
broken cross-references in three procedure files that were linking
to a non-existent #ref-common-icons anchor.

The new reference module:
- Lists commonly used icon identifiers (add, catalog, github, etc.)
- Explains alternative icon types (URLs, SVG paths, relative paths)
- Links to extend-internal-icon-catalog for custom icons
- Provides link to upstream Backstage icon set

Also updated assembly-configure-the-global-header-in-rhdh.adoc to
include the new reference module.

Fixes broken links in:
- proc-configure-the-logo-in-the-global-header.adoc
- proc-customize-your-rhdh-quick-start.adoc
- proc-use-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Updated xref to extend-internal-icon-catalog to use the actual
context value 'front-end-plugin-wiring' instead of the {context}
variable, following documentation best practices.

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Removed the link to the upstream Backstage GitHub repository to
comply with product documentation guidelines that avoid linking
to external GitHub repositories.

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
…onsolidate icon tables

- Add Backstage system icons table (kind:* entity icons and general UI icons)
- Add data-encoded URIs to supported icon formats
- Replace duplicate icon type table in QuickAccessCard module with xref to common icons reference
- Remove bare GitHub link from QuickAccessCard icon table

Co-Authored-By: Claude Opus 4.6 <[email protected]>
Replace intra-title xref with cross-title product-docs-link for the
extend-internal-icon-catalog reference, which lives in the
installing-and-viewing-plugins title, not configure_customizing-rhdh.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
The quickaccesscard module lives in the customize-the-home-page assembly
but xrefs the common-icons module in configure-the-global-header-in-rhdh.
Using {context} resolves to the wrong assembly context. Hardcode the
correct target context.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@sonarqubecloud

sonarqubecloud Bot commented Aug 5, 2026

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