Skip to content

docs: update branding images customization guide#3069

Open
olexii4 wants to merge 2 commits intomainfrom
CRW-10433
Open

docs: update branding images customization guide#3069
olexii4 wants to merge 2 commits intomainfrom
CRW-10433

Conversation

@olexii4
Copy link
Copy Markdown
Contributor

@olexii4 olexii4 commented Apr 15, 2026

What does this pull request change?

This PR renames and expands the existing "Customizing ConsoleLink icon" page into a broader "Customizing branding images" guide that covers all branding images in the assets/branding directory.

Key changes:

  • Rename customizing-openshift-che-consolelink-icon.adoc to customizing-openshift-che-branding-images.adoc
  • Add a page-aliases attribute to preserve the old URL as a redirect
  • Expand scope from ConsoleLink icon only to all branding images (logo, loader, favicon, etc.)
  • Document supported image formats(just for loader) in priority order: jpg, jpeg, png, gif, webp, svg
  • Update navigation (nav.adoc) and parent page (configuring-dashboard.adoc) references
Знімок екрана 2026-04-15 о 17 35 11

What issues does this pull request fix or reference?

fixes https://redhat.atlassian.net/browse/CRW-10433

Specify the version of the product this pull request applies to

DS 3.28.0

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@olexii4 olexii4 requested a review from amisevsk April 15, 2026 13:30
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 15, 2026

🎊 Navigate the preview: https://69e0e378779e5711d117c758--eclipse-che-docs-pr.netlify.app 🎊

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 15, 2026

Click here to review and test in web IDE: Contribute

Rename and expand the ConsoleLink icon page to cover all
branding images under assets/branding with supported formats
(jpg, jpeg, png, gif, webp, svg). Add favicon.ico override.

Assisted-by: Claude Opus 4.6
Signed-off-by: Oleksii Orel <oorel@redhat.com>
<1> The loader image file name and Base64-encoded content with disabled line wrapping. You can use any supported format (`jpg`, `jpeg`, `png`, `gif`, `webp`, `svg`). For example, `loader.png` with its Base64-encoded content.
<2> The favicon file name and Base64-encoded content with disabled line wrapping.
+
NOTE: You can override one or all images from the `/public/dashboard/assets/branding` directory. Only the images specified in the Secret `data` section are overridden; unspecified images remain unchanged.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

not clear where /public/dashboard/assets/branding is located, need to document that it's from dashboard pod

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I have fixed it.

[id="customizing-openshift-che-branding-images"]
= Customizing {ocp} {prod} branding images

This procedure describes how to customize {prod} branding images, such as the logo displayed in the {prod} dashboard and the link:https://docs.openshift.com/container-platform/{ocp4-ver}/rest_api/console_apis/consolelink-console-openshift-io-v1.html[ConsoleLink] icon.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
This procedure describes how to customize {prod} branding images, such as the logo displayed in the {prod} dashboard and the link:https://docs.openshift.com/container-platform/{ocp4-ver}/rest_api/console_apis/consolelink-console-openshift-io-v1.html[ConsoleLink] icon.
This procedure describes how to customize {prod} branding images, including the logo shown in the {prod} dashboard, the loader icon and the link:https://docs.openshift.com/container-platform/{ocp4-ver}/rest_api/console_apis/consolelink-console-openshift-io-v1.html[ConsoleLink] icon.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I have fixed it.

Assisted-by: Claude Opus 4.6
Signed-off-by: Oleksii Orel <oorel@redhat.com>
Copy link
Copy Markdown
Contributor

@svor svor left a comment

Choose a reason for hiding this comment

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

lgtm

@svor
Copy link
Copy Markdown
Contributor

svor commented Apr 16, 2026

@gtrivedi88 could you take a look please

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants