diff --git a/docs/plugins/github-apps.md b/docs/plugins/github-apps.md index 0710f59158..def9e32f4a 100644 --- a/docs/plugins/github-apps.md +++ b/docs/plugins/github-apps.md @@ -5,12 +5,12 @@ come with advantages such as higher rate limits and that Backstage can act as an application instead of a user or bot account. It also provides a much clearer and better authorization model as a opposed to -the oauth apps and their respective scopes. +the OAuth apps and their respective scopes. ## Caveats - It's not possible to have multiple backstage GitHub Apps installed in the same - Github organization be managed by Backstage. We currently don't check through + GitHub organization be managed by Backstage. We currently don't check through all the registered GitHub Apps to see which ones are installed for a particular repository. We just respect global Organization installs right now. - App permissions is not managed by Backstage. They're created with some simple @@ -29,7 +29,7 @@ to grant the app more permissions if needed. You can use the `backstage-cli` to create GitHub App' using a manifest file that we provide. This gives us a way to automate some of the work required to create -a github app. +a GitHub app. You can read more about the `backstage-cli create-github-app` method [here](../cli/commands.md#create-github-app) @@ -66,7 +66,7 @@ privateKey: | Once the credentials are stored in a `yaml` file generated by `create-github-app` or manually by following the -[Github Enterprise](#gitHub-enterprise) instructions they can be included in the +[GitHub Enterprise](#gitHub-enterprise) instructions they can be included in the `app-config.yaml` under the integrations section. ```yaml