diff --git a/assets/images/github-apps/authorize-app.png b/assets/images/github-apps/authorize-app.png new file mode 100644 index 000000000000..82d42f2965da Binary files /dev/null and b/assets/images/github-apps/authorize-app.png differ diff --git a/assets/images/github-apps/github-apps-private-key-fingerprint.png b/assets/images/github-apps/github-apps-private-key-fingerprint.png new file mode 100644 index 000000000000..4a20b377bc7a Binary files /dev/null and b/assets/images/github-apps/github-apps-private-key-fingerprint.png differ diff --git a/assets/images/github-apps/install-app.png b/assets/images/github-apps/install-app.png new file mode 100644 index 000000000000..58af87cd85a2 Binary files /dev/null and b/assets/images/github-apps/install-app.png differ diff --git a/assets/images/help/profile/top-right-avatar.png b/assets/images/help/profile/top-right-avatar.png new file mode 100644 index 000000000000..23227d500a72 Binary files /dev/null and b/assets/images/help/profile/top-right-avatar.png differ diff --git a/assets/images/help/saml/saml-recovery-codes.png b/assets/images/help/saml/saml-recovery-codes.png new file mode 100644 index 000000000000..2d52b3425749 Binary files /dev/null and b/assets/images/help/saml/saml-recovery-codes.png differ diff --git a/assets/images/help/search/advanced-search.png b/assets/images/help/search/advanced-search.png new file mode 100644 index 000000000000..1e2c08254a9e Binary files /dev/null and b/assets/images/help/search/advanced-search.png differ diff --git a/assets/images/help/settings/email-primary.png b/assets/images/help/settings/email-primary.png new file mode 100644 index 000000000000..9ee898d5a6d5 Binary files /dev/null and b/assets/images/help/settings/email-primary.png differ diff --git a/assets/images/help/settings/personal-access-tokens.png b/assets/images/help/settings/personal-access-tokens.png new file mode 100644 index 000000000000..58a0177f5333 Binary files /dev/null and b/assets/images/help/settings/personal-access-tokens.png differ diff --git a/assets/images/help/site-policy/lynn-hashimoto.png b/assets/images/help/site-policy/lynn-hashimoto.png new file mode 100644 index 000000000000..8be24122e5ee Binary files /dev/null and b/assets/images/help/site-policy/lynn-hashimoto.png differ diff --git a/assets/images/help/webhooks/payload-request-tab.png b/assets/images/help/webhooks/payload-request-tab.png new file mode 100644 index 000000000000..52f7c32124fd Binary files /dev/null and b/assets/images/help/webhooks/payload-request-tab.png differ diff --git a/assets/images/help/webhooks/payload-response-tab.png b/assets/images/help/webhooks/payload-response-tab.png new file mode 100644 index 000000000000..f8b6419433ba Binary files /dev/null and b/assets/images/help/webhooks/payload-response-tab.png differ diff --git a/assets/images/help/webhooks/webhooks-recent-deliveries.png b/assets/images/help/webhooks/webhooks-recent-deliveries.png new file mode 100644 index 000000000000..05ca8bd7b12f Binary files /dev/null and b/assets/images/help/webhooks/webhooks-recent-deliveries.png differ diff --git a/assets/images/settings/apps-choose-app.png b/assets/images/settings/apps-choose-app.png new file mode 100644 index 000000000000..77236c981ae9 Binary files /dev/null and b/assets/images/settings/apps-choose-app.png differ diff --git a/assets/images/settings/github-apps.png b/assets/images/settings/github-apps.png new file mode 100644 index 000000000000..a6107694c9f6 Binary files /dev/null and b/assets/images/settings/github-apps.png differ diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md index 76f8482f04fb..fd413dd9cdf0 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md @@ -54,7 +54,7 @@ To configure provisioning for your {% data variables.enterprise.prodname_emu_ent 4. Click **Generate token**. 5. To copy the token to your clipboard, click {% octicon "copy" aria-label="Copy token" %}. - ![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal_access_tokens.png) + ![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal-access-tokens.png) 6. To save the token for use later, store the new token securely in a password manager. ## Configuring provisioning for {% data variables.product.prodname_emus %} diff --git a/content/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps.md b/content/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps.md index fa56f0e4fd69..ac05b7313959 100644 --- a/content/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps.md +++ b/content/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps.md @@ -44,7 +44,7 @@ To verify a private key: 1. Find the fingerprint for the private and public key pair you want to verify in the "Private keys" section of the settings page for your {% data variables.product.prodname_github_app %}. For more information, see "[Generating private keys](#generating-private-keys)". - ![Screenshot of a private key in a {% data variables.product.prodname_github_app %} settings page. The fingerprint, the part of the private key after the colon, is outlined in dark orange.](/assets/images/github-apps/github_apps_private_key_fingerprint.png) + ![Screenshot of a private key in a {% data variables.product.prodname_github_app %} settings page. The fingerprint, the part of the private key after the colon, is outlined in dark orange.](/assets/images/github-apps/github-apps-private-key-fingerprint.png) 1. Generate the fingerprint of your private key (PEM) locally by using the following command: ```shell $ openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64 diff --git a/content/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md b/content/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md index 71631bfef48c..44da3740edc1 100644 --- a/content/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md +++ b/content/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md @@ -44,7 +44,7 @@ To create a {% data variables.product.prodname_marketplace %} listing: {% endnote %} - ![Screenshot of the sidebar on the "Developer Settings" page of {% data variables.product.prodname_dotcom %}. Options labeled "{% data variables.product.prodname_github_apps %}" and "{% data variables.product.prodname_oauth_apps %}" are outlined in dark orange.](/assets/images/settings/apps_choose_app.png) + ![Screenshot of the sidebar on the "Developer Settings" page of {% data variables.product.prodname_dotcom %}. Options labeled "{% data variables.product.prodname_github_apps %}" and "{% data variables.product.prodname_oauth_apps %}" are outlined in dark orange.](/assets/images/settings/apps-choose-app.png) 4. Select the app you'd like to add to {% data variables.product.prodname_marketplace %}. {% data reusables.user-settings.edit_marketplace_listing %} diff --git a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md index 5695a5f63cfe..19f7c5d561b3 100644 --- a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md +++ b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md @@ -142,7 +142,7 @@ If you selected an organization as the resource owner and the organization requi 8. Click **Generate token**. 1. Optionally, to copy the new token to your clipboard, click {% octicon "copy" aria-label="Copy token" %}. - ![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal_access_tokens.png){% ifversion fpt or ghec %} + ![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal-access-tokens.png){% ifversion fpt or ghec %} 1. To use your token to access resources owned by an organization that uses SAML single sign-on, authorize the token. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}{% endif %} ## Deleting a {% data variables.product.pat_generic %} diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md index 4613a5add54a..68b028eab663 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md @@ -19,7 +19,7 @@ Recovery codes should not be shared or distributed. We recommend saving them wit {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} 5. Under "SAML single sign-on", in the note about recovery codes, click **Save your recovery codes**. - ![Screenshot of the "SAML single sign-on" section. A link, labeled "Save your recovery codes," is highlighted with an orange outline.](/assets/images/help/saml/saml_recovery_codes.png) + ![Screenshot of the "SAML single sign-on" section. A link, labeled "Save your recovery codes," is highlighted with an orange outline.](/assets/images/help/saml/saml-recovery-codes.png) 6. To save your recovery codes, click **Download**, **Print**, or **Copy**. {% note %} diff --git a/content/rest/guides/best-practices-for-integrators.md b/content/rest/guides/best-practices-for-integrators.md index 780fe42b1028..4f2816b94644 100644 --- a/content/rest/guides/best-practices-for-integrators.md +++ b/content/rest/guides/best-practices-for-integrators.md @@ -39,7 +39,7 @@ Note that even with a background job running, GitHub still expects your server t Every webhook has its own "Recent Deliveries" section, which lists whether a deployment was successful or not. -![Screenshot of the "Recent Deliveries" tab on the "Manage webhook" page.](/assets/images/help/webhooks/webhooks_recent_deliveries.png) +![Screenshot of the "Recent Deliveries" tab on the "Manage webhook" page.](/assets/images/help/webhooks/webhooks-recent-deliveries.png) You should make use of proper HTTP status codes in order to inform users. You can use codes like `201` or `202` to acknowledge receipt of payload that won't be processed (for example, a payload delivered by a branch that's not the default). Reserve the `500` error code for catastrophic failures. @@ -47,7 +47,7 @@ You should make use of proper HTTP status codes in order to inform users. You ca Users can dig into the server responses you send back to GitHub. Ensure that your messages are clear and informative. -![Screenshot of the "Response" tab of a webhook delivery, including the "Headers" and "Body" sections.](/assets/images/help/webhooks/payload_response_tab.png) +![Screenshot of the "Response" tab of a webhook delivery, including the "Headers" and "Body" sections.](/assets/images/help/webhooks/payload-response-tab.png) ## Follow any redirects that the API sends you diff --git a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index 845354b9a6ce..fd32cfbc99ca 100644 --- a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -71,7 +71,7 @@ In addition to the search bar, you can search {% data variables.product.product_ The {% data variables.search.advanced_url %} provides a visual interface for constructing search queries. You can filter your searches by a variety of factors, such as the number of stars or number of forks a repository has. As you fill in the advanced search fields, your query will automatically be constructed in the top search bar. -![Screenshot of the Advanced search page. The top search bar is filled in with the query "kittens user:octocat" and, under the "Advanced options" section below, the "From these owners" text box contains the term "octocat" and is outlined in dark orange.](/assets/images/help/search/advanced_search.png) +![Screenshot of the Advanced search page. The top search bar is filled in with the query "kittens user:octocat" and, under the "Advanced options" section below, the "From these owners" text box contains the term "octocat" and is outlined in dark orange.](/assets/images/help/search/advanced-search.png) ## Searching repositories on {% data variables.product.prodname_dotcom_the_website %} from your private enterprise environment diff --git a/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md b/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md index 522f361740c0..0992a40e1e9a 100644 --- a/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md +++ b/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md @@ -352,7 +352,7 @@ Signature of GitHub, Inc. appears below. Signing the Standard Contractual Clauses, Appendix 1 and Appendix 2 on behalf of the data importer -![Lynn Hashimoto's signature.](/assets/images/help/site-policy/lynn_hashimoto.png) +![Lynn Hashimoto's signature.](/assets/images/help/site-policy/lynn-hashimoto.png) Lynn Hashimoto, Head of Product & Regulatory Legal diff --git a/content/webhooks-and-events/webhooks/testing-webhooks.md b/content/webhooks-and-events/webhooks/testing-webhooks.md index d0c0c0f36c35..545bdaa5e161 100644 --- a/content/webhooks-and-events/webhooks/testing-webhooks.md +++ b/content/webhooks-and-events/webhooks/testing-webhooks.md @@ -24,7 +24,7 @@ Every webhook has its own "Recent Deliveries" section, which lists, at a glance {% data variables.product.product_name %} keeps a log of each webhook delivery for {% ifversion fpt or ghec %} 30 {% else %} 8 {% endif %} days. -![Screenshot of the "Recent Deliveries" tab on the "Manage webhook" page.](/assets/images/help/webhooks/webhooks_recent_deliveries.png) +![Screenshot of the "Recent Deliveries" tab on the "Manage webhook" page.](/assets/images/help/webhooks/webhooks-recent-deliveries.png) ## Digging into results @@ -37,7 +37,7 @@ both the HTTP Request and Response. The webhook delivery view provides information on which Headers were sent by GitHub. It also includes details about the JSON payload. -![Screenshot of the "Request" tab of a webhook delivery, including the "Headers" and "Payload" sections.](/assets/images/help/webhooks/payload_request_tab.png) +![Screenshot of the "Request" tab of a webhook delivery, including the "Headers" and "Payload" sections.](/assets/images/help/webhooks/payload-request-tab.png) ### Response @@ -45,4 +45,4 @@ The response tab lists how your server replied once it received the payload from GitHub. This includes the status code, the headers, and any additional data within the response body. -![Screenshot of the "Response" tab of a webhook delivery, including the "Headers" and "Body" sections.](/assets/images/help/webhooks/payload_response_tab.png) +![Screenshot of the "Response" tab of a webhook delivery, including the "Headers" and "Body" sections.](/assets/images/help/webhooks/payload-response-tab.png) diff --git a/data/reusables/apps/install-vs-authorize.md b/data/reusables/apps/install-vs-authorize.md index 179b7ebd76aa..5b4920698e10 100644 --- a/data/reusables/apps/install-vs-authorize.md +++ b/data/reusables/apps/install-vs-authorize.md @@ -3,12 +3,12 @@ When you **install** a {% data variables.product.prodname_github_app %} on your For example, you might grant the {% data variables.product.prodname_github_app %} permission to read repository metadata and write issues, and you might grant the {% data variables.product.prodname_github_app %} access to all of your repositories. -![Screenshot of the page to install a GitHub App. The app is requesting read access to metadata and write access to issues. The app can also request user authorization for read access to emails and write access to gists.](/assets/images/github-apps/install_app.png) +![Screenshot of the page to install a GitHub App. The app is requesting read access to metadata and write access to issues. The app can also request user authorization for read access to emails and write access to gists.](/assets/images/github-apps/install-app.png) When you **authorize** a {% data variables.product.prodname_github_app %}, you grant the app access to your {% data variables.product.prodname_dotcom %} account, based on the account permissions the app requested. During the authorization process, the app will indicate which resources the app can access on your account. When you authorize a {% data variables.product.prodname_github_app %}, you also grant the app permission to act on your behalf. For example, you might grant the {% data variables.product.prodname_github_app %} permission to read your email addresses and write gists. -![Screenshot of the page to authorize a GitHub App. The app is requesting read access to email and write access to gists.](/assets/images/github-apps/authorize_app.png) +![Screenshot of the page to authorize a GitHub App. The app is requesting read access to email and write access to gists.](/assets/images/github-apps/authorize-app.png) You can install a {% data variables.product.prodname_github_app %} without authorizing the app. Similarly, you can authorize the app without installing the app. diff --git a/data/reusables/package_registry/package-settings-from-user-level.md b/data/reusables/package_registry/package-settings-from-user-level.md index f7e713477966..e30f70e2bdef 100644 --- a/data/reusables/package_registry/package-settings-from-user-level.md +++ b/data/reusables/package_registry/package-settings-from-user-level.md @@ -1,5 +1,5 @@ 1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your personal account. 2. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. - ![Screenshot of the dropdown menu under @octocat's profile picture. "Your profile" is outlined in dark orange.](/assets/images/help/profile/top_right_avatar.png) + ![Screenshot of the dropdown menu under @octocat's profile picture. "Your profile" is outlined in dark orange.](/assets/images/help/profile/top-right-avatar.png) 3. On your profile page, in the header, click the {% octicon "package" aria-hidden="true" %} **Packages** tab. diff --git a/data/reusables/profile/access_profile.md b/data/reusables/profile/access_profile.md index 3b410b22f10a..f0b6f1498c59 100644 --- a/data/reusables/profile/access_profile.md +++ b/data/reusables/profile/access_profile.md @@ -1,4 +1,4 @@ {% ifversion fpt or ghec %}1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. - ![Screenshot of the dropdown menu under @octocat's profile picture. "Your profile" is outlined in dark orange.](/assets/images/help/profile/top_right_avatar.png){% else %} + ![Screenshot of the dropdown menu under @octocat's profile picture. "Your profile" is outlined in dark orange.](/assets/images/help/profile/top-right-avatar.png){% else %} 1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**.{% endif %} diff --git a/data/reusables/user-settings/marketplace_apps.md b/data/reusables/user-settings/marketplace_apps.md index 23b8d5cbd5d6..7f3a9d0159b1 100644 --- a/data/reusables/user-settings/marketplace_apps.md +++ b/data/reusables/user-settings/marketplace_apps.md @@ -7,6 +7,6 @@ {% endnote %} - ![Screenshot of the sidebar on the "Developer Settings" page of {% data variables.product.prodname_dotcom %}. Options labeled "{% data variables.product.prodname_github_apps %}" and "{% data variables.product.prodname_oauth_apps %}" are outlined in dark orange.](/assets/images/settings/apps_choose_app.png) + ![Screenshot of the sidebar on the "Developer Settings" page of {% data variables.product.prodname_dotcom %}. Options labeled "{% data variables.product.prodname_github_apps %}" and "{% data variables.product.prodname_oauth_apps %}" are outlined in dark orange.](/assets/images/settings/apps-choose-app.png) {% endif %} diff --git a/data/reusables/user-settings/select_primary_email.md b/data/reusables/user-settings/select_primary_email.md index fa54203ef48a..ff0ac32fcb6d 100644 --- a/data/reusables/user-settings/select_primary_email.md +++ b/data/reusables/user-settings/select_primary_email.md @@ -1,3 +1,3 @@ 1. In the "Primary email address" dropdown menu, select the email address you'd like to associate with your web-based Git operations. - ![Screenshot of the "Email" settings page. Under "Primary email address," a dropdown menu, labeled with Octocat's email address, is outlined in orange.](/assets/images/help/settings/email_primary.png) + ![Screenshot of the "Email" settings page. Under "Primary email address," a dropdown menu, labeled with Octocat's email address, is outlined in orange.](/assets/images/help/settings/email-primary.png) diff --git a/src/content-linter/README.md b/src/content-linter/README.md index b8fb8250cf37..ce79e8226e09 100644 --- a/src/content-linter/README.md +++ b/src/content-linter/README.md @@ -17,6 +17,7 @@ We are using the [markdownlint](https://github.com/DavidAnson/markdownlint) fram | [MD022](https://github.com/DavidAnson/markdownlint/blob/main/doc/md022.md) | Headings must be surrounded by a blank line. | warning | | [MD023](https://github.com/DavidAnson/markdownlint/blob/main/doc/md023.md) | Headings must start at the beginning of the line. | error | | [MD024](https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md) | Disallow headings with the same content. | error | +| [MD027](https://github.com/DavidAnson/markdownlint/blob/main/doc/md027.md) | Catches multiple spaces after blockquote symbol. | warning | | [MD011](https://github.com/DavidAnson/markdownlint/blob/main/doc/md011.md) | Make sure that link syntax is not reversed. | error | | [MD111](./linting-rules/image-alt-text-length.js) | Images alternate text should be between 40-150 characters. | warning | | [MD112](./linting-rules/image-alt-text-end-punctuation.js) | Images alternate text should end with a punctuation. | error | diff --git a/src/content-linter/scripts/markdownlint.js b/src/content-linter/scripts/markdownlint.js index 57ebddc00ed8..0ca4bc28a818 100755 --- a/src/content-linter/scripts/markdownlint.js +++ b/src/content-linter/scripts/markdownlint.js @@ -38,6 +38,7 @@ async function main() { MD022: true, MD023: true, MD024: true, + MD027: true, MD111: true, MD112: true, MD113: true,