From 5927bf864fda2b66563418b313b66612c3baa8c5 Mon Sep 17 00:00:00 2001
From: Brian Fletcher <brian@roadie.io>
Date: Fri, 6 Aug 2021 10:22:33 +0100
Subject: [PATCH] Makes some suggested documentation improvements

Signed-off-by: Brian Fletcher <brian@roadie.io>
---
 docs/plugins/github-apps.md               | 2 +-
 packages/integration/src/github/config.ts | 6 +++++-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/docs/plugins/github-apps.md b/docs/plugins/github-apps.md
index 8d86c03220..f9f7590e09 100644
--- a/docs/plugins/github-apps.md
+++ b/docs/plugins/github-apps.md
@@ -96,7 +96,7 @@ optionally include the `allowedInstallationOwners` option.
 
 ```yaml
 appId: 1
-allowedInstallationOwners: [1234]
+allowedInstallationOwners: ['GlobexCorp']
 clientId: client id
 clientSecret: client secret
 webhookSecret: webhook secret
diff --git a/packages/integration/src/github/config.ts b/packages/integration/src/github/config.ts
index d16e8897a7..4ecac99295 100644
--- a/packages/integration/src/github/config.ts
+++ b/packages/integration/src/github/config.ts
@@ -94,7 +94,11 @@ export type GithubAppConfig = {
    */
   clientSecret: string;
   /**
-   * List of installation owners allowed to be used by this backstage https://github.com/app/installations/$InstallationId
+   * List of installation owners allowed to be used by this GitHub app. The GitHub UI does not provide a way to list the installations.
+   * However you can list the installations with the GitHub API. You can find the list of installations here:
+   * https://api.github.com/app/installations
+   * The relevant documentation for this is here.
+   * https://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app--code-samples
    */
   allowedInstallationOwners?: string[];
 };