diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository.md index 1d5bb0f9e373..26f541bf46ae 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository.md @@ -54,7 +54,8 @@ The repository owner has full control of the repository. In addition to the acti | Create security advisories | "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories)" | | Display a sponsor button | "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %} | Allow or disallow auto-merge for pull requests | "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository)" | -| Manage webhooks and deploy keys | "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys)" | +| Manage deploy keys | "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys)" | +| Manage webhooks | "[AUTOTITLE](/webhooks/about-webhooks)" | ## Collaborator access for a repository owned by a personal account diff --git a/content/actions/automating-builds-and-tests/about-continuous-integration.md b/content/actions/automating-builds-and-tests/about-continuous-integration.md index baacbe54944e..1d2189b86932 100644 --- a/content/actions/automating-builds-and-tests/about-continuous-integration.md +++ b/content/actions/automating-builds-and-tests/about-continuous-integration.md @@ -51,6 +51,7 @@ For a definition of common terms, see "[AUTOTITLE](/actions/learn-github-actions Browse the complete list of CI starter workflow offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.location.product_location %}{% endif %}. {% ifversion fpt or ghec %} + ## Further reading - "[AUTOTITLE](/billing/managing-billing-for-github-actions)" diff --git a/content/actions/examples/using-concurrency-expressions-and-a-test-matrix.md b/content/actions/examples/using-concurrency-expressions-and-a-test-matrix.md index de0ae8f82dd6..cd3c69740c91 100644 --- a/content/actions/examples/using-concurrency-expressions-and-a-test-matrix.md +++ b/content/actions/examples/using-concurrency-expressions-and-a-test-matrix.md @@ -45,6 +45,7 @@ topics: | Running tests on the runner | `npm test`| ## Example workflow + The following workflow was created by the {% data variables.product.prodname_dotcom %} Docs Engineering team. The workflow runs tests against the code in a pull request. To review the latest version of this file in the [`github/docs`](https://github.com/github/docs) repository, see [`test.yml`](https://github.com/github/docs/blob/main/.github/workflows/test.yml). ```yaml annotate copy diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md index d98907051584..69b74d809624 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -46,6 +46,7 @@ type: tutorial {% endif %} {% ifversion ghec or ghes or ghae %} + ## Changing which organizations can access a runner group {%- ifversion fpt or ghec or ghes %} @@ -110,12 +111,14 @@ You can edit the name of your runner groups at the enterprise and organization l - [Changing the name of an enterprise runner group](#changing-the-name-of-an-enterprise-runner-group) ### Changing the name of an organization runner group + {% endif %} {% data reusables.actions.runner-groups-org-navigation %} {% data reusables.actions.changing-the-name-of-a-runner-group %} {% ifversion ghes or ghec or ghae %} + ### Changing the name of an enterprise runner group {% data reusables.actions.runner-groups-enterprise-navigation %} @@ -135,6 +138,7 @@ You can edit the name of your runner groups at the enterprise and organization l - [Moving an enterprise runner to a group](#moving-an-enterprise-runner-to-a-group) ### Moving an organization runner to a group + {% endif %} {% data reusables.organizations.navigate-to-org %} @@ -143,6 +147,7 @@ You can edit the name of your runner groups at the enterprise and organization l {% data reusables.actions.moving-a-runner-to-a-group %} {% ifversion ghes or ghec or ghae %} + ### Moving an enterprise runner to a group {% data reusables.enterprise-accounts.access-enterprise %} @@ -161,12 +166,14 @@ You can edit the name of your runner groups at the enterprise and organization l - [Removing a runner group from an enterprise](#removing-a-runner-group-from-an-enterprise) ### Removing a runner group from an organization + {% endif %} {% data reusables.actions.runner-groups-org-navigation %} {% data reusables.actions.removing-a-runner-group %} {% ifversion ghes or ghec or ghae %} + ### Removing a runner group from an enterprise {% data reusables.actions.runner-groups-enterprise-navigation %} diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners.md index 7a2d78976423..78ed8a376699 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners.md @@ -37,6 +37,7 @@ You can create custom labels for runners at the repository{% ifversion ghec or g {% data reusables.actions.self-hosted-runners-create-label-steps %} {% ifversion ghec or ghes or ghae %} + ### Creating a custom label for an enterprise runner {% data reusables.enterprise-accounts.access-enterprise %} @@ -46,6 +47,7 @@ You can create custom labels for runners at the repository{% ifversion ghec or g {% data reusables.actions.self-hosted-runners-create-label-steps %} {% endif %} + ## Assigning a label to a self-hosted runner You can assign labels to self-hosted runners at the repository{% ifversion ghec or ghes or ghae %}, organization, and enterprise{% else %} and organization{% endif %} levels. @@ -65,6 +67,7 @@ You can assign labels to self-hosted runners at the repository{% ifversion ghec {% data reusables.actions.self-hosted-runner-assign-label-steps %} {% ifversion ghec or ghes or ghae %} + ### Assigning a label to an enterprise runner {% data reusables.enterprise-accounts.access-enterprise %} @@ -75,6 +78,7 @@ You can assign labels to self-hosted runners at the repository{% ifversion ghec {% data reusables.actions.self-hosted-runner-assign-label-steps %} {% endif %} + ## Removing a custom label from a self-hosted runner You can remove custom labels from self-hosted runners at the repository{% ifversion ghec or ghes or ghae %}, organization, and enterprise{% else %} and organization{% endif %} levels. @@ -94,6 +98,7 @@ You can remove custom labels from self-hosted runners at the repository{% ifvers {% data reusables.actions.self-hosted-runner-remove-label-steps %} {% ifversion ghec or ghes or ghae %} + ### Removing a custom label from an enterprise runner {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners.md b/content/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners.md index e4039d9b5188..bc4633aeb74b 100644 --- a/content/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners.md +++ b/content/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners.md @@ -50,6 +50,7 @@ For example, the following diagram has a runner group named `grp-ubuntu-20.04-16 {% data reusables.actions.section-using-unique-names-for-runner-groups %} {% ifversion ghec %} + ## Changing which organizations can access a runner group {% data reusables.actions.hosted-runner-security-admonition %} @@ -112,12 +113,14 @@ You can rename runner groups at the enterprise and organization levels. - [Changing the name of an enterprise runner group](##changing-the-name-of-an-enterprise-runner-group) ### Changing the name of an organization runner group + {% endif %} {% data reusables.actions.runner-groups-org-navigation %} {% data reusables.actions.changing-the-name-of-a-runner-group %} {% ifversion ghec %} + ### Changing the name of an enterprise runner group {% data reusables.actions.runner-groups-enterprise-navigation %} @@ -133,6 +136,7 @@ You can rename runner groups at the enterprise and organization levels. - [Moving an enterprise runner to a group](#moving-an-enterprise-runner-to-a-group) ### Moving an organization runner to a group + {% endif %} {% data reusables.organizations.navigate-to-org %} @@ -141,6 +145,7 @@ You can rename runner groups at the enterprise and organization levels. {% data reusables.actions.moving-a-runner-to-a-group %} {% ifversion ghec %} + ### Moving an enterprise runner to a group {% data reusables.enterprise-accounts.access-enterprise %} @@ -159,12 +164,14 @@ You can rename runner groups at the enterprise and organization levels. - [Removing a runner group from an enterprise](#removing-a-runner-group-from-an-enterprise) ### Removing a runner group from an organization + {% endif %} {% data reusables.actions.runner-groups-org-navigation %} {% data reusables.actions.removing-a-runner-group %} {% ifversion ghec %} + ### Removing a runner group from an enterprise {% data reusables.actions.runner-groups-enterprise-navigation %} diff --git a/content/actions/using-github-hosted-runners/about-larger-runners/managing-larger-runners.md b/content/actions/using-github-hosted-runners/about-larger-runners/managing-larger-runners.md index d9b2ca578f9f..7a94a398cfa3 100644 --- a/content/actions/using-github-hosted-runners/about-larger-runners/managing-larger-runners.md +++ b/content/actions/using-github-hosted-runners/about-larger-runners/managing-larger-runners.md @@ -10,6 +10,7 @@ redirect_from: --- {% ifversion ghec %} + ## Adding a {% data variables.actions.hosted_runner %} to an enterprise Enterprise owners can add {% data variables.actions.hosted_runner %}s to an enterprise and assign them to organizations. By default, when a {% data variables.actions.hosted_runner %} is created for an enterprise, it is added to a default runner group that all organizations in the enterprise have access to. While all organizations are granted access to the runner, the repositories in each organization **are not** granted access. For each organization, an organization owner must configure the runner group to specify which repositories have access to the enterprise runner. For more information, see "[Allowing repositories to access a runner group](#allowing-repositories-to-access-a-runner-group)." @@ -69,6 +70,7 @@ You can edit the name of your {% data variables.actions.hosted_runner %}s. - [Changing the name of an enterprise runner](#changing-the-name-of-an-enterprise-runner) ### Changing the name of an organization runner + {% endif %} {% data reusables.organizations.navigate-to-org %} @@ -78,6 +80,7 @@ You can edit the name of your {% data variables.actions.hosted_runner %}s. {% data reusables.actions.rename-larger-runner %} {% ifversion ghec %} + ### Changing the name of an enterprise runner {% data reusables.enterprise-accounts.access-enterprise %} @@ -95,7 +98,9 @@ You can control the maximum number of jobs allowed to run concurrently for speci {% ifversion ghec %} - [Configuring autoscaling for an organization runner](#configuring-autoscaling-for-an-organization-runner) - [Configuring autoscaling for an enterprise runner](#configuring-autoscaling-for-an-enterprise-runner) + ### Configuring autoscaling for an organization runner + {% endif %} {% data reusables.organizations.navigate-to-org %} @@ -105,6 +110,7 @@ You can control the maximum number of jobs allowed to run concurrently for speci {% data reusables.actions.configure-autoscaling-for-larger-runners %} {% ifversion ghec %} + ### Configuring autoscaling for an enterprise runner {% data reusables.enterprise-accounts.access-enterprise %} @@ -133,6 +139,7 @@ The number of available IP addresses in the assigned ranges does not restrict nu - [Creating static IP addresses for enterprise runners](#creating-static-ip-addresses-for-enterprise-runners) ### Creating static IP addresses for organization runners + {% endif %} {% data reusables.organizations.navigate-to-org %} @@ -142,6 +149,7 @@ The number of available IP addresses in the assigned ranges does not restrict nu {% data reusables.actions..networking-for-larger-runners %} {% ifversion ghec %} + ### Creating static IP addresses for enterprise runners {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance.md b/content/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance.md index 95ab6f1cc8b4..c2d105ba75ca 100644 --- a/content/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance.md +++ b/content/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance.md @@ -277,6 +277,7 @@ On an instance in a high-availability configuration, after you restore to new di To remediate after the restoration completes and before starting replication, you can tear down stale UUIDs using `ghe-repl-teardown`. If you need further assistance, contact {% data variables.contact.contact_ent_support %}. {% ifversion backup-utilities-progress %} + ## Monitoring backup or restoration progress During a backup or restoration operation, you can use the `ghe-backup-progress` utility on your backup host to monitor the operation's progress. The utility prints the progress of each job sequentially. diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md index cc804fc46f2e..3091b0616259 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md @@ -107,6 +107,7 @@ Optionally, organization owners can further restrict the access policy of the ru For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." ## 5. Automatically scale your self-hosted runners + {% ifversion actions-runner-controller %}Optionally, you can use {% data variables.product.prodname_actions_runner_controller %} (ARC) to automatically scale self-hosted runners. {% data reusables.actions.actions-runner-controller-about-arc %} {% else %}Optionally, you can build custom tooling to automatically scale the self-hosted runners for {% ifversion ghec or ghae %}your enterprise{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. For example, your tooling can respond to webhook events from {% data variables.location.product_location %} to automatically scale a cluster of runner machines. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners)." diff --git a/content/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey.md b/content/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey.md index 0a206febc7c4..bbb40b4abd34 100644 --- a/content/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey.md +++ b/content/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey.md @@ -31,5 +31,6 @@ Some authenticators allow passkeys to be used with nearby devices. For example, 1. On your nearby device, follow the prompts to complete the authentication process. For example, if you are using an iPhone, you might perform FaceID or enter your passcode. ## Further reading + - [AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys) - [AUTOTITLE](/authentication/authenticating-with-a-passkey/managing-your-passkeys) diff --git a/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md b/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md index 38cbec756c1f..ceb646a17019 100644 --- a/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md +++ b/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md @@ -63,6 +63,7 @@ To confirm access for sudo mode, you {% ifversion totp-and-mobile-sudo-challenge {%- endif %} {% ifversion passkeys %} + ## Confirming access using a passkey You must have a passkey registered to your account to confirm access to your account for sudo mode using a passkey. For more information, see "[AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys)" and "[AUTOTITLE](/authentication/authenticating-with-a-passkey/managing-your-passkeys)." diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md index 2ed953551018..a3dd9970e8e4 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md @@ -51,6 +51,7 @@ If you've set up a security key on your account, and your browser supports secur 1. Select the appropriate option in the prompt. Depending on your security key configuration, you may type a PIN, complete a biometric prompt, or use a physical security key. {% ifversion passkeys %} + ### Using a passkey If you have enabled 2FA, and you have added a passkey to your account, you can use the passkey to sign in. Since passkeys satisfy both password and 2FA requirements, you can complete your sign in with a single step. For more information, see "[AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys)" and "[AUTOTITLE](/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey)." diff --git a/content/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan.md b/content/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan.md index 563efe9d0443..2489b7ef45e6 100644 --- a/content/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan.md +++ b/content/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan.md @@ -89,6 +89,7 @@ To reduce the number of paid seats your organization uses, you can remove member 1. Review the information about your new payment on your next billing date, then click **Remove seats**. {% ifversion ghec %} + ## Downgrading your enterprise account's plan Enterprise accounts are only available with {% data variables.product.prodname_enterprise %}, so it's not possible to downgrade an enterprise account to another plan. diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md index 172954841239..b92b8f70668c 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md +++ b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md @@ -167,6 +167,7 @@ For information on bulk enablement, see "[AUTOTITLE](/code-security/code-scannin {% endif %} {% ifversion ghes < 3.5 %} + ## Reasons for the "Analysis not found" message If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see an "Analysis not found" message when you click **Details** on the "{% data variables.product.prodname_code_scanning_caps %} results / TOOL NAME" check in a pull request. diff --git a/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale.md b/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale.md index e7ff12560c52..5dd845b856f0 100644 --- a/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale.md +++ b/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale.md @@ -54,6 +54,7 @@ If the code in a repository changes to include {% ifversion code-scanning-defaul {% endif %} {% ifversion org-enable-code-scanning %} + ## Configuring default setup for all eligible repositories in an organization Through the "Code security and analysis" page of your organization's settings, you can enable default setup for all eligible repositories in your organization. For more information on repository eligibility, see "[Eligible repositories for {% data variables.product.prodname_codeql %} default setup at scale](#eligible-repositories-default-setup)." @@ -80,6 +81,7 @@ Through the "Code security and analysis" page of your organization's settings, y {% data variables.product.prodname_code_scanning_caps %} is configured at the repository level. For more information, see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)." {% endif %} {% ifversion code-security-multi-repo-enablement %} + ## Configuring default setup for a subset of repositories in an organization Through security overview for your organization, you can find eligible repositories for default setup, then enable default setup across each of those repositories simultaneously. For more information on repository eligibility, see "[Eligible repositories for {% data variables.product.prodname_codeql %} default setup at scale](#eligible-repositories-default-setup)." diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md index 62eec34e581e..0c928b7c3f7f 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md @@ -26,6 +26,7 @@ If your codebase depends on a library or framework that is not recognized by the If you need to change any other aspects of your {% data variables.product.prodname_code_scanning %} configuration, consider configuring advanced setup. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning)." {% ifversion code-scanning-without-workflow-310 %} + ## Customizing your existing configuration of default setup {% data reusables.repositories.navigate-to-repo %} @@ -38,6 +39,7 @@ If you need to change any other aspects of your {% data variables.product.prodna 1. To update your configuration, as well as run an initial analysis of your code with the new configuration, click **Save changes**. All future analyses will use your new configuration. {% else %} + ## Changing the selected query suite for your configuration of default setup {% data reusables.repositories.navigate-to-repo %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md b/content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md index 4b282c115fe1..d18fd9a5a26f 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md +++ b/content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md @@ -18,11 +18,14 @@ versions: On very large projects, you may see `Error: "Out of disk"` or `Error: "Out of memory"` on self-hosted runners when running {% data variables.product.prodname_codeql %}. In this case, you may need to increase the memory or disk space available on your runners. You can review the recommended hardware resources for running {% data variables.product.prodname_codeql %} to make sure your self-hosted runners meet those requirements. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/recommended-hardware-resources-for-running-codeql)." {% else %} + ## Use self-hosted runners Self-hosted runners offer more control of hardware, operating system, and software tools than {% data variables.product.company_short %}-hosted runners can provide. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)." You can review the recommended hardware resources for running {% data variables.product.prodname_codeql %} to make sure your self-hosted runners meet those requirements. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/recommended-hardware-resources-for-running-codeql)." {% ifversion actions-hosted-runners %} + ## Use larger runners + You can use larger runners, which are {% data variables.product.company_short %}-hosted runners with more RAM, CPU, and disk space than standard runners. These runners have the runner application and other tools preinstalled. For more information about larger runners and the specifications you can use with them, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners)."{% endif %} {% endif %} \ No newline at end of file diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md index 8b881c176887..6b331b6b4a34 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md +++ b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md @@ -131,6 +131,7 @@ $ codeql database analyze /codeql-dbs/example-repo \ ``` {% ifversion code-scanning-tool-status-page %} + ### Adding file coverage information to your results for monitoring You can optionally submit file coverage information to {% data variables.product.product_name %} for display on the {% data variables.code-scanning.tool_status_page %} for {% data variables.product.prodname_code_scanning %}. For more information about file coverage information, see "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page#how-codeql-defines-scanned-files)." diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md index dae37abd2101..f563c026ee5f 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md +++ b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md @@ -49,6 +49,7 @@ The other files and directories within the pack should be logically organized. F their own top-level directories. {% ifversion codeql-packs %} + ## Downloading and using {% data variables.product.prodname_codeql %} query packs The {% data variables.product.prodname_codeql_cli %} bundle includes queries that are maintained by {% data variables.product.company_short %} experts, security researchers, and community contributors. If you want to run queries developed by other organizations, {% data variables.product.prodname_codeql %} query packs provide an efficient and reliable way to download and run queries{% ifversion codeql-model-packs-java %}, while model packs (beta) can be used to expand {% data variables.product.prodname_code_scanning %} analysis to recognize libraries and frameworks that are not supported by default{% endif %}. For more information about query packs, see "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql#about-codeql-queries)." {% ifversion codeql-model-packs-java %} For information about writing your own model packs, see "[AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs#creating-a-model-pack)."{% endif %} @@ -190,6 +191,7 @@ For more information about writing your own model packs, see "[AUTOTITLE](/code- {% endif %} {% ifversion query-pack-compatibility %} + ### About published packs When a pack is published for use in analyses, the `codeql pack create` or `codeql pack publish` command verifies that the content is complete and also adds some additional pieces of content to it: diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md index 8a7278600fa0..5210673e441f 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md +++ b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md @@ -76,6 +76,7 @@ codeql github upload-results \ There is no output from this command unless the upload was unsuccessful. The command prompt returns when the upload is complete and data processing has begun. On smaller codebases, you should be able to explore the {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.product_name %} shortly afterward. You can see alerts directly in the pull request or on the **Security** tab for branches, depending on the code you checked out. For more information, see "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests)" and "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/managing-code-scanning-alerts-for-your-repository)." {% ifversion code-scanning-tool-status-page %} + ## Uploading diagnostic information to {% data variables.product.product_name %} if the analysis fails When {% data variables.product.prodname_codeql_cli %} finishes analyzing a database successfully, it gathers diagnostic information such as file coverage, warnings, and errors, and includes it in the SARIF file with the results. When you upload the SARIF file to {% data variables.product.company_short %} the diagnostic information is displayed on the {% data variables.product.prodname_code_scanning %} {% data variables.code-scanning.tool_status_page %} for the repository to make it easy to see how well {% data variables.product.prodname_codeql %} is working and debug any problems. For more information, see "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page)." diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md index e90f5f9e1614..f73af76a041b 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md +++ b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md @@ -223,6 +223,7 @@ The following properties are supported in `qlpack.yml` files. ``` {% ifversion codeql-model-packs-java %} + #### `dataExtensions` - Required by model packs. @@ -261,6 +262,7 @@ The following properties are supported in `qlpack.yml` files. ``` {% ifversion codeql-model-packs-java %} + #### `extensionTargets` - Required by model packs. @@ -304,6 +306,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `tests` + - Optional for packs containing {% data variables.product.prodname_codeql %} tests. Ignored for packs without tests. - Defines the path to a directory within the pack that contains tests, defined relative to the pack directory. Use `.` to specify the whole pack. Any queries in this directory are run as tests when `test run` is run with the `--strict-test-discovery` option. These queries are ignored by query suite definitions that use `queries` or `qlpack` instructions to ask for all queries in a particular pack. If this property is missing, then `.` is assumed. For example: @@ -312,6 +315,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `extractor` + - Required by all packs containing {% data variables.product.prodname_codeql %} tests. - Defines the {% data variables.product.prodname_codeql %} language extractor to use when running the {% data variables.product.prodname_codeql %} tests in the pack. For more information about testing queries, see "[AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries)." For example: @@ -320,6 +324,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `authors` + - Optional. - Defines metadata that will be displayed on the packaging search page in the packages section of the account that the {% data variables.product.prodname_codeql %} pack is published to. For example: @@ -328,6 +333,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `license` + - Optional. - Defines metadata that will be displayed on the packaging search page in the packages section of the account that the {% data variables.product.prodname_codeql %} pack is published to. For a list of allowed licenses, see [SPDX License List](https://spdx.org/licenses/) in the SPDX Specification. For example: @@ -336,6 +342,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `description` + - Optional. - Defines metadata that will be displayed on the packaging search page in the packages section of the account that the {% data variables.product.prodname_codeql %} pack is published to. For example: @@ -344,6 +351,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `libraryPathDependencies` + - Optional, deprecated. Use the `dependencies` property instead. - Previously used to define the names of any {% data variables.product.prodname_codeql %} packs that this {% data variables.product.prodname_codeql %} pack depends on, as an array. This gives the pack access to any libraries, database schema, and query suites defined in the dependency. For example: @@ -352,6 +360,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `dbscheme` + - Required by core language packs only. - Defines the path to the [database schema](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#codeql-database-schema) for all libraries and queries written for this {% data variables.product.prodname_codeql %} language (see example below). For example: @@ -360,6 +369,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `upgrades` + - Required by core language packs only. - Defines the path to a directory within the pack that contains database upgrade scripts, defined relative to the pack directory. Database upgrades are used internally to ensure that a database created with a different version of the {% data variables.product.prodname_codeql_cli %} is compatible with the current version of the CLI. For example: @@ -368,6 +378,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `warnOnImplicitThis` + - Optional. Defaults to `false` if the `warnOnImplicitThis` property is not defined. - Defines a boolean that specifies whether or not the compiler should emit warnings about member predicate calls with implicit `this` call receivers, that is, without an explicit receiver. Supported from {% data variables.product.prodname_codeql_cli %} version 2.13.2 and onwards. For example: diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md index 94d1a1481441..4dafc1d376b6 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md +++ b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md @@ -232,5 +232,6 @@ into {% data variables.product.prodname_codeql %} for VS Code, execute `EmptyThe `Test.java` example code. For more information, see "[Analyzing your projects](https://codeql.github.com/docs/codeql-for-visual-studio-code/analyzing-your-projects/#analyzing-your-projects)" in the {% data variables.product.prodname_codeql %} for VS Code help. ## Further reading + - "[{% data variables.product.prodname_codeql %} queries](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries/#codeql-queries)" - "[Testing {% data variables.product.prodname_codeql %} queries in Visual Studio Code](https://codeql.github.com/docs/codeql-for-visual-studio-code/testing-codeql-queries-in-visual-studio-code/#testing-codeql-queries-in-visual-studio-code)." diff --git a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 59066252fbd0..3c52b75a37fc 100644 --- a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -327,6 +327,7 @@ If you use the same configuration as in the example above, bumping the `requests `pip dev: bump requests from 1.0.0 to 1.0.1` {% ifversion dependabot-version-updates-groups %} + ### `groups` {% data reusables.dependabot.dependabot-version-updates-groups-supported %} diff --git a/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md b/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md index 937ff08de61b..538779ef3e72 100644 --- a/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md +++ b/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md @@ -141,6 +141,7 @@ updates: ``` {% ifversion dependabot-version-updates-groups %} + ## Grouping {% data variables.product.prodname_dependabot_version_updates %} into one pull request {% data reusables.dependabot.dependabot-version-updates-groups-about %} diff --git a/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md b/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md index 9b166225dab4..309acf5c1ecb 100644 --- a/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md +++ b/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md @@ -391,6 +391,7 @@ registries: ``` {% endraw %} + #### Notes {% data reusables.dependabot.access-private-dependencies-link %} diff --git a/content/code-security/getting-started/dependabot-quickstart-guide.md b/content/code-security/getting-started/dependabot-quickstart-guide.md index 62ecbde70659..2143c1cf820a 100644 --- a/content/code-security/getting-started/dependabot-quickstart-guide.md +++ b/content/code-security/getting-started/dependabot-quickstart-guide.md @@ -95,6 +95,7 @@ If {% data variables.product.prodname_dependabot_alerts %} are enabled for a rep ![Screenshot of the detailed page of an alert in the demo repository, showing the information displayed on the right-side of the page.](/assets/images/help/repository/more-alert-details-demo-repo.png) For more information about viewing, prioritizing, and sorting {% data variables.product.prodname_dependabot_alerts %}, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)." + ## Fixing or dismissing a {% data variables.product.prodname_dependabot %} alert You can fix or dismiss {% data variables.product.prodname_dependabot_alerts %} on {% data variables.product.prodname_dotcom %}. Let's continue to use the forked repository as an example, and the "Command Injection in lodash" alert described in the previous section. diff --git a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md b/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md index cf5cfdc96c17..7c41ba4066e2 100644 --- a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md +++ b/content/code-security/secret-scanning/managing-alerts-from-secret-scanning.md @@ -67,6 +67,7 @@ shortTitle: Manage secret alerts {% endif %} {% ifversion secret-scanning-validity-check-partner-patterns %} + ## Validating partner patterns {% data reusables.secret-scanning.validity-check-partner-patterns-beta %} diff --git a/content/contributing/syntax-and-versioning-for-github-docs/creating-tool-switchers-in-articles.md b/content/contributing/syntax-and-versioning-for-github-docs/creating-tool-switchers-in-articles.md index 62d514f84dd8..7afe05203e83 100644 --- a/content/contributing/syntax-and-versioning-for-github-docs/creating-tool-switchers-in-articles.md +++ b/content/contributing/syntax-and-versioning-for-github-docs/creating-tool-switchers-in-articles.md @@ -18,16 +18,19 @@ For tasks that can be completed with different tools, the tool switcher signals When someone knows how they want to do a task and doesn’t need to see additional options, the tool switcher removes less relevant content, so they can find exactly what they need. ## Using tool tags + We use tool tags to divide information for each tool. On rare occasions, we will add new tools. Tool tags are a key value pair. The key is the tag you use to refer to the tool in the article and the value is how the tool will be identified on the tool picker at the top of the article. The existing tools are in [`lib/all-tools.js`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.js) in the {% data variables.product.prodname_docs %} repository. ### When to use tool tags + We only use tool tags if an article must have tool-specific information to help people accomplish their tasks. If the conceptual information or procedural steps for a task are significantly different depending on what tool someone uses, and we want people to be able to accomplish the task with different tools, we use tool tags to present the relevant information in an article. Do not use the tool switcher just to show examples in different languages. Only use the tool switcher if the tasks or concepts described in an article change based on what tool someone uses. ### How to use tool tags + Tool tags are Liquid tags that wrap content specific to a tool. Put tools in alphabetical order. By default, the first tool tag will be selected for an article. You can define a different default tool for an article by specifying a `defaultTool:` property in the article's frontmatter. For more information, see the [content README](https://github.com/github/docs/blob/main/content/README.md#defaulttool). @@ -37,6 +40,7 @@ You can also link to an article with a specific tool selected by adding `?tool=T Only include a maximum of eight different tools in an article. Including more tools causes the tool switcher tabs to overflow with an article's table of contents, which prevents people from using either the tool switcher or table of contents. It is unlikely that you will ever need to include eight separate tools in an article. In general, plan to use as few separate tools as possible in an article. ## Adding new tools + If a writer determines that adding a new tool is the only way to accurately document something, they should explain their reasoning in the content planning stage. Whoever reviews content plan should consider if there are any alternative ways to address the documentation need without adding a new tool. If a new tool is the only way to create accurate documentation, the new tool should be added. If there is an alternative content solution that does not add a new tool, that option should be used. To add a new tool, add an entry to the `allTools` object in the [`lib/all-tools.js`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.js) file as a key-value pair. Add new tools in alphabetical order. diff --git a/content/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs.md b/content/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs.md index 0dcc3ee30ea6..7b342e079e62 100644 --- a/content/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs.md +++ b/content/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs.md @@ -102,6 +102,7 @@ const copyMe = true ``` ## Code sample annotations + Code sample annotations help explain longer code examples by rendering comments as annotations next to the sample code. This lets us write longer explanations of code without cluttering the code itself. Code samples with annotations are rendered in a two pane layout with the code sample on the left and the annotations on the right. The annotations are visually emphasized when someone hovers their cursor over the code example. Code annotations only work in articles with the `layout: inline` frontmatter property. For more information on how to write and style code annotations, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/annotating-code-examples)." diff --git a/content/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter.md b/content/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter.md index a5edd875ffad..ec03c1457625 100644 --- a/content/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter.md +++ b/content/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter.md @@ -221,6 +221,7 @@ defaultTool: cli ``` ### `learningTracks` + - Purpose: Render a list of learning tracks on a product's sub-landing page. - type: `String`. This should reference learning tracks' names defined in [`data/learning-tracks/*.yml`](https://github.com/github/docs/tree/main/data/learning-tracks). - Optional @@ -232,6 +233,7 @@ defaultTool: cli {% endnote %} ### `includeGuides` + - Purpose: Render a list of articles, filterable by `type` and `topics`. Only applicable when used with `layout: product-guides`. - Type: `Array` - Optional. @@ -247,21 +249,25 @@ includeGuides: ``` ### `type` + - Purpose: Indicate the type of article. - Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`. - Optional. ### `topics` + - Purpose: Indicate the topics covered by the article. The topics are used to filter guides on some landing pages. For example, the guides at the bottom of "[Guides for {% data variables.product.prodname_actions %}](/actions/guides#all-guides)" can be filtered by topics, and the topics are listed under the guide intro. Refer to the content models for more details about adding topics. A full list of existing topics is located in the [allowed topics file](https://github.com/github/docs/blob/main/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](https://github.com/github/docs/blob/main/src/search/tests/topics.js) will fail. - Type: Array of `String`s - Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics, or adding a topic to a new article may not add value. ### `communityRedirect` + - Purpose: Set a custom link and link name for `Ask the GitHub community` link in the footer. - Type: `Object`. Properties are `name` and `href`. - Optional. ### `effectiveDate` + - Purpose: Set an effective date for Terms of Service articles so that engineering teams can automatically re-prompt users to confirm the terms - Type: `string` YEAR-MONTH-DAY e.g. 2021-10-04 is October 4th, 2021 - Optional. diff --git a/content/contributing/writing-for-github-docs/content-model.md b/content/contributing/writing-for-github-docs/content-model.md index 80ef700ac5c2..90afea30b3cd 100644 --- a/content/contributing/writing-for-github-docs/content-model.md +++ b/content/contributing/writing-for-github-docs/content-model.md @@ -48,6 +48,7 @@ Top-level doc sets are organized around a {% data variables.product.prodname_dot - Most top-level doc sets have a landing page layout, unless there is a significant exception. For example, the "[Site policy](/free-pro-team@latest/site-policy)" doc set does not have guides or procedural articles like other doc sets, so it does not use a landing page layout. #### Titles for top-level doc sets + - Feature or product based. - Describes what part of {% data variables.product.prodname_dotcom %} someone is using. - Examples @@ -63,6 +64,7 @@ Categories are organized around a feature or a discrete set of tasks within a to - When categories have more than ten articles, consider breaking the content into map topics or additional categories. #### Titles for categories + - Task-based (begins with a gerund). - Describes the big-picture purpose or goal of using the feature or product. - General or high-level enough to scale with future product enhancements. @@ -72,6 +74,7 @@ Categories are organized around a feature or a discrete set of tasks within a to - [AUTOTITLE](/pull-requests/committing-changes-to-your-project) #### Intros for categories + All categories have intros. Intros should be one sentence long and general or high-level enough to scale with future product changes. If you significantly change a category’s structure, check its intro for needed updates. ### Map topic @@ -81,6 +84,7 @@ Map topics introduce a section of a category, grouping articles within a categor Map topics contain at least three articles. When map topics have more than eight articles, it may be useful to consider breaking the content into more specific map topics. #### Titles for map topics + - Task-based (begins with a gerund). - Describes a more specific task within the larger workflow of the category it’s in. - General or high-level enough to scale with future additions to the product. @@ -90,6 +94,7 @@ Map topics contain at least three articles. When map topics have more than eight - [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise) #### Intros for map topics + All map topics have intros. Intros should be one sentence long and general or high-level enough to scale with future product changes. If you add or remove articles in a map topic, check its intro for needed updates. ### Article @@ -113,6 +118,7 @@ We organize content predictably within categories, map topics, and articles. Fro Topics are used to filter articles and are searchable across the {% data variables.product.prodname_docs %} site. For some layouts, such as landing pages or guides, people can select which articles are displayed by filtering topics. Use these guidelines to help choose which topics to add to an article's frontmatter. For more information on adding topics to an article see, "[Topics](https://github.com/github/docs/tree/main/content#topics)" and for a list of all allowed topics, see [`allowed-topics`](https://github.com/github/docs/blob/main/data/allowed-topics.js). #### Topics for all content types + - All articles should have at least one topic - Use nouns as topics - Topics help people meaningfully group content @@ -131,6 +137,7 @@ Topics are used to filter articles and are searchable across the {% data variabl - Use: `Actions` instead of `GitHub Actions` #### Checklist for choosing topics + Consider these questions to help choose topics for an article. Not every article will have a topic for each item in the checklist. - What is the feature or product area? @@ -172,12 +179,14 @@ For the conceptual content template, see "[AUTOTITLE](/contributing/writing-for- - Include next steps for getting started with the feature (whether through further reading links or content within the article itself). #### Titles for conceptual content + - Conceptual articles or headers of conceptual sections start with "About [subject]”. - Use a noun to describe the subject. - Use: "About {% data variables.product.prodname_code_scanning %}" - Avoid: "About scanning your code for vulnerabilities" #### Examples of conceptual content + - Conceptual articles - [About GitHub Sponsors](/free-pro-team@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors) - [About Enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts) @@ -209,11 +218,13 @@ For the referential content template, see "[AUTOTITLE](/contributing/writing-for - Example: [AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions) #### Titles for referential content + - Referential articles or headers of referential sections clearly describe the contents of the section, and generally begin with nouns. - Titles include enough information to be accessible to novice users and fully describe the contents of each section. - Titles avoid stacked nouns - use prepositions to break up long strings of nouns. #### Examples of referential content + - Referential articles - [AUTOTITLE](/get-started/using-github/keyboard-shortcuts) - [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise) @@ -242,6 +253,7 @@ For the procedural content template, see "[AUTOTITLE](/contributing/writing-for- - Include troubleshooting tips as frequently as possible. #### Titles for procedural content + - Procedural articles or procedural sections within articles are task-based and begin with a gerund. - Use: "Applying for a student developer pack" - Use active and specific verbs (brainstorm or use a thesaurus when needed). @@ -249,6 +261,7 @@ For the procedural content template, see "[AUTOTITLE](/contributing/writing-for- - Article title length: maximum 80 characters, 60 if possible. #### Examples of procedural content + - [AUTOTITLE](/free-pro-team@latest/billing/managing-your-github-billing-settings/adding-information-to-your-receipts) - [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise) - [AUTOTITLE](/actions/learn-github-actions/using-starter-workflows) @@ -274,6 +287,7 @@ You can find guidance for the format, style, and tone of release notes, as well Troubleshooting content includes built-in errors we expect people to encounter, common problems reported to support, and situations people might encounter while completing tasks. Use troubleshooting sections in guides or procedural articles to keep solutions close to procedures. Work with support and product managers to surface common errors and include them in the documentation. #### Known issues + Known issues are a subset of troubleshooting content specifically designed to respond to bugs, UX/UI issues, and other product quirks that generate a high volume of support tickets. Where troubleshooting content can describe errors that people *might* encounter, known issues explain problems that people *will* encounter. Like all troubleshooting content, known issues can be a section in an article or a standalone article. If a known issue applies to a specific article, document it in that article. If a known issue applies to a specific set of articles or conceptual grouping of features, or if a product or feature has multiple known issues that should be grouped together, create a dedicated "Known issues with NAME" article. @@ -289,17 +303,20 @@ Use known issues to explain the following situations. - Rare or severe bugs that {% data variables.product.prodname_dotcom %} has not yet prioritized fixing, and that are not explained in the product or by existing content on {% data variables.product.prodname_docs %}. #### How to write troubleshooting content + - Use any {% data variables.product.prodname_docs %} content type to create troubleshooting sections. - Whenever possible, keep troubleshooting content contained within procedural content or guides. - You can create a troubleshooting article when it makes sense to keep it separate, such as when there’s a large amount of troubleshooting content on a particular topic. - You can create a troubleshooting map topic if a product or feature has many troubleshooting articles, for example "[AUTOTITLE](/authentication/troubleshooting-ssh)." #### Title guidelines for troubleshooting content + - Troubleshooting FEATURE - Error: ERROR NAME - Known issues for PRODUCT #### Examples of troubleshooting content + - "[AUTOTITLE](/authentication/troubleshooting-ssh)" - "[AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer#troubleshooting-connectivity-through-a-load-balancer)" - "[Known issues](/enterprise-server@3.7/admin/release-notes#3.7.8-known-issues)" in the {% data variables.product.prodname_ghe_server %} release notes @@ -310,6 +327,7 @@ Use known issues to explain the following situations. Often, it's helpful to group information in context to help people complete a complex task, understand a set of related tasks, or illustrate an entire workflow. Use longer articles combining content types to ensure people find contextual content in the right place. Longer articles also help eliminate duplication of content and prepare content to scale as more options are added to the product. People most often need longer articles while actively using the product, and they may need to consult the article at different points on their journey. #### How to combine multiple content types in an article + - Use conceptual, procedural, referential, troubleshooting, or known issue content in a longer article, and do not use quickstart or tutorials. - Use sections of different content types in the article as needed, and follow title guidelines for the content type. - Most often, these articles will contain at least one procedural section plus at least one additional conceptual, referential, or procedural section. @@ -318,11 +336,13 @@ Often, it's helpful to group information in context to help people complete a co - You can replicate the article’s title in a header if needed. #### Title guidelines for articles that combine multiple content types + - If there is a procedure within the article, use a task-based title that begins with a gerund. - Titles are general enough to describe the range of information and tasks contained within the article. - Titles describe the setting being toggled and are agnostic about what setting the reader chooses, e.g., "Setting repository visibility” instead of "Making a private repository public.” #### Examples of articles that combine multiple content types + - [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility) - [AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise) - [AUTOTITLE](/free-pro-team@latest/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription) @@ -358,10 +378,12 @@ Contents of quickstarts: - Include 2-3 actionable next steps that someone can take after completing the quickstart. Always link to conceptual content on the feature or product. You can also link off to other related information on docs.github.com or in {% data variables.product.prodname_learning %}. #### Title guidelines for quickstarts + - When the guide helps someone get started with a new tool, preface the title with "Quickstart", e.g. "Quickstart for GitHub Actions" or "Quickstart: Procedural title." - For other use cases, follow the title guidelines for procedures and omit the word "Quickstart." #### Examples of quickstarts + - [AUTOTITLE](/free-pro-team@latest/actions/quickstart) - [AUTOTITLE](/free-pro-team@latest/discussions/quickstart) - [Quickstart for GitHub Educators](/free-pro-team@latest/education/quickstart) @@ -403,10 +425,12 @@ Contents of tutorials: - Relevant published talks, blog posts, or Community Forum series posts by Hubbers #### Title guidelines for tutorials + - Follow the title guidelines for procedural articles. - Do not use "tutorial” or "guide” in the title. #### Examples of tutorials + Tutorials: - [AUTOTITLE](/actions/managing-issues-and-pull-requests/adding-labels-to-issues) - [AUTOTITLE](/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development) @@ -448,6 +472,7 @@ Titles fully describe what a page is about, and what someone will learn by readi Titles can be challenging. Use these general guidelines to help create clear, helpful, and descriptive titles. The guidelines for each content type in this article provide more specific title rules. #### Titles for all content types + - Titles clearly describe what a page is about. They are descriptive and specific. - Use: Browsing actions in the workflow editor - Use: Example of configuring a codespace @@ -480,6 +505,7 @@ Use the product callout when a feature is available in specific products only an All product callouts are stored as reusables in [`gated-features`](https://github.com/github/docs/tree/main/data/reusables/gated-features) and added in YAML frontmatter for relevant articles. #### How to write a product callout + - Product callouts follow a strict format, clearly identifying the feature and which products it’s available in. - Product callouts also include a link to "GitHub’s products” and occasionally to another relevant article. - Examples: @@ -487,6 +513,7 @@ All product callouts are stored as reusables in [`gated-features`](https://githu - [Feature name] is available in public repositories with [free product(s)], and in public and private repositories with [paid products]. For more information, see "GitHub’s products.” #### Examples of articles with product callouts + Check the source files and `gated-features` to see how source content is written. - [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule) @@ -495,6 +522,7 @@ Check the source files and `gated-features` to see how source content is written The top of every page has an intro that provides context and sets expectations, allowing readers to quickly decide if the page is relevant to them. Intros also are displayed in search results to provide contextual information to help readers choose a result. #### How to write an intro + - Article intros are one to two sentences long. - Map topic and category intros are one sentence long. - API reference intros are one sentence long. @@ -513,6 +541,7 @@ Every procedure includes a permissions statement explaining the role required to Occasionally, it's relevant to mention required permissions in conceptual content, especially in standalone conceptual articles. Make sure to also include a permissions statement in related procedures (or write a longer article combining all of the content). #### How to write a permissions statement + - When a single set of permissions applies to all procedures in an article, use the [permissions frontmatter](https://github.com/github/docs/tree/main/content#permissions). - When an article contains multiple procedures and different permissions apply, include a separate permissions statement under each relevant header, before each procedure. - Don't include permissions in an article’s intro. @@ -523,6 +552,7 @@ Occasionally, it's relevant to mention required permissions in conceptual conten - AVOID: [ACCOUNT ROLE] and people with [FEATURE ROLE] access for a [FEATURE] can [ACTION]. #### Examples of permissions statements + - Article with single permissions statement for multiple procedures: [AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise) ### Tool switcher @@ -530,12 +560,15 @@ Occasionally, it's relevant to mention required permissions in conceptual conten Some articles have content that varies depending on what tool someone uses to complete a task, such as the {% data variables.product.prodname_cli %} or {% data variables.product.prodname_desktop %}. For most content, the same conceptual or procedural information will be accurate for multiple tools. However, if the only way to make information clear and accurate is by distinguishing content by tool, use the tool switcher. Do not use the tool switcher just to show examples in different languages. Only use the tool switcher if the tasks or concepts change based on what tool someone uses. For more information on using the tool switcher, see the [tool switcher content model](https://github.com/github/docs/blob/main/contributing/tool-switcher.md). ### Table of contents + Tables of contents are automatically generated. For more information see "[Autogenerated mini-TOCs](https://github.com/github/docs/tree/main/content#autogenerated-mini-tocs)." ### Conceptual content + Conceptual content helps people understand or learn about a topic. See "[Conceptual](#conceptual)" above. ### Referential content + Referential content provides structured information related to actively using a product or feature. See "[Referential](#referential)" above. ### Prerequisites @@ -543,6 +576,7 @@ Referential content provides structured information related to actively using a Prerequisites are information that people need to know before proceeding with a procedure, so that they can prepare everything they need before starting the task. #### How to write prerequisites + - Write prerequisites immediately before a procedure's numbered steps. - You can use a list, a sentence, or a paragraph to explain prerequisites. - You can also use a separate prerequisites section when: @@ -551,13 +585,16 @@ Prerequisites are information that people need to know before proceeding with a - To repeat or highlight important information about data loss or destructive actions, you may also use a warning or danger callout to share a prerequisite. #### Title guidelines for prerequisites + - When using a separate section, use a header called `Prerequisites` #### Examples of articles with prerequisites sections + - [AUTOTITLE](/enterprise-server@latest/admin/installation/installing-github-enterprise-server-on-aws) - [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-subdomain-isolation) ### Procedural content + Procedural content helps people complete tasks. See "[Procedural](#procedural)" above. ### Troubleshooting content @@ -569,6 +606,7 @@ Troubleshooting content helps people avoid or work through errors. See "[Trouble Further reading sections highlight additional targeted articles that aren’t already included within the article’s content or sidebar. Use further reading sections sparingly when they provide real value. #### How to write a further reading section + - Use a bulleted list. - Use further reading sections sparingly and when they provide high value - see style guide for guidelines on linking. diff --git a/content/contributing/writing-for-github-docs/style-guide.md b/content/contributing/writing-for-github-docs/style-guide.md index de5ef73245a8..11eaaad3613b 100644 --- a/content/contributing/writing-for-github-docs/style-guide.md +++ b/content/contributing/writing-for-github-docs/style-guide.md @@ -1007,6 +1007,7 @@ For example in the following table, in order to make sense of the "Yes" and "No" To add row headers for a Markdown table, wrap the table in the Liquid tags `{% raw %}{% rowheaders %} {% endrowheaders %}{% endraw %}`. For more information about using row headers, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs#table-row-headers)." ### Include a value for every cell + Every cell in a table must contain a value. If the table has row headers, the first cell (cell A1) can be empty. If there is no data, use "None" or "Not applicable". Do not use "NA" or "N/A". @@ -1023,6 +1024,7 @@ For tables that use symbols: Where table data is not truly binary (every value is either "Yes" or "No", for example), text values may be needed in addition to, or instead of, symbols. For example on the page "[AUTOTITLE](/support/learning-about-github-support/about-github-support)", some features are marked as "Available to purchase". ### Use footnotes sparingly + See "[Footnotes](#footnotes)." ### Align table content consistently @@ -1107,6 +1109,7 @@ Use quotation marks around article titles, whether the article is hosted on GitH For further guidance, see “[Formatting titles](https://docs.microsoft.com/style-guide/text-formatting/formatting-titles)” in Microsoft’s Style Guide. ## Short titles + We use short titles to populate the sidebar navigation. Since short titles appear in the sidebar navigation, they can use context to convey meaning and be slightly less precise than full titles. The goal of short titles is to help people find the content that they are looking for without having sidebar navigation items that are too long. Short titles give people contextual understanding of an article and align to the following standards. - Short titles are 2-3 words long. @@ -1196,6 +1199,7 @@ When referencing text in the user interface, reproduce the text exactly. Use quo - **Use:** Under “IP allow list”, click **Edit**. ### More resources + Microsoft Style Guide: - [Formatting text in instructions](https://docs.microsoft.com/style-guide/procedures-instructions/formatting-text-in-instructions) diff --git a/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md b/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md index 74461f3403b1..4e9a933d82dd 100644 --- a/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md +++ b/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md @@ -45,18 +45,21 @@ Good videos introduce an instructional agenda that includes steps and goals so t Videos are broadly grouped into three categories: product overviews, feature videos, and tutorials. These descriptions are generalizations of each video type. Some videos might not fit perfectly in one category, but can still be useful without meeting the exact guidelines. ### Product overviews + - **Purpose**: Briefly explain what the product is, showcase the main functionality, and get people interested - **Length**: Less than a minute - **Possible audiences**: People who want to know if a feature is useful for their goals, people who are new to {% data variables.product.company_short %} and trying to understand what the products do - **Possible locations in the docs**: Landing pages and guides ### Feature videos + - **Purpose**: Supplement conceptual or procedural content - **Length**: As short as possible, without exceeding five minutes. Break longer content into multiple shorter, focused videos - **Possible audiences**: People who are learning about or how to use a feature - **Possible locations in the docs**: Guides, conceptual articles, procedural articles ### Tutorials + - **Purpose**: Help novice users get going with a product, drive adoption, or explain complex functionalities - **Length**: Individual videos should be five minutes or less. Complex topics can have a series of shorter videos spread across an article. Total length should be a maximum of 15 minutes - **Possible audiences**: New users of features or products diff --git a/content/copilot/managing-copilot-for-business/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-for-business.md b/content/copilot/managing-copilot-for-business/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-for-business.md index 14a1e5a47d71..1d029ab98e4d 100644 --- a/content/copilot/managing-copilot-for-business/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-for-business.md +++ b/content/copilot/managing-copilot-for-business/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-for-business.md @@ -16,7 +16,9 @@ shortTitle: Audit logs Audit logs for {% data variables.product.prodname_copilot_business_short %} can help you understand what actions have been taken and by whom. You can use the audit logs to review actions taken by users in your organization{% ifversion ghec %} or enterprise{% endif %}, such as changes to an organization's {% data variables.product.prodname_copilot_short %} settings and policies, or the addition or removal of seats from your {% data variables.product.prodname_copilot_business_short %} subscription. The audit log lists events related to your {% data variables.product.prodname_copilot_business_short %} subscription for the current month and previous six months. For more information, see{% ifversion ghec %} "[AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise)" or{% endif %} "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)." ## Viewing your organization{%- ifversion ghec %} or enterprise{% endif %}'s audit logs + {%- ifversion ghec %} + ### Viewing your enterprise's audit logs {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index 41c5bd06bd7b..2e2237544ad6 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -252,6 +252,7 @@ You can create multiple levels of nested lists using the same method. For exampl For more examples, see the [GitHub Flavored Markdown Spec](https://github.github.com/gfm/#example-265). {% ifversion task-lists-v1 %} + ## Task lists {% data reusables.repositories.task-list-markdown %} diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md index d809b366a721..8da95a27d410 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md @@ -74,6 +74,7 @@ Any issues that are referenced in a task list specify that they are tracked by t {% endif %} {% ifversion code-scanning-task-lists %} + ## Further reading - "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/tracking-code-scanning-alerts-in-issues-using-task-lists)"{% endif %} diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md index f98873fbc92c..f3af0c566f6f 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md @@ -22,15 +22,20 @@ The projects you have marked as templates are made available in the "Select a te When someone creates a project from a template, the {% data reusables.projects.what-gets-copied %} are copied from the template to the new project. {% ifversion projects-v2-org-templates-improvements %}You can find the template that a project used from the project's settings page, under the "Templates" section.{% endif %} {% ifversion projects-v2-org-templates-improvements %} + ## Creating templates + {% else %} + ## Setting a project as a template + {% endif %} {% ifversion projects-v2-org-templates-improvements %} You can either create a new template directly, or you can set a project as a template. ### Creating a new template + {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.projects.projects-tab %} @@ -38,6 +43,7 @@ You can either create a new template directly, or you can set a project as a tem 1. Click **New template**. ### Setting a project as a template + {% endif %} If you have admin permissions for a project in your organization, you can set the project as a template and make it available for others in your organization to use. diff --git a/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md b/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md index 6c5ca77cd88e..e3e11a5dd006 100644 --- a/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md +++ b/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md @@ -76,6 +76,7 @@ Here is an example of an issue created for a large initiative, front-end work, i ![Screenshot of an issue called "Front-end work for Project Octocat." The issue body includes a list of tasks to complete.](/assets/images/help/issues/quickstart-create-large-initiative-issue.png) {% ifversion task-lists-v1 %} + ### Task list example You can use task lists to break larger issues down into smaller tasks and to track issues as part of a larger goal. {% ifversion fpt or ghec %} Task lists have additional functionality when added to the body of an issue. You can see the number of tasks completed out of the total at the top of the issue, and if someone closes an issue linked in the task list, the checkbox will automatically be marked as complete.{% endif %} For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)." diff --git a/content/issues/tracking-your-work-with-issues/quickstart.md b/content/issues/tracking-your-work-with-issues/quickstart.md index 0aeed6f5ce54..5aa83efdc3f9 100644 --- a/content/issues/tracking-your-work-with-issues/quickstart.md +++ b/content/issues/tracking-your-work-with-issues/quickstart.md @@ -41,6 +41,7 @@ You can use markdown to add formatting, links, emojis, and more. For more inform ![Screenshot of the new issue form, with a title and body filled in.](/assets/images/help/issues/issue-title-body.png) {% ifversion task-lists-v1 %} + ## Adding a task list It can be helpful to break large issues into smaller tasks, or to track multiple related issues in a single larger issue. Add a task list to your issue by prefacing list items with `[ ]`. Reference existing issues by issue number or URL. You can use plain text to track tasks that don't have a corresponding issue and convert them to issues later. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)." diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/about-source-code-imports-using-the-command-line.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/about-source-code-imports-using-the-command-line.md index ed381873c64d..7686310dea78 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/about-source-code-imports-using-the-command-line.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/about-source-code-imports-using-the-command-line.md @@ -40,6 +40,7 @@ You can use the command line to import source code and, if the code has been tra All of these tools import source code and revision history, only. If you also want to import your settings and your collaboration history, such as issues and pull requests, you'll need to use more advanced tools. To determine the best tool to use for your migration, see "[AUTOTITLE](/migrations/overview/planning-your-migration-to-github)." {% ifversion fpt or ghec %} + ## Further reading - "[AUTOTITLE](/get-started/using-git/troubleshooting-the-2-gb-push-limit)" diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository.md index 8c5c972588b8..b31109a2bac9 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository.md @@ -62,6 +62,7 @@ To follow these steps, you must use a macOS or Linux system and have the followi {% data reusables.migrations.push-to-github %} {% ifversion fpt or ghec %} + ## Further reading - "[AUTOTITLE](/get-started/using-git/troubleshooting-the-2-gb-push-limit)" diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository.md index b5f787c734a1..d4887b51d336 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository.md @@ -58,6 +58,7 @@ To follow these steps, you must use a macOS or Linux system and have the followi {% data reusables.migrations.push-to-github %} {% ifversion fpt or ghec %} + ## Further reading - "[AUTOTITLE](/get-started/using-git/troubleshooting-the-2-gb-push-limit)" diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository.md index 7d3f9adcd83b..9cfd54667516 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository.md @@ -62,6 +62,7 @@ To follow these steps, you must use Windows and have the following tools install {% data reusables.migrations.push-to-github %} {% ifversion fpt or ghec %} + ## Further reading - "[AUTOTITLE](/get-started/using-git/troubleshooting-the-2-gb-push-limit)" diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md index 361b21b0e60b..1dadec4bfa88 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md @@ -56,6 +56,7 @@ For purposes of demonstration, we'll use: If the repository you are importing contains large files, you may run into a warning or error. For more information on large files and how to manage them, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github)." {% ifversion fpt or ghec %} + ## Further reading - "[AUTOTITLE](/get-started/using-git/troubleshooting-the-2-gb-push-limit)" diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md index c67aabe90569..6411f8ea15e3 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md @@ -170,6 +170,7 @@ Before you can require a linear commit history, your repository must allow squas {% endif %} {% ifversion fpt or ghec or ghes > 3.6 %} + ### Require deployments to succeed before merging You can require that changes are successfully deployed to specific environments before a branch can be merged. For example, you can use this rule to ensure that changes are successfully deployed to a staging environment before the changes merge to your default branch. diff --git a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 8a15c3e7c370..a16cbf9775d4 100644 --- a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -73,6 +73,7 @@ You can filter issues and pull requests based on whether they're open or closed | `is:closed` | [**android is:closed**](https://github.com/search?utf8=%E2%9C%93&q=android+is%3Aclosed&type=) matches closed issues and pull requests with the word "android." {% ifversion merge-queue %} + ## Search for pull requests in the merge queue You can also use the `is` qualifier to find pull requests that are queued to merge. diff --git a/content/site-policy/github-terms/github-copilot-pre-release-license-terms.md b/content/site-policy/github-terms/github-copilot-pre-release-license-terms.md index 044ae93ff9e8..e8851f7d3516 100644 --- a/content/site-policy/github-terms/github-copilot-pre-release-license-terms.md +++ b/content/site-policy/github-terms/github-copilot-pre-release-license-terms.md @@ -80,6 +80,7 @@ These terms apply to the pre-release software made available to you by GitHub. T By using pre-release software, you agree to be contacted by GitHub and Microsoft regarding your participation in the technical preview, including email request(s) for feedback about the software. ## 9. No Warranties. + You bear the sole risk of using the pre-release software. The pre-release software is licensed “as is” without any warranty of any kind or sort, whether such warranty would be express, implied, or statutory. To the extent permitted under your local laws, GitHub and Microsoft disclaim all warranties in the pre-release software, including implied warranties of merchantability, fitness for a particular purpose, title, quiet enjoyment, accuracy, course of dealing, usage of trade, and non-infringement. diff --git a/content/site-policy/github-terms/github-educational-use-agreement.md b/content/site-policy/github-terms/github-educational-use-agreement.md index e1bbf770b5df..b8be9e823eea 100644 --- a/content/site-policy/github-terms/github-educational-use-agreement.md +++ b/content/site-policy/github-terms/github-educational-use-agreement.md @@ -51,79 +51,139 @@ Capitalized terms herein shall have the meanings set forth below. Capitalized te "_Subscription License_" means the license assigned to each Qualified User to install, operate, access, and use the GitHub Products. You may only assign one Subscription License per Qualified User across your GitHub Enterprise Server instances and GitHub Enterprise Cloud Organizations. Each Qualified User will have access to as many of your Enterprise Cloud Organizations as you permit. However, a single Subscription License may not be utilized by more than one Qualified User to access separate GitHub Products. ## 2. Program Benefits and Conditions. + Provided you remain in Good Standing (as defined in Section 2.3 below) and have not breached this Agreement, you will be entitled to receive the benefits described herein (collectively “Benefits”). GitHub may change available Benefits at any time in GitHub’s sole discretion. Should GitHub elect to provide additional Benefits under the Program, GitHub may condition such Benefits on your agreeing to additional terms, restrictions and conditions (collectively “Additional Terms”) applicable to such new or additional Benefits. + ### 2.1 Your Benefits. + Benefits under the Program include the following: + #### 2.1.1 GitHub Product Benefits. + After the Agreement Effective Date, Qualified Users shall have free access to Subscription Licenses on the Service or the Software for each Organization listed on completed Order Forms submitted by the Designated Admin to the GitHub Program Manager. Access to and use of the Service and Software are subject to the terms of the [GitHub Customer Agreement](https://github.com/customer-terms). + #### 2.1.2 Additional Qualified Users. + You may add Subscription Licenses, usage or Services for Qualified Users by completing and submitting a new Order Form no more frequently than quarterly. Quarterly requests may be submitted to the GitHub Program Manager using this form: https://support.github.com/contact/campus-program. + #### 2.1.3 Other Software Benefits. + You may also obtain additional GitHub Software Products through the Program. The GitHub Program Manager will distribute such Products, which will be subject to this Section 2 and any licenses and/or terms of use applicable to such Products. ### 2.2 Conditions. + You must comply with all terms and conditions applicable to each GitHub Product made available through the Program. You must also comply with the following conditions: + #### 2.2.1 Distribution of GitHub Products. + You are responsible for informing all relevant departments at your institution of the available Program Benefits and availability of GitHub Products and for making GitHub Products available to any department interested in participating in the Program. + #### 2.2.2 Designated Admin. + You must appoint a Designated Admin prior to submitting your initial Order Form. This Designated Admin will be GitHub’s single point of contact for your account and for any technical questions from Qualified Users about GitHub Products. The Designated Admin must provide their contact information to the GitHub Program Manager prior to submission of the Order Form. If the Designated Admin changes for any reason, you must immediately provide us with both notice and the new Designated Admin’s contact information . + #### 2.2.3 Logo/Partner Material Usage. + You grant to GitHub the right to use your logo and other Partner Materials, subject to the terms of Section 5 (“Trademark Release”). All Partner Materials must be provided to GitHub for use in the Campaign no later than 30 days of the Agreement Effective Date. + #### 2.2.4 Qualified User Communications. + You must provide channels of communications and information to enable GitHub to communicate information about GitHub products and services to Qualified Users. These channels of communications may include email, SMS, social media or other means of communications designed to reach the maximum number of potential Qualified Users. To the extent required by applicable law, you represent and warrant that you have permission to provide such channels of communication and for GitHub to communication with such Qualified Users. Every potential Qualified User contacted by GitHub will have the ability to opt-out of any future communications. ### 2.3 Good Standing. + “Good Standing” means that you are in current compliance with all Conditions in this Section 2 and with the Agreement (“Conditions”). If you are not currently in compliance, GitHub may, but is not required to, allow you a period of time to cure your non-compliance and return to Good Standing. Granting a cure period is not a waiver of any term or condition of this Agreement nor a guarantee of any future cure period. You must remain in Good Standing throughout the Agreement Term and, upon request, report your compliance to GitHub. Failure to remain in Good Standing is a breach of this Agreement and may result in termination of the Agreement. ## 3. Restrictions and Limitations. + ### 3.1 General Restrictions. + You agree: (i) not to resell the GitHub Products, or to charge any service or other fee to Qualified Users in connection with their use of the GitHub Products under this Agreement; (ii) that you are responsible and liable for Qualified Users' use of the GitHub Products; and (iii) to cooperate with GitHub to enforce the terms of this Agreement in connection with Qualified Users' use of the GitHub Products, including, without limitation, sending appropriate notices to and terminating access to the GitHub Products for Qualified Users who misuse the GitHub Products in any way (iv) to support Qualified Users in the administration and maintenance of their accounts,; and (v) only your Designated Admin shall communicate with GitHub directly about program membership and administration of the Products and Services. You shall immediately terminate access to GitHub Products and Services for any Qualified User who no longer qualifies as such under this Agreement. + ### 3.2 GitHub Product Support. + GitHub’s obligation to provide technical or other support to Qualified Users is limited to that described in the [GitHub Customer Agreement](https://github.com/customer-terms) or as set forth in an Order Form. GitHub shall have no liability to you or any Qualified Users for loss or damages arising from or relating to use and access of the Services. ## 4. Trademark Release. + ### 4.1 License. + You grant GitHub, during the Agreement Term, a worldwide, non-exclusive, royalty-free license to incorporate any of the Partner Materials (including any nonmaterial modifications thereto) into the Campaign and to publicly use, distribute, reproduce, and perform/display the Partner Materials and the Campaign, and any excerpts thereof, in any format or medium, in any language, and to attribute the Partner Materials to Education Partner. GitHub is not obligated to use the Partner Materials, however, any Partner Materials used by GitHub must be submitted by Education Partner and must be approved in advance by the GitHub Program Manager. + ### 4.2 Trademarks. + Education Partner grants to GitHub, during the Agreement Term, a worldwide, non-exclusive, royalty-free license to use Education Partner’s name and trademarks (i) as they appear in the Partner Materials, if at all, and (ii) as otherwise approved by Education Partner in writing ("Education Partner Trademarks"), in the Campaign. All goodwill arising out of GitHub’s use of the Education Partner Trademarks will inure to the benefit of Education Partner, and Education Partner will retain all right and title to the Education Partner Trademarks. + ### 4.3 No Compensation. + The licenses described herein from Education Partner to GitHub are granted without compensation or any financial or other obligation. + ### 4.4 Waiver; Reps and Warranties; Indemnification. + The Campaign shall be created and conducted by GitHub and Education Partner waives any right to approve the Campaign or to enjoin or impair GitHub’s use of the Partner Materials in the Campaign. Education Partner represents and warrants that (i) it has all necessary rights to grant these licenses, (ii) the Partner Materials will not infringe any copyright, trade secret, trademark, or right of publicity/privacy, and (iii) any testimonials in the Partner Materials reflect Education Partner’s honest opinions or experiences. Unless the Partner Materials are altered by GitHub without the consent or direction of Education Partner, Education Partner will indemnify and hold GitHub harmless from and against all third-party claims arising out of Education Partner’s breach of these representations and warranties. ## 5. Term and Termination. + ### 5.1 Term. + The term of this Agreement begins on the date the license key is delivered (for Software) or the subscription is activated (for the Services) ("Agreement Effective Date"), and unless terminated in accordance with this Section, shall continue in effect for a period of one (1) year (the “Initial Term”). The Initial Term of this Agreement and each Renewal Term shall be referred to collectively as the “Agreement Term.” + ### 5.2 Termination for Convenience. + Either Party may terminate this Agreement and any Order Forms submitted and accepted pursuant to the terms and conditions of this Agreement, at any time, for any reason or no reason, upon thirty (30) days’ written notice. Termination of a portion of the Services offered herein or any Order Form will result in the termination of the entire Agreement. + ### 5.3 Termination for Breach. + If you breach this Agreement, we may terminate the Agreement or any Order Form thirty (30) days after we provide you with notice of the breach unless you cure the breach in that period. However, no such notice or cure period is required for any breach of any provision relating to intellectual property (including compliance with the license or rights grant and any license or rights restrictions). + ### 5.4 Effect of Termination. + Upon termination or expiration: (i) your license and any rights held by Qualified Users will immediately cease; and (ii) unless otherwise agreed in writing, you will, at your expense within five (5) days of the termination or expiration: (y) return or delete the Software along with any documentation in your possession or control; and (z) cease accessing and using the Services and send to GitHub a certification signed by one of your authorized employees confirming compliance with these requirements.. Sections 1 and 3 through 9 will survive the termination or expiration of this Agreement for any reason. + ### 5.5 Alternative Breach Resolution. + If you fail to maintain Good Standing or otherwise breach this Agreement, GitHub may elect not to declare a breach or otherwise terminate this agreement but, instead, continue to provide the GitHub Products for the remainder of the Agreement Term at the price of the GitHub Products then posted on GitHub’s public Website at the time of the breach. You agree to pay all fees associated with GitHub so providing the Products as set forth in this Section. ## 6. No Warranty; Disclaimer. + The GitHub Products are being provided "AS IS", and without warranty of any kind, express or implied. GITHUB DISCLAIMS ALL WARRANTIES WITH RESPECT TO THE GITHUB PRODUCTS, EXPRESS OR IMPLIED, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT, AND ANY WARRANTIES ARISING OUT OF COURSE OF DEALING OR USAGE OF TRADE. ## 7. Limitation of Liability. + ### 7.1 Waiver of Consequential Damages. + IN NO EVENT WILL EITHER PARTY BE LIABLE TO THE OTHER OR TO ANY THIRD PARTY FOR ANY INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, EXEMPLARY OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO DAMAGES FOR LOST DATA, LOST PROFITS OR COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, TORT (INCLUDING WITHOUT LIMITATION PRODUCTS LIABILITY, STRICT LIABILITY AND NEGLIGENCE), OR ANY OTHER THEORY, AND WHETHER OR NOT SUCH PARTY KNEW OR SHOULD HAVE KNOWN ABOUT THE POSSIBILITY OF SUCH DAMAGE. + ### 7.2 Limitation of Total Liability. + IN NO EVENT WILL EITHER PARTY’S AGGREGATE LIABILITY ARISING OUT OF OR RELATED TO THIS AGREEMENT FOR ANY CAUSE WHATSOEVER, AND REGARDLESS OF THE FORM OF ACTION, EXCEED THE GREATER OF (I) AMOUNTS ONE PARTY HAS ACTUALLY PAID THE OTHER PARTY UNDER THIS AGREEMENT; OR (II) FIVE HUNDRED DOLLARS ($500). THE FOREGOING LIMITATIONS WILL APPLY NOTWITHSTANDING THE FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY STATED IN THIS AGREEMENT. ## 8. Miscellaneous. + ### 8.1 No Assignment. + You are not allowed to assign or transfer any of your rights or obligations in this Agreement, in whole or in part, by operation of law or otherwise, without our prior written consent, and any attempt by you to do so will be null and void. We can assign this Agreement in its entirety, upon notice to you, in connection with a merger, acquisition, corporate reorganization, or sale of all or substantially all of our business or assets. + ### 8.2 Severability. + If any provision of this Agreement is deemed by a court of competent jurisdiction to be illegal, invalid, or unenforceable, the court will modify or reform this Agreement to give as much effect as possible to that provision. Any provision that can’t be modified or reformed in this way will be deemed deleted, and the remaining provisions of this Agreement will continue in full force and effect. + ### 8.3 No Waiver. + The failure of GitHub to exercise or enforce any right or provision of this Agreement shall not constitute a waiver of such right or provision. + ### 8.4 Force Majeure. + The Parties will be excused from performing under this Agreement to the extent they are unable to perform due to extraordinary causes beyond our reasonable control such as acts of God, strikes, lockouts, riots, acts of war, epidemics, communication line failure, and power failures. + ### 8.5 Independent Contractors. + The Parties are independent contractors and nothing contained in this Agreement (regardless if a party is described as a “Partner”) will be deemed or construed in any manner whatsoever to create a joint venture, partnership, employment, agency, fiduciary, or other similar relationship between us. Neither Party may bind the other to any obligation, whether contractual or otherwise. + ### 8.6 Governing Law. + This Agreement and your use of the GitHub Products are governed under California law and any dispute related to the GitHub Products or the subject matter of these terms must be brought in a tribunal of competent jurisdiction located in or near San Francisco, California. + ### 8.7 Changes to the Agreement; Complete Agreement. + GitHub may amend this Agreement at any time. Should GitHub materially amends this Agreement, it will notify you of such changes at least 30 days prior to the change taking effect by posting a notice on our Website. This Agreement, together with any applicable GitHub Products terms and GitHub's Privacy Statement, and Order Forms represent the complete and exclusive statement of the agreement between you and us and governs your use of the GitHub Products. This Agreement supersedes any proposal or prior agreement oral or written, and any other communications between you and GitHub relating to the subject matter of these terms (including, but not limited to, any prior versions of this Agreement). diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md b/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md index feccc7b6bcf8..0b12d140480e 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md @@ -75,6 +75,7 @@ The owner of a {% data variables.product.prodname_github_app %} can view recent {% endif %} {% ifversion fpt or ghec %} + ## Viewing deliveries for {% data variables.product.prodname_sponsors %} webhooks Only the owner of the sponsored account can view deliveries for sponsorship webhooks for that account. diff --git a/content/webhooks/using-webhooks/creating-webhooks.md b/content/webhooks/using-webhooks/creating-webhooks.md index af2858b5f51a..a8c6207139c3 100644 --- a/content/webhooks/using-webhooks/creating-webhooks.md +++ b/content/webhooks/using-webhooks/creating-webhooks.md @@ -67,6 +67,7 @@ You can use the {% data variables.product.prodname_dotcom %} web interface or th After you create a new webhook, {% data variables.product.prodname_dotcom %} will send you a simple `ping` event to let you know you've set up the webhook correctly. For more information, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads#ping)." {% ifversion ghes or ghae or ghec %} + ## Creating a global webhook for a {% data variables.product.prodname_enterprise %} Enterprise owners can create a global webhook to subscribe to events that occur within their enterprise. For more information, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/managing-global-webhooks)." diff --git a/content/webhooks/using-webhooks/disabling-webhooks.md b/content/webhooks/using-webhooks/disabling-webhooks.md index 4bae562a6ab6..11f31b794579 100644 --- a/content/webhooks/using-webhooks/disabling-webhooks.md +++ b/content/webhooks/using-webhooks/disabling-webhooks.md @@ -46,6 +46,7 @@ You can use the {% data variables.product.prodname_dotcom %} web interface or th {% data reusables.webhooks.disable_webhook %} {% ifversion ghec or ghes or ghae %} + ## Disabling a global webhook for a {% data variables.product.prodname_enterprise %} Enterprise owners can disable a global webhook in an {% data variables.product.prodname_enterprise %}. For more information, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/managing-global-webhooks)." diff --git a/content/webhooks/webhook-events-and-payloads.md b/content/webhooks/webhook-events-and-payloads.md index 706e39ade992..c5367932d628 100644 --- a/content/webhooks/webhook-events-and-payloads.md +++ b/content/webhooks/webhook-events-and-payloads.md @@ -34,13 +34,16 @@ You can create webhooks that subscribe to the events listed on this page. Each w HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers: -- `X-GitHub-Event`: Name of the event that triggered the delivery. -- `X-GitHub-Delivery`: A [GUID](https://en.wikipedia.org/wiki/Globally_unique_identifier) to identify the delivery.{% ifversion ghes or ghae %} +- `X-GitHub-Hook-ID`: The unique identifier of the webhook. +- `X-GitHub-Event`: The name of the event that triggered the delivery. +- `X-GitHub-Delivery`: A globally unique identifier (GUID) to identify the delivery.{% ifversion ghes or ghae %} - `X-GitHub-Enterprise-Version`: The version of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload. -- `X-GitHub-Enterprise-Host`: The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %}{% ifversion not ghae %} -- `X-Hub-Signature`: This header is sent if the webhook is configured with a [`secret`](/rest/repos#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`.{% ifversion fpt or ghes or ghec %} `X-Hub-Signature` is provided for compatibility with existing integrations, and we recommend that you use the more secure `X-Hub-Signature-256` instead.{% endif %}{% endif %} -- `X-Hub-Signature-256`: This header is sent if the webhook is configured with a [`secret`](/rest/repos#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the `secret` as the HMAC `key`. +- `X-GitHub-Enterprise-Host`: The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %} +- `X-Hub-Signature-256`: This header is sent if the webhook is configured with a secret. This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the configured secret as the HMAC `key`. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/securing-your-webhooks)."{% ifversion not ghae %} +- `X-Hub-Signature`: This header is sent if the webhook is configured with a secret. This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the configured secret as the HMAC `key`. `X-Hub-Signature` is provided for compatibility with existing integrations, and we recommend that you use the more secure `X-Hub-Signature-256` instead.{% endif %} - `User-Agent`: This header will always have the prefix `GitHub-Hookshot/`. +- `X-GitHub-Hook-Installation-Target-Type`: The type of resource where the webhook was created. +- `X-GitHub-Hook-Installation-Target-ID`: The unique identifier of the resource where the webhook was created. To see what each header might look like in a webhook payload, see "[Example webhook delivery](#example-webhook-delivery)." @@ -51,7 +54,6 @@ You can choose to have payloads delivered in JSON format (`application/json`) or ```shell > POST /payload HTTP/2 -> Host: localhost:4567 > X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% ifversion ghes or ghae %} > X-GitHub-Enterprise-Version: 2.15.0 > X-GitHub-Enterprise-Host: example.com{% endif %}{% ifversion not ghae %} @@ -61,6 +63,9 @@ You can choose to have payloads delivered in JSON format (`application/json`) or > Content-Type: application/json > Content-Length: 6615 > X-GitHub-Event: issues +> X-GitHub-Hook-ID: 292430182 +> X-GitHub-Hook-Installation-Target-ID: 79929171 +> X-GitHub-Hook-Installation-Target-Type: repository > { > "action": "opened", diff --git a/src/content-linter/style/base.js b/src/content-linter/style/base.js index d0f4acd791aa..7febf636658c 100644 --- a/src/content-linter/style/base.js +++ b/src/content-linter/style/base.js @@ -57,7 +57,7 @@ export const baseConfig = { }, 'blanks-around-headings': { // MD022 - severity: 'warning', + severity: 'error', 'partial-markdown-files': false, }, 'heading-start-left': {