Skip to content

Commit 944b541

Browse files
committed
added an introduction explaining the why
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent 5c76af3 commit 944b541

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
[id="enabling-github-repository-discovery"]
22
= Enabling GitHub repository discovery
33

4-
To enable integration with the GitHub API, configure the GitHub integration in {product}.
4+
By default, you register components manually into {product}.
5+
Consider configuring {product-short} to discover your GitHub repositories automatically.
6+
When a repository contains a `catalog-info.yaml` file, {product-short} ingests the entity into the catalog as a component.
57

68
.Prerequisites
79
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
@@ -94,7 +96,8 @@ Select `Only on this account`.
9496
* **Private key**
9597
* **Webhook secret**
9698

97-
. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
99+
. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets].
100+
You can use these secrets in the {product-short} configuration files by using their respective environment variable name.
98101
+
99102
`INTEGRATION_GITHUB_APP_ID`::
100103
Enter the saved **App ID**.

0 commit comments

Comments
 (0)