chore: fix branding defaults; bump to 1.6 as default image version; improve docs for consistency with RH style guide (RHIDP-7883, RHIDP-7906) #53

nickboldt · 2025-06-19T17:21:09Z

What does this PR do?

chore: fix branding defaults; bump to 1.6 as default image version; improve docs for consistency with RH style guide (RHIDP-7883)

Signed-off-by: Nick Boldt [email protected]

Screenshot/screencast of this PR

Using quay.io/rhdh/rhdh-hub-rhel9:1.6:

Using quay.io/rhdh-community/rhdh:next

What issues does this PR fix or reference?

RHIDP-7883
RHIDP-7906

How to test this PR?

podman-compose stop rhdh; podman-compose up --pull --build --force-recreate; google-chrome http://localhost:7007/settings

PR Checklist

As the author of this Pull Request I made sure that:

Code produced is complete
Code builds without errors
Tests are covering the bugfix
Relevant user documentation updated
Relevant contributing documentation updated

Reviewers

Reviewers, please comment how you tested the PR when approving it.

Summary by Sourcery

Fix branding defaults, bump default image version to 1.6, and update documentation for style consistency and clearer image configuration instructions

Bug Fixes:

Fix branding defaults to include required logos and theme color variables

Enhancements:

Bump default RHDH container image version in compose.yaml to 1.6
Add default branding configuration (fullLogo, iconLogo, and theme colors) to app-config and example files
Expand documentation with instructions for switching between community, CI, and official images

Documentation:

Revise README for Red Hat style guide consistency, including updated headings, casing, a caution block, and reorganized prerequisites

nickboldt · 2025-06-20T00:43:47Z

The white-on-grey logotype problem may be related to / fixed by redhat-developer/rhdh-plugins#981

Using the 1.6.1 community build at quay.io/rhdh-community/rhdh:1.6.1-b7bf4c77, the branding for the light theme looks fine:

compose.yaml

README.md

compose.yaml

configs/app-config/app-config.local.example.yaml

README.md

configs/app-config/app-config.local.example.yaml

configs/app-config/app-config.yaml

rm3l · 2025-06-24T16:37:33Z

@sourcery-ai review

sourcery-ai · 2025-06-24T16:39:31Z

Reviewer's Guide

This PR bumps the default RHDH image to version 1.6, enriches the application configuration with comprehensive branding defaults (logos, title, theme colors), and refactors the local testing documentation for consistency with the Red Hat style guide, including expanded image customization guidance and streamlined architecture support notes.

Class diagram for updated branding configuration in app-config

classDiagram
    class AppConfig {
        +string title
        +string baseUrl
        +Branding branding
    }
    class Branding {
        +string fullLogo
        +string iconLogo
        +string fullLogoWidth
        +Theme theme
    }
    class Theme {
        +ThemeMode light
        +ThemeMode dark
    }
    class ThemeMode {
        +string primaryColor
        +string headerColor1
        +string headerColor2
        +string navigationIndicatorColor
    }
    AppConfig --> Branding
    Branding --> Theme
    Theme --> ThemeMode

File-Level Changes

Change	Details	Files
Default image version bumped to 1.6	Updated RHDH service image fallback to community build 1.6 Aligned install-dynamic-plugins container image to 1.6	`compose.yaml`
Branding configuration enriched	Added fullLogo, iconLogo, fullLogoWidth, and theme color variables Renamed app title from shorthand to “Red Hat Developer Hub”	`configs/app-config/app-config.local.example.yaml` `configs/app-config/app-config.yaml`
Documentation refactored for RH style guide	Standardized headings and phrasing Replaced Mac M1 note with unified amd64/arm64 support Introduced caution admonition and expanded image customization scenarios	`README.md`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @nickboldt - I've reviewed your changes - here's some feedback:

Make sure to add the new branding placeholders (FULL_LOGO_WIDTH, PRIMARY_LIGHT_COLOR, etc.) to your default.env or .env.example so the example configs don’t break at runtime.
The huge base64 blobs make the YAML hard to review—consider moving those inline logos into separate asset files or a shared include to reduce noise in the config examples.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Make sure to add the new branding placeholders (FULL_LOGO_WIDTH, PRIMARY_LIGHT_COLOR, etc.) to your default.env or .env.example so the example configs don’t break at runtime.
- The huge base64 blobs make the YAML hard to review—consider moving those inline logos into separate asset files or a shared include to reduce noise in the config examples.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

…mprove docs for consistency with RH style guide (RHIDP-7883) Signed-off-by: Nick Boldt <[email protected]> add theme colours Signed-off-by: Nick Boldt <[email protected]> refactor text to clarify commercially supported official images vs. CI builds vs. community builds Signed-off-by: Nick Boldt <[email protected]>

Signed-off-by: Nick Boldt <[email protected]>

README.md

configs/app-config/app-config.local.example.yaml

configs/app-config/app-config.yaml

