From e6c37881971f28bf8a3f77f85425cb3e237141db Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Thu, 16 Mar 2023 21:40:58 -0400 Subject: [PATCH] Fix 16 "Low hanging fruit" spelling issues (#24409) Co-authored-by: Sarah Edwards --- .../configuring-your-enterprise/configuring-applications.md | 4 ++-- .../authenticating-as-a-github-app.md | 2 +- .../generating-a-user-access-token-for-a-github-app.md | 4 ++-- .../refreshing-user-access-tokens.md | 2 +- .../creating-github-apps/using-webhooks-with-github-apps.md | 2 +- ...shooting-your-migration-with-github-enterprise-importer.md | 2 +- ...between-github-products-with-github-enterprise-importer.md | 2 +- .../configuring-a-packages-access-control-and-visibility.md | 2 +- data/reusables/apps/web-app-flow-exchange-code.md | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-applications.md b/content/admin/configuration/configuring-your-enterprise/configuring-applications.md index 789c47deec..7eedded0b1 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-applications.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-applications.md @@ -30,7 +30,7 @@ You can enable a retention policy for checks, actions, and associated data by se {% data reusables.enterprise_site_admin_settings.management-console %} 1. In the "Settings" sidebar, click **Checks**. 2. Select **Enable archiving of Checks-related data**. -3. Under "Archive threshold (days)", type the number of days for the archival threshhold. Checks older than this number of days will be archived. -4. Under "Delete threshold (days)", type the number of days for the deletion threshhold. Archived checks older than this number of days will be permanently deleted. +3. Under "Archive threshold (days)", type the number of days for the archival threshold. Checks older than this number of days will be archived. +4. Under "Delete threshold (days)", type the number of days for the deletion threshold. Archived checks older than this number of days will be permanently deleted. {% data reusables.enterprise_management_console.save-settings %} {% endif %} diff --git a/content/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app.md b/content/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app.md index 81e50a9bd2..097e6dee30 100644 --- a/content/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app.md +++ b/content/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app.md @@ -44,7 +44,7 @@ You can use {% data variables.product.company_short %}'s Octokit.js SDK to authe - For user-owned apps, the settings page is `https://github.com/settings/apps/APP-SLUG`. - For organization-owned apps, the settings page is `https://github.com/organizations/ORGANIZATION/settings/apps/APP-SLUG`. - Replace `APP-SLUG` with the sluggified name of your app and `ORGANIZATION` with the sluggified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. + Replace `APP-SLUG` with the slugified name of your app and `ORGANIZATION` with the slugified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. 1. Generate a private key. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)." 1. Import `App` from `octokit`. diff --git a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md index 1f4a1dedfd..baf50f4c51 100644 --- a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md +++ b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md @@ -33,7 +33,7 @@ If your app runs in the browser, you should use the web application flow to gene Query parameter | Type | Description -----|------|------------ - `client_id` | `string` | **Required.** The client ID for your {% data variables.product.prodname_github_app %}. The client ID is different from the app ID. You can find the client ID on the settings page for your app.

For user-owned apps, the settings page is `https://github.com/settings/apps/APP-SLUG`.

For organization-owned apps, the settings page is `https://github.com/organizations/ORGANIZATION/settings/apps/APP-SLUG`.

Replace `APP-SLUG` with the sluggified name of your app and `ORGANIZATION` with the sluggified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. + `client_id` | `string` | **Required.** The client ID for your {% data variables.product.prodname_github_app %}. The client ID is different from the app ID. You can find the client ID on the settings page for your app.

For user-owned apps, the settings page is `https://github.com/settings/apps/APP-SLUG`.

For organization-owned apps, the settings page is `https://github.com/organizations/ORGANIZATION/settings/apps/APP-SLUG`.

Replace `APP-SLUG` with the slugified name of your app and `ORGANIZATION` with the slugified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. `redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to one of the URLs you provided as a "Callback URL" in your app's settings and can't contain any additional parameters. `state` | `string` | When specified, the value should contain a random string to protect against forgery attacks, and it can also contain any other arbitrary data. `login` | `string` | When specified, the web application flow will prompt users with a specific account they can use for signing in and authorizing your app. @@ -67,7 +67,7 @@ The device flow uses the OAuth 2.0 Device Authorization Grant. - For user-owned apps, the settings page is `https://github.com/settings/apps/APP-SLUG`. - For organization-owned apps, the settings page is `https://github.com/organizations/ORGANIZATION/settings/apps/APP-SLUG`. - Replace `APP-SLUG` with the sluggified name of your app and `ORGANIZATION` with the sluggified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. + Replace `APP-SLUG` with the slugified name of your app and `ORGANIZATION` with the slugified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. 1. {% data variables.product.company_short %} will respond with a response that includes the following parameters: diff --git a/content/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens.md b/content/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens.md index 442ac368c5..867f958001 100644 --- a/content/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens.md +++ b/content/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens.md @@ -50,7 +50,7 @@ If you opt into user access tokens that expire after you have already generated Query parameter | Type | Description -----|------|------------ - `client_id` | `string` | **Required.** The client ID for your {% data variables.product.prodname_github_app %}. The client ID is different from the app ID. You can find the client ID on the settings page for your app.

For user-owned apps, the settings page is `https://github.com/settings/apps/APP-SLUG`.

For organization-owned apps, the settings page is `https://github.com/organizations/ORGANIZATION/settings/apps/APP-SLUG`.

Replace `APP-SLUG` with the sluggified name of your app and `ORGANIZATION` with the sluggified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. + `client_id` | `string` | **Required.** The client ID for your {% data variables.product.prodname_github_app %}. The client ID is different from the app ID. You can find the client ID on the settings page for your app.

For user-owned apps, the settings page is `https://github.com/settings/apps/APP-SLUG`.

For organization-owned apps, the settings page is `https://github.com/organizations/ORGANIZATION/settings/apps/APP-SLUG`.

Replace `APP-SLUG` with the slugified name of your app and `ORGANIZATION` with the slugified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. `client_secret` | `string` | **Required.** The client secret for your {% data variables.product.prodname_github_app %}. You can generate a client secret on the settings page for your app. `grant_type` | `string` | **Required.** The value must be "refresh_token". `refresh_token` | `string` | **Required.** The refresh token that you received when you generated a user access token. diff --git a/content/apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps.md b/content/apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps.md index dee2afef61..1e13bbf7df 100644 --- a/content/apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps.md +++ b/content/apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps.md @@ -46,7 +46,7 @@ To handle a higher volume of webhook traffic for a large app in production, cons ## Securing your webhooks with a webhook secret -Once you've configured your server to recieve payloads, it will listen for any payload sent to the server. For security reasons, you should limit incoming requests to only those originating from {% data variables.product.prodname_dotcom %}. You can do that by creating a webhook secret for your app. +Once you've configured your server to receive payloads, it will listen for any payload sent to the server. For security reasons, you should limit incoming requests to only those originating from {% data variables.product.prodname_dotcom %}. You can do that by creating a webhook secret for your app. To create a webhook secret for your GitHub App, type a secret token in your app settings under "Webhook secret." You should choose a random string of text with high entropy. For more information about how to create a webhook secret in your app settings, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/creating-a-github-app)." diff --git a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md index 8aee259547..e3d7145a65 100644 --- a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md @@ -26,7 +26,7 @@ Before you investigate further, try these troubleshooting steps that commonly re 1. Verify that you're using the latest version of the {% data variables.product.prodname_cli %} extension you're using to migrate. If you're not, upgrade to the latest version. 1. Verify that you meet all the access requirements. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/preparing-to-migrate-with-github-enterprise-importer/managing-access-for-github-enterprise-importer)." 2. Try running the migration again. Some migrations issues are transient, and a second attempt may work. -3. Try running a migration on a different repository with similar data. This will help determine whether the issue is unique to the repository or represents a broader datashape problem. +3. Try running a migration on a different repository with similar data. This will help determine whether the issue is unique to the repository or represents a broader data shape problem. If these steps do not resolve your issue, review the migration logs for error messages. The log you need to check will depend on whether your migration failed or succeeded. diff --git a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer.md index 89657c207d..c86861d878 100644 --- a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer.md @@ -172,7 +172,7 @@ If you were using self-hosted runners or encrypted secrets, you must reconfigure - Add runners to the appropriate repository, organization, or enterprise. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/adding-self-hosted-runners)." - To use runners at the organization or enterprise level, update your workflows. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow)." -1. Re-add any encyrpted secrets. +1. Re-add any encrypted secrets. - To use the browser, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)." - To use {% data variables.product.prodname_cli %}, see [`gh secret`](https://cli.github.com/manual/gh_secret) in the {% data variables.product.prodname_cli %} documentation. diff --git a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 0f3f9e563e..b5fdd0db80 100644 --- a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -17,7 +17,7 @@ shortTitle: Access control & visibility A package can inherit its visibility and access permissions from a repository, or, for registries that support granular permissions, you can set the visibility and permissions of the package separately from a repository. -For the list of registries that support granular permisions, and for more information about permissions for packages, packages-related scopes for PATs, or managing permissions for your {% data variables.product.prodname_actions %} workflows, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages)." +For the list of registries that support granular permissions, and for more information about permissions for packages, packages-related scopes for PATs, or managing permissions for your {% data variables.product.prodname_actions %} workflows, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages)." {% else %} A package inherits the permissions and visibility of the repository in which the package is published. diff --git a/data/reusables/apps/web-app-flow-exchange-code.md b/data/reusables/apps/web-app-flow-exchange-code.md index 684ea72e6f..337c210593 100644 --- a/data/reusables/apps/web-app-flow-exchange-code.md +++ b/data/reusables/apps/web-app-flow-exchange-code.md @@ -2,7 +2,7 @@ Query parameter | Type | Description -----|------|------------ - `client_id` | `string` | **Required.** The client ID for your {% data variables.product.prodname_github_app %}. The client ID is different from the app ID. You can find the client ID on the settings page for your app.

For user-owned apps, the settings page is `https://github.com/settings/apps/APP-SLUG`.

For organization-owned apps, the settings page is `https://github.com/organizations/ORGANIZATION/settings/apps/APP-SLUG`.

Replace `APP-SLUG` with the sluggified name of your app and `ORGANIZATION` with the sluggified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. + `client_id` | `string` | **Required.** The client ID for your {% data variables.product.prodname_github_app %}. The client ID is different from the app ID. You can find the client ID on the settings page for your app.

For user-owned apps, the settings page is `https://github.com/settings/apps/APP-SLUG`.

For organization-owned apps, the settings page is `https://github.com/organizations/ORGANIZATION/settings/apps/APP-SLUG`.

Replace `APP-SLUG` with the slugified name of your app and `ORGANIZATION` with the slugified name of your organization. For example, `https://github.com/organizations/octo-org/settings/apps/octo-app`. `client_secret` | `string` | **Required.** The client secret for your {% data variables.product.prodname_github_app %}. You can generate a client secret on the settings page for your app. `code` | `string` | **Required.** The code you received in the previous step. `redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to one of the URLs you provided as a "Callback URL" when setting up your {% data variables.product.prodname_github_app %} and can't contain any additional parameters.