BIN
assets/images/github-apps/authorize-app.png
Normal file
|
After Width: | Height: | Size: 123 KiB |
|
After Width: | Height: | Size: 38 KiB |
BIN
assets/images/github-apps/install-app.png
Normal file
|
After Width: | Height: | Size: 136 KiB |
BIN
assets/images/help/profile/top-right-avatar.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
assets/images/help/saml/saml-recovery-codes.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
BIN
assets/images/help/search/advanced-search.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
assets/images/help/settings/email-primary.png
Normal file
|
After Width: | Height: | Size: 117 KiB |
BIN
assets/images/help/settings/personal-access-tokens.png
Normal file
|
After Width: | Height: | Size: 17 KiB |
BIN
assets/images/help/site-policy/lynn-hashimoto.png
Normal file
|
After Width: | Height: | Size: 6.6 KiB |
BIN
assets/images/help/webhooks/payload-request-tab.png
Normal file
|
After Width: | Height: | Size: 109 KiB |
BIN
assets/images/help/webhooks/payload-response-tab.png
Normal file
|
After Width: | Height: | Size: 67 KiB |
BIN
assets/images/help/webhooks/webhooks-recent-deliveries.png
Normal file
|
After Width: | Height: | Size: 70 KiB |
BIN
assets/images/settings/apps-choose-app.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
assets/images/settings/github-apps.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
@@ -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" %}.
|
||||
|
||||

|
||||

|
||||
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 %}
|
||||
|
||||
@@ -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)".
|
||||
|
||||

|
||||

|
||||
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
|
||||
|
||||
@@ -44,7 +44,7 @@ To create a {% data variables.product.prodname_marketplace %} listing:
|
||||
|
||||
{% endnote %}
|
||||
|
||||

|
||||

|
||||
|
||||
4. Select the app you'd like to add to {% data variables.product.prodname_marketplace %}.
|
||||
{% data reusables.user-settings.edit_marketplace_listing %}
|
||||
|
||||
@@ -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" %}.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
{% 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 %}
|
||||
|
||||
@@ -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**.
|
||||

|
||||

|
||||
6. To save your recovery codes, click **Download**, **Print**, or **Copy**.
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -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.
|
||||
|
||||

|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||

|
||||
|
||||
## Follow any redirects that the API sends you
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||

|
||||

|
||||
|
||||
## Searching repositories on {% data variables.product.prodname_dotcom_the_website %} from your private enterprise environment
|
||||
|
||||
|
||||
@@ -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, Head of Product & Regulatory Legal
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||

|
||||

|
||||
|
||||
## 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.
|
||||
|
||||

|
||||

|
||||
|
||||
### 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.
|
||||
|
||||

|
||||

|
||||
|
||||
@@ -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.
|
||||
|
||||

|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||

|
||||
|
||||
You can install a {% data variables.product.prodname_github_app %} without authorizing the app. Similarly, you can authorize the app without installing the app.
|
||||
|
||||
@@ -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**.
|
||||
|
||||

|
||||

|
||||
3. On your profile page, in the header, click the {% octicon "package" aria-hidden="true" %} **Packages** tab.
|
||||
|
||||
@@ -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**.
|
||||
|
||||
{% else %}
|
||||
{% 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 %}
|
||||
|
||||
@@ -7,6 +7,6 @@
|
||||
|
||||
{% endnote %}
|
||||
|
||||

|
||||

|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -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.
|
||||
|
||||

|
||||

|
||||
|
||||
@@ -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 |
|
||||
|
||||
@@ -38,6 +38,7 @@ async function main() {
|
||||
MD022: true,
|
||||
MD023: true,
|
||||
MD024: true,
|
||||
MD027: true,
|
||||
MD111: true,
|
||||
MD112: true,
|
||||
MD113: true,
|
||||
|
||||