Skip to content

RHDHBUGS-3359: Add missing Common icons reference section #2382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rh-tokeefe wants to merge 3 commits into
base: release-1.9
Choose a base branch
from
+67 −0
Open

RHDHBUGS-3359: Add missing Common icons reference section #2382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1af0459
RHDHBUGS-3359: Add missing Common icons reference section
rh-tokeefe Jun 16, 2026
6c0949a
Fix xref to use explicit context instead of variable
rh-tokeefe Jun 16, 2026
07b2dc4
Remove GitHub link from Additional resources
rh-tokeefe Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...es/configure_customizing-rhdh/assembly-configure-the-global-header-in-rhdh.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ include::../modules/shared/con-quicklinks-and-starred-items-in-the-global-header

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]

@dzemanov dzemanov Jun 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add the link for common icons also to scorecard icons section?

@dzemanov dzemanov Jun 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@dzemanov dzemanov Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another one: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.10/html-single/customizing_red_hat_developer_hub/index#configure-the-logo-in-the-global-header_configure-the-global-header-in-rhdh

customizing rhdh section might have more


:context: {previouscontext}
:!previouscontext:

Expand Down
65 changes: 65 additions & 0 deletions modules/shared/ref-common-icons-for-customization.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
:_mod-docs-content-type: REFERENCE

[id="common-icons-for-customization_{context}"]
= Common icons for customization

[role="_abstract"]
When customizing {product-short}, you can use predefined system icon identifiers in various configuration contexts, including global header buttons, quick access cards, quick starts, and navigation menu items.

The following table lists commonly used icon identifiers available in {product-short}:

[cols="30%,70%", options="header"]
|===
|Icon identifier
|Description

|`add`
|Plus sign icon, typically used for "Create" or "Add new" actions

|`bookmarks`
|Bookmark icon for saved items

|`catalog`
|Catalog or list icon

|`category`
|Category or organization icon

|`developerHub`
|{product-short} logo icon

|`extension`
|Extension or plugin icon

|`favorite`
|Star icon for favorites or starred items

|`github`
|GitHub logo icon

|`group`
|Group or team icon

|`home`
|Home icon

|`manageAccounts`
|User account management icon

|`school`
|Education or learning icon

|`search`
|Search or magnifying glass icon
|===

[NOTE]
====
In addition to these predefined icon identifiers, you can use:

@dzemanov dzemanov Jun 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would make sense to also mention Backstage system icons that are available.


* *Full image URLs*: External image URLs (for example, `https://example.com/icon.png`)

@dzemanov dzemanov Jun 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add Data encoded URIs?

@dzemanov dzemanov Jun 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

* *SVG paths*: Valid inline SVG markup
* *Relative paths*: Paths to images in your {product-short} public folder

For information about extending the internal icon catalog with custom icons, see xref:extend-internal-icon-catalog_front-end-plugin-wiring[].
====
Loading