Skip to content

Commit 012210b

Browse files
committed
RHIDP-6568: Create RHDH Metadata card customization content
1 parent 3f527c1 commit 012210b

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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: <build_info_card_title>
19+
card:
20+
TechDocs builder: '<techdocs_builder>'
21+
Authentication provider: '_<authentication_provider>_'
22+
RBAC: disabled
23+
----
24+
+
25+
where
26+
27+
_<build_info_card_title>_ :: Specifies the title that you want to display in the *{product-very-short} Build info* card.
28+
_<authentication_provider>_ :: Specifies the authentication provider that you want to use, for example, `GitHub` or `GitLab`.
29+
_<techdocs_builder>_ :: Specifies the TechDocs builder that you want to use, for example, `local`.
30+
31+
.Result
32+
The *Settings* page displays a card with a custom title and custom build information about your {product} instance.

0 commit comments

Comments
 (0)