Skip to content

Commit 9e16c78

Browse files
RHIDP-6568: Create RHDH Metadata card customization content (#1070)
Co-authored-by: Heena Manwani <[email protected]>
1 parent 06f560e commit 9e16c78

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-customizing-rhdh-metadata-card_{context}"]
3+
= Customizing the {product-very-short} Metadata card on the Settings page
4+
5+
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.
6+
7+
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.
8+
9+
.Procedure
10+
11+
To customize the *{product-very-short} Metadata* card, complete the following step:
12+
13+
* In your app-config.yaml file, configure the `buildinfo` field. For example:
14+
+
15+
[source,yaml,subs=+attributes,+quotes]
16+
----
17+
buildInfo:
18+
title: _<metadata_card_title>_
19+
card:
20+
TechDocs builder: '_<techdocs_builder>_'
21+
Authentication provider: '_<authentication_provider>_'
22+
RBAC: disabled
23+
full: true
24+
25+
----
26+
+
27+
where
28+
29+
_<metadata_card_title>_ :: Specifies the title that you want to display on the customized card.
30+
_<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`.
31+
_<authentication_provider>_ :: Specifies the authentication provider that you want to use. Example values are `GitHub` or `GitLab`.
32+
`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`.
33+
34+
.Result
35+
The *Settings* page displays a card with a custom title and custom build information about your {product} instance.

titles/customizing/master.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,5 @@ include::assemblies/assembly-customizing-the-homepage.adoc[leveloffset=+1]
3737

3838

3939
include::assemblies/assembly-customizing-the-quick-access-card.adoc[leveloffset=+1]
40+
41+
include::modules/customizing/proc-customizing-rhdh-metadata-card.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)