RHDHBUGS-3359: Add missing Common icons reference section#2382
RHDHBUGS-3359: Add missing Common icons reference section#2382rh-tokeefe wants to merge 3 commits into
Conversation
PR Build ResultsBuild failed -- 33/34 titles | 71s configure_customizing-rhdhError: Content Quality AssessmentCQA Report
SummaryChecks: 19 total, 19 pass, 0 fail 19 checks: 19 pass, 0 fail Run Updated 2026-06-16 18:27:12 UTC |
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 <noreply@anthropic.com>
rh-tokeefe
force-pushed
the
RHDHBUGS-3359-1.9
branch
from
2e07a0d to
1af0459
Compare
rh-tokeefe
added
do-not-merge/work-in-progress
Peer review needed 📖
Technical review needed 🔩
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 <noreply@anthropic.com>
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 <noreply@anthropic.com>
|
|
I believe icons available by default are located here, we should probably mention all of them? |
|
|
||
| [NOTE] | ||
| ==== | ||
| In addition to these predefined icon identifiers, you can use: |
There was a problem hiding this comment.
I think it would make sense to also mention Backstage system icons that are available.
| ==== | ||
| In addition to these predefined icon identifiers, you can use: | ||
|
|
||
| * *Full image URLs*: External image URLs (for example, `https://example.com/icon.png`) |
There was a problem hiding this comment.
Can you also add Data encoded URIs?
There was a problem hiding this comment.
It would be nice if it could be table with examples as it is here: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.10/html-single/evaluate_project_health_using_scorecards/index#threshold-icon-component-options or https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.9/html-single/customizing_red_hat_developer_hub/index#customize-quickaccesscard-card-icons-on-the-rhdh-homepage_customize-the-home-page.
It would be also good if those tables will be deleted in this PR and instead we just reference this 1 page that will be the source of truth.
|
|
||
| include::../modules/shared/proc-enable-quicklinks-and-starred-items-after-an-upgrade.adoc[leveloffset=+1] | ||
|
|
||
| include::../modules/shared/ref-common-icons-for-customization.adoc[leveloffset=+1] |
There was a problem hiding this comment.
Can you add the link for common icons also to scorecard icons section?
There was a problem hiding this comment.
I think quickstart plugin has also reference to common icons, can you check if it is working and if there are any other non-working common icons references and update them to this reference? Thank you!
There was a problem hiding this comment.
customizing rhdh section might have more
4 participants
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
release 1.9
Issue:
https://redhat.atlassian.net/browse/RHDHBUGS-3359
Summary:
This PR fixes broken cross-references to a missing "Common icons for customization" reference section by creating the missing content.
Changes:
modules/shared/ref-common-icons-for-customization.adocwith a table of commonly used icon identifiersFixes broken links in:
proc-configure-the-logo-in-the-global-header.adocproc-customize-your-rhdh-quick-start.adocproc-use-hosted-json-files-to-provide-data-to-the-quick-access-card.adocPreview:
Will be available after build completes