Skip to content

Commit 95f5cf6

Browse files
committed
RHIDP-6568: Add info about TechDocs builder
1 parent 9a49118 commit 95f5cf6

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

Diff for: modules/customizing/proc-customizing-rhdh-metadata-card.adoc

+7-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,13 @@ buildInfo:
2525
where
2626
2727
_<build_info_card_title>_ :: Specifies the title that you want to display in the *{product-very-short} Build info* card.
28-
_<techdocs_builder>_ :: Specifies the TechDocs builder that you want to use, for example, `local`.
29-
_<authentication_provider>_ :: Specifies the authentication provider that you want to use, for example, `GitHub` or `GitLab`.
28+
_<techdocs_builder>_ :: Specifies whether to generate and publish the docs or to only fetch the docs when using the default build strategy. Example values are `local` or `external`.
29+
_<authentication_provider>_ :: Specifies the authentication provider that you want to use. Example values are `GitHub` or `GitLab`.
30+
+
31+
[NOTE]
32+
====
33+
If you want to generate and publish the docs when using the default build strategy, 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`.
34+
====
3035

3136
.Result
3237
The *Settings* page displays a card with a custom title and custom build information about your {product} instance.

0 commit comments

Comments
 (0)