Co-authored-by: logonoff <[email protected]>

logonoff

🥳

README.md

benwilcock · 2025-06-27T13:25:33Z

If we're sure we can make the switch to using RHDH community builds without incurring any user disruption or incompatibility, I am happy to endorse these changes. Thanks @nickboldt (and the whole team here) for taking the time to improve the RHDH Local experience for everyone and for the additional transparency for users around RHDH image choices. I think that's super useful and very educational.

…sing same sources for community & commercial Signed-off-by: RHDH Build (rhdh-bot) <[email protected]>

nickboldt · 2025-06-27T14:14:53Z

Followup work to ensure we keep getting fresh :1.y tags in the quay.io/rhdh-community/rhdh repo for all .z updates, and that compose.yaml/readme.md are updated quarterly:

	update tagRelease.sh to
		replace the 1.6 tag for the rhdh repo when pushing the 1.6.z tag
		generate PR to update 
			compose.yaml: 1.6 floating tag
		 	readme: latest 1.6 or next 1.7

See https://issues.redhat.com/browse/RHIDP-7906 / https://issues.redhat.com/browse/RHIDP-7829

rm3l · 2025-06-27T15:06:45Z

@sourcery-ai review

sourcery-ai

Hey @nickboldt - I've reviewed your changes - here's some feedback:

The huge inline base64 blobs for logos in your app-config examples make the YAML very hard to read and maintain—consider externalizing those images to files (or URLs) and referencing them to keep your configs DRY and cleaner.
You’re bumping the default image version in two places (compose.yaml and install-dynamic-plugins)—it might be worth consolidating that into a single RHDH_IMAGE default or variable so future version updates only need one change.
The README’s “Changing the container image” section now covers several different use cases (community, nightly CI, official), which can be a bit overwhelming—consider grouping those under a tabbed or collapsible format to simplify navigation.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- The huge inline base64 blobs for logos in your `app-config` examples make the YAML very hard to read and maintain—consider externalizing those images to files (or URLs) and referencing them to keep your configs DRY and cleaner.
- You’re bumping the default image version in two places (`compose.yaml` and `install-dynamic-plugins`)—it might be worth consolidating that into a single `RHDH_IMAGE` default or variable so future version updates only need one change.
- The README’s “Changing the container image” section now covers several different use cases (community, nightly CI, official), which can be a bit overwhelming—consider grouping those under a tabbed or collapsible format to simplify navigation.

## Individual Comments

### Comment 1
<location> `README.md:209` </location>
<code_context>
+
+#### Using image digests
+
+If you prefer to use digests to floating tags, [browse for the tag you want to use](https://catalog.redhat.com/software/containers/rhdh/rhdh-hub-rhel9/645bd4c15c00598369c31aba/history), and click though to find the digest of the image you want to use. For example, from the [Get this image](https://catalog.redhat.com/software/containers/rhdh/rhdh-hub-rhel9/645bd4c15c00598369c31aba?image=68360c12177ad86df31947d8&architecture=amd64&container-tabs=gti) tab for 1.6.1 provides this image:
+
+```sh
</code_context>

<issue_to_address>
Typo: 'click though' should be 'click through'.

Update the text to use the correct phrase.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
If you prefer to use digests to floating tags, [browse for the tag you want to use](https://catalog.redhat.com/software/containers/rhdh/rhdh-hub-rhel9/645bd4c15c00598369c31aba/history), and click though to find the digest of the image you want to use. For example, from the [Get this image](https://catalog.redhat.com/software/containers/rhdh/rhdh-hub-rhel9/645bd4c15c00598369c31aba?image=68360c12177ad86df31947d8&architecture=amd64&container-tabs=gti) tab for 1.6.1 provides this image:
=======
If you prefer to use digests to floating tags, [browse for the tag you want to use](https://catalog.redhat.com/software/containers/rhdh/rhdh-hub-rhel9/645bd4c15c00598369c31aba/history), and click through to find the digest of the image you want to use. For example, from the [Get this image](https://catalog.redhat.com/software/containers/rhdh/rhdh-hub-rhel9/645bd4c15c00598369c31aba?image=68360c12177ad86df31947d8&architecture=amd64&container-tabs=gti) tab for 1.6.1 provides this image:
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

README.md

benwilcock · 2025-06-27T15:41:28Z

/lgtm from a non-technical product management perspective. I didn't test it myself though - just reading through the changes.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

nickboldt · 2025-06-27T20:49:21Z

Merged after 2 people agreed it was an improvement over the current status, despite them not being code owners ;)

openshift-ci bot requested review from Fortune-Ndlovu and subhashkhileri June 19, 2025 17:21

nickboldt changed the title ~~chore: fix branding defaults; bump to 1.6 as...~~ chore: fix branding defaults; bump to 1.6 as default image version; improve docs for consistency with RH style guide (RHIDP-7883) Jun 19, 2025

nickboldt requested review from kadel, rm3l and benwilcock June 19, 2025 17:21

nickboldt mentioned this pull request Jun 20, 2025

feat(CompanyLogo): follow logo brand guidelines, support light mode redhat-developer/rhdh-plugins#981

Merged

4 tasks

nickboldt requested review from logonoff and ciiay June 20, 2025 00:44

nickboldt commented Jun 20, 2025

View reviewed changes

compose.yaml Outdated Show resolved Hide resolved

nickboldt commented Jun 20, 2025

View reviewed changes

compose.yaml Outdated Show resolved Hide resolved

nickboldt commented Jun 20, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

nickboldt commented Jun 20, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

nickboldt mentioned this pull request Jun 20, 2025

chore(doc): change default image in rhdh-local to the most recent stable image (currently a 1.6.2.CI build); update readme to explain how to use SUPPORTED and unsupported images (RHIDP-7829) #50

Closed

5 tasks

benwilcock reviewed Jun 20, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

benwilcock reviewed Jun 20, 2025

View reviewed changes

compose.yaml Show resolved Hide resolved

benwilcock reviewed Jun 20, 2025

View reviewed changes

configs/app-config/app-config.local.example.yaml Show resolved Hide resolved

nickboldt commented Jun 23, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

benwilcock reviewed Jun 24, 2025

View reviewed changes

README.md Show resolved Hide resolved

benwilcock reviewed Jun 24, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

benwilcock reviewed Jun 24, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

benwilcock reviewed Jun 24, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

benwilcock reviewed Jun 24, 2025

View reviewed changes

configs/app-config/app-config.local.example.yaml Show resolved Hide resolved

benwilcock reviewed Jun 24, 2025

View reviewed changes

configs/app-config/app-config.yaml Show resolved Hide resolved

sourcery-ai bot reviewed Jun 24, 2025

View reviewed changes

nickboldt force-pushed the RHIDP-7883-local branch from f28d962 to 6d290ab Compare June 27, 2025 01:28

nickboldt added 2 commits June 26, 2025 22:31

Add note about icon overrides being temporary for 1.6, and fixed in 1.7

f6d046b

Signed-off-by: Nick Boldt <[email protected]>

Merge branch 'main' into RHIDP-7883-local

dff3c43

nickboldt requested a review from benwilcock June 27, 2025 12:17

logonoff reviewed Jun 27, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

configs/app-config/app-config.local.example.yaml Outdated Show resolved Hide resolved

configs/app-config/app-config.yaml Outdated Show resolved Hide resolved

nickboldt and others added 4 commits June 27, 2025 08:32

Update README.md

2362dfa

Co-authored-by: logonoff <[email protected]>

Update configs/app-config/app-config.yaml

29092a9

Co-authored-by: logonoff <[email protected]>

Update configs/app-config/app-config.local.example.yaml

e5524e5

Co-authored-by: logonoff <[email protected]>

Update README.md

35a0c47

Co-authored-by: logonoff <[email protected]>

logonoff approved these changes Jun 27, 2025

View reviewed changes

benwilcock reviewed Jun 27, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

benwilcock reviewed Jun 27, 2025

View reviewed changes

README.md Show resolved Hide resolved

benwilcock reviewed Jun 27, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

benwilcock reviewed Jun 27, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

benwilcock reviewed Jun 27, 2025

View reviewed changes

README.md Show resolved Hide resolved

clean up dependencies/requirements minimum versions; add note about u…

c32fe67

…sing same sources for community & commercial Signed-off-by: RHDH Build (rhdh-bot) <[email protected]>

sourcery-ai bot reviewed Jun 27, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

3639e8e

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

nickboldt merged commit cad7f94 into main Jun 27, 2025
13 checks passed

nickboldt deleted the RHIDP-7883-local branch July 14, 2025 15:33

chore: fix branding defaults; bump to 1.6 as default image version; improve docs for consistency with RH style guide (RHIDP-7883, RHIDP-7906) #53

chore: fix branding defaults; bump to 1.6 as default image version; improve docs for consistency with RH style guide (RHIDP-7883, RHIDP-7906) #53

Uh oh!

Conversation

nickboldt commented Jun 19, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

Reviewers

Summary by Sourcery

Uh oh!

nickboldt commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rm3l commented Jun 24, 2025

Uh oh!

sourcery-ai bot commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Class diagram for updated branding configuration in app-config

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

logonoff left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benwilcock commented Jun 27, 2025

Uh oh!

nickboldt commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rm3l commented Jun 27, 2025

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

benwilcock commented Jun 27, 2025

Uh oh!

Uh oh!

nickboldt commented Jun 27, 2025

Uh oh!

Uh oh!

nickboldt commented Jun 19, 2025 •

edited by sourcery-ai bot

Loading

nickboldt commented Jun 20, 2025 •

edited

Loading

sourcery-ai bot commented Jun 24, 2025 •

edited

Loading

nickboldt commented Jun 27, 2025 •

edited

Loading