From 6736a0fdf265dcac734f7d814fccfecc1c1bc6fc Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 16 Feb 2021 09:12:50 -0500 Subject: [PATCH 1/3] Editorial changes --- docs/plugins/github-apps.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/plugins/github-apps.md b/docs/plugins/github-apps.md index 1cac85fbce..0bce6b940b 100644 --- a/docs/plugins/github-apps.md +++ b/docs/plugins/github-apps.md @@ -27,17 +27,15 @@ to grant the app more permissions if needed. ### Using the CLI (public GitHub only) -You can use the `backstage-cli` to create GitHub App' using a manifest file that +You can use the `backstage-cli` to create a 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. -You can read more about the `backstage-cli create-github-app` method -[here](../cli/commands.md#create-github-app) +You can read more about the [`backstage-cli create-github-app` method](../cli/commands.md#create-github-app). -Once you've gone through the CLI command, it should produce a `yaml` file in the +Once you've gone through the CLI command, it should produce a YAML file in the root of the project which you can then use as an `include` in your -`app-config.yaml`. You can go ahead and skip to -[here](#including-in-integrations-config) if you've got to this part. +`app-config.yaml`. You can go ahead and [skip ahead](#including-in-integrations-config) if you've already got an app. ### GitHub Enterprise @@ -46,9 +44,9 @@ You have to create the GitHub Application manually using these as GitHub Enterprise does not support creation of apps from manifests. Once the application is created you have to generate a private key for the -application it in a `yaml` file. +application and place it in in a YAML file. -The yaml file must include the following information. Please note that the +The YAML file must include the following information. Please note that the indentation for the `privateKey` is required. ```yaml @@ -64,7 +62,7 @@ privateKey: | ### Including in Integrations Config -Once the credentials are stored in a yaml file generated by `create-github-app` +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 `app-config.yaml` under the `integrations` section. From 6d6a5d6dfc3ccef8d3f512282e42270f63c240ef Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 16 Feb 2021 09:32:34 -0500 Subject: [PATCH 2/3] Fix prettier line lengths --- docs/plugins/github-apps.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/plugins/github-apps.md b/docs/plugins/github-apps.md index 0bce6b940b..a2ec5b5ce8 100644 --- a/docs/plugins/github-apps.md +++ b/docs/plugins/github-apps.md @@ -27,15 +27,17 @@ to grant the app more permissions if needed. ### Using the CLI (public GitHub only) -You can use the `backstage-cli` to create a 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. +You can use the `backstage-cli` to create a 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. -You can read more about the [`backstage-cli create-github-app` method](../cli/commands.md#create-github-app). +You can read more about the +[`backstage-cli create-github-app` method](../cli/commands.md#create-github-app). Once you've gone through the CLI command, it should produce a YAML file in the root of the project which you can then use as an `include` in your -`app-config.yaml`. You can go ahead and [skip ahead](#including-in-integrations-config) if you've already got an app. +`app-config.yaml`. You can go ahead and +[skip ahead](#including-in-integrations-config) if you've already got an app. ### GitHub Enterprise From 633416f5e6d51e8412939e377f976efcc1912d2b Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 16 Feb 2021 09:38:09 -0500 Subject: [PATCH 3/3] Fix typo --- docs/plugins/github-apps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/github-apps.md b/docs/plugins/github-apps.md index a2ec5b5ce8..27aec8a31f 100644 --- a/docs/plugins/github-apps.md +++ b/docs/plugins/github-apps.md @@ -46,7 +46,7 @@ You have to create the GitHub Application manually using these as GitHub Enterprise does not support creation of apps from manifests. Once the application is created you have to generate a private key for the -application and place it in in a YAML file. +application and place it in a YAML file. The YAML file must include the following information. Please note that the indentation for the `privateKey` is required.