Skip to content

Commit f0f7abf

Browse files
committed
cleaned up formatting
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent 246444c commit f0f7abf

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

modules/authentication/proc-enabling-authentication-with-github.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ and provision the users and groups from GitHub to the {product-short} software c
66

77
.Prerequisites
88
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
9+
910
* You have sufficient permissions in GitHub to create and manage a link:https://docs.github.com/en/apps/overview[GitHub App].
1011

1112
.Procedure
@@ -22,8 +23,10 @@ Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
2223

2324
Authorization callback URL::
2425
Enter your {product-short} authentication backend URL: `pass:c,a,q[{my-product-url}/api/auth/github/handler/frame]`.
26+
2527
Webhook::
26-
Uncheck "Active", as this is not needed for authentication and catalog providers.
28+
Uncheck "Active", as this is not needed for authentication and catalog providers.
29+
2730
Organization permissions::
2831
Enable `Read-only` access to *Members*.
2932

@@ -41,7 +44,7 @@ Select `Only on this account`.
4144

4245
. 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].
4346
You can use these secrets in the {product-short} configuration files by using their respective environment variable name.
44-
+
47+
4548
`AUTHENTICATION_GITHUB_CLIENT_ID`::
4649
Enter the saved **Client ID**.
4750

@@ -64,7 +67,6 @@ plugins:
6467
- package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org'
6568
disabled: false
6669
----
67-
+
6870

6971
. To provision GitHub users and groups to the {product-short} software catalog, add the `catalog.providers.githubOrg` section to your custom {product-short} `{my-app-config-file}` configuration file:
7072
+
@@ -90,8 +92,7 @@ catalog:
9092

9193
`id`::
9294
Enter a stable identifier for this provider, such as `githuborg`.
93-
Entities from this provider will be associated with this identifier,
94-
therefore you should take care not to change it over time since that might lead to orphaned entities and/or conflicts.
95+
Entities from this provider will be associated with this identifier, therefore you should take care not to change it over time since that might lead to orphaned entities and/or conflicts.
9596

9697
`githubUrl`::
9798
Enter the configured secret variable name: `${AUTHENTICATION_GITHUB_HOST_DOMAIN}`.

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ When a repository contains a `catalog-info.yaml` file, {product-short} ingests t
77

88
.Prerequisites
99
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
10+
1011
* You have sufficient permissions in GitHub to create and manage a link:https://docs.github.com/en/apps/overview[GitHub App].
1112

1213
.Procedure
1314
. To allow {product-short} to access the GitHub API, create a GitHub App.
1415
Opt for a GitHub App instead of an OAuth app to use fine-grained permissions, gain more control over which repositories the application can access, and use short-lived tokens.
1516

1617
.. link:https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app[Register a GitHub App] with the following configuration:
17-
+
18+
1819
GitHub App name::
1920
Enter a unique name identifying your GitHub App, such as `integrating-with-rhdh-__<GUID>__`.
2021

@@ -77,7 +78,8 @@ Environments::::
7778
`Read & write` (if templates include GitHub Environments)
7879

7980
Organization permissions::
80-
* Enable `Read-only` access to *Members*.
81+
Members:::
82+
`Read-only`
8183

8284
Where can this GitHub App be installed?::
8385
Select `Only on this account`.
@@ -98,7 +100,7 @@ Select `Only on this account`.
98100

99101
. 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].
100102
You can use these secrets in the {product-short} configuration files by using their respective environment variable name.
101-
+
103+
102104
`GITHUB_INTEGRATION_APP_ID`::
103105
Enter the saved **App ID**.
104106
`GITHUB_INTEGRATION_CLIENT_ID`::

0 commit comments

Comments
 (0)