Skip to content

RHIDP-6568: Create RHDH Metadata card customization content #1070

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

RHIDP-6568: Create RHDH Metadata card customization content #1070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe69f2e
RHIDP-6568: Create RHDH Metadata card customization content
linfraze Apr 11, 2025
84252c8
RHIDP-6568: Add RHDH Metadata card module to Customizing title
linfraze Apr 11, 2025
fbead57
RHIDP-6568: Add info about TechDocs builder
linfraze Apr 15, 2025
9b2649c
RHIDP-6568: Add full property to config example
linfraze Apr 16, 2025
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
35 changes: 35 additions & 0 deletions modules/customizing/proc-customizing-rhdh-metadata-card.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
:_mod-docs-content-type: PROCEDURE
[id="proc-customizing-rhdh-metadata-card_{context}"]
= Customizing the {product-very-short} Metadata card on the Settings page

The *Settings* page in {product} contains a *{product-very-short} Metadata* card. By default, the *{product-very-short} Metadata* card shows the *{product-very-short} Version* and *Backstage Version* of your {product} instance. When you click the *Show more* icon, the card expands to also show *Upstream*, *Midstream*, and *Build Time* information.
Copy link
Member

Choose a reason for hiding this comment

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

@linfraze Small nitpick here, the default view (on RHDH-Local) shows the RHDH version, BS version, upstream, midstream and build time. When you click the icon it contracts to the RHDH version and BS version.

Copy link
Member Author

@linfraze linfraze Apr 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@Gerry-Forde thank you! Just to confirm, are you using 1.6? Could the RHDH Local default be different?

@debsmita1 can you please confirm that this is what the user sees in the default RHDH Metacard?


You can override the default to show custom build information about your {product} instance in the card. You can customize the card title as well as the card contents.

.Procedure

To customize the *{product-very-short} Metadata* card, complete the following step:
Copy link
Member

Choose a reason for hiding this comment

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

Consider removing this line as fluff, but that's just a nitpick.

Suggested change
To customize the *{product-very-short} Metadata* card, complete the following step:

Copy link
Member

Choose a reason for hiding this comment

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

The code snippet that is displayed will completely remove the default RHDH Metadata - is this the intention? I'd suggest that customers will want to see the RHDH Version and Backstage Version at least, so maybe we should leave that in the code snippet?

Screenshot 2025-04-22 at 13 46 08

Copy link
Member Author

Choose a reason for hiding this comment

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

@Gerry-Forde this seems like a Q for PM / Eng.
@debsmita1 can you share your thoughts?


* In your app-config.yaml file, configure the `buildinfo` field. For example:
+
[source,yaml,subs=+attributes,+quotes]
----
buildInfo:
title: _<metadata_card_title>_
card:
TechDocs builder: '_<techdocs_builder>_'
Authentication provider: '_<authentication_provider>_'
RBAC: disabled
full: true

----
+
where

_<metadata_card_title>_ :: Specifies the title that you want to display on the customized card.
_<techdocs_builder>_ :: Specifies whether to generate and publish the docs or to only fetch the docs when using the default build strategy. Possible values are `local` or `external`. If you want to generate and publish the docs, set the `techdocs.builder` field to `local` in your app-config.yaml file. If you only want to fetch the docs without generating and publishing them, set the `techdocs.builder` field to `external`.
_<authentication_provider>_ :: Specifies the authentication provider that you want to use. Example values are `GitHub` or `GitLab`.
`full` :: Specifies what information is shown on the customized card. Possible values are `true` or `false`. If set to `true`, only the information specified in this configuration is shown on the card. If set to `false`, the specified information is shown on the card along with the build versions. The default value is `true`.

.Result
The *Settings* page displays a card with a custom title and custom build information about your {product} instance.
2 changes: 2 additions & 0 deletions titles/customizing/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,5 @@ include::assemblies/assembly-customizing-the-homepage.adoc[leveloffset=+1]


include::assemblies/assembly-customizing-the-quick-access-card.adoc[leveloffset=+1]

include::modules/customizing/proc-customizing-rhdh-metadata-card.adoc[leveloffset=+1]