From c2d6be4e22f35eb406354cb6096f4124d298050d Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Thu, 20 Jul 2023 14:52:41 -0700 Subject: [PATCH 1/5] fix spacing content lint rules (#39332) --- .../managing-your-theme-settings.md | 2 -- ...dependabot-to-work-with-limited-internet-access.md | 2 +- .../enabling-and-scheduling-maintenance-mode.md | 1 - .../managing-github-mobile-for-your-enterprise.md | 1 - ...ubleshooting-github-actions-for-your-enterprise.md | 2 +- ...ith-github-actions-for-github-enterprise-server.md | 1 - .../about-saml-for-enterprise-iam.md | 1 - .../building-ci-checks-with-a-github-app.md | 1 - .../phase-2-preparing-to-enable-at-scale.md | 1 - .../about-code-scanning-alerts.md | 1 - .../setting-up-the-codeql-cli.md | 1 - .../getting-started/securing-your-repository.md | 1 - ...tting-your-default-region-for-github-codespaces.md | 1 - .../developing-in-codespaces/deleting-a-codespace.md | 1 - .../prebuilding-your-codespaces/managing-prebuilds.md | 1 - ...ing-a-single-issue-template-for-your-repository.md | 2 +- .../changing-an-articles-title.md | 1 - .../writing-for-github-docs/content-model.md | 2 +- .../writing-for-github-docs/style-guide.md | 1 - .../contributing/writing-for-github-docs/templates.md | 1 - .../using-videos-in-github-docs.md | 1 - .../quickstart-for-tasklists.md | 11 +++++------ .../archiving-items-automatically.md | 1 - .../exporting-migration-data-from-githubcom.md | 2 +- ...n-a-repository-is-deleted-or-changes-visibility.md | 1 - .../managing-a-merge-queue.md | 2 +- .../about-searching-on-github.md | 6 +++--- .../searching-on-github/searching-discussions.md | 1 - .../dependabot/beta-security-and-version-updates.md | 1 - data/reusables/enterprise_installation/replica-ssh.md | 2 +- data/reusables/supported-languages/swift.md | 1 - 31 files changed, 15 insertions(+), 39 deletions(-) diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings.md index dc623f038818..aa0fd2a345b6 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings.md @@ -33,8 +33,6 @@ If you have low vision, you may benefit from a high contrast theme, with greater 1. Click the theme you'd like to use. - If you chose a single theme, click a theme. - - - If you chose to follow your system settings, click a day theme and a night theme.{% ifversion fpt or ghec %} - If you would like to choose a theme which is currently in public beta, you will first need to enable it with feature preview. For more information, see "[AUTOTITLE](/get-started/using-github/exploring-early-access-releases-with-feature-preview)."{% endif %} diff --git a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md index 026ab757e3a9..62d9e6612340 100644 --- a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md +++ b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md @@ -27,7 +27,7 @@ The instructions below assume that you need to set up {% data variables.product. Before configuring {% data variables.product.prodname_dependabot %}, install Docker on your self-hosted runner. For more information, see "[AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates#configuring-self-hosted-runners-for-dependabot-updates)." -1. On {% data variables.location.product_location %}, navigate to the `github/dependabot-action` repository and retrieve information about the `dependabot-updater` and `dependabot-proxy` container images from the `containers.json` file. +1. On {% data variables.location.product_location %}, navigate to the `github/dependabot-action` repository and retrieve information about the `dependabot-updater` and `dependabot-proxy` container images from the `containers.json` file. Each release of {% data variables.product.product_name %} includes an updated `containers.json` file at: `https://HOSTNAME/github/dependabot-action/blob/ghes-VERSION/docker/containers.json`. You can see the {% data variables.product.prodname_dotcom_the_website %} version of the file at: [containers.json](https://github.com/github/dependabot-action/blob/main/docker/containers.json). diff --git a/content/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.md b/content/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.md index bede04368ac1..2a553e45495b 100644 --- a/content/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.md +++ b/content/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.md @@ -56,7 +56,6 @@ You can perform initial validation of your maintenance operation by configuring ## Validating changes in maintenance mode using the IP exception list - The IP exception list provides controlled and restricted access to {% data variables.location.product_location %}, which is ideal for initial validation of server health following a maintenance operation. Once enabled, {% data variables.location.product_location %} will be taken out of maintenance mode and available only to the configured IP addresses. The maintenance mode checkbox will be updated to reflect the change in state. If you re-enable maintenance mode, the IP exception list will be disabled and {% data variables.location.product_location %} will return to maintenance mode. If you just disable the IP exception list, {% data variables.location.product_location %} will return to normal operation. diff --git a/content/admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise.md b/content/admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise.md index 99d8b58c4987..597a8f88c8c4 100644 --- a/content/admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise.md +++ b/content/admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise.md @@ -20,7 +20,6 @@ shortTitle: Manage GitHub Mobile You can allow or disallow people from using {% data variables.product.prodname_mobile %} to authenticate to {% data variables.location.product_location %} and access your instance's data. By default, {% data variables.product.prodname_mobile %} is enabled for people who use {% data variables.location.product_location %}. - ## Enabling or disabling {% data variables.product.prodname_mobile %} {% data reusables.enterprise_site_admin_settings.access-settings %} diff --git a/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md b/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md index b2c6238ebcac..71abd880a04c 100644 --- a/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md +++ b/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md @@ -221,7 +221,7 @@ To install the official bundled actions and starter workflows within a designate ghe-config app.actions.github-org ORGANIZATION ``` -1. To add the bundled actions to your organization, unset the SHA. +1. To add the bundled actions to your organization, unset the SHA. ```shell ghe-config --unset 'app.actions.actions-repos-sha1sum' diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md index a04828ba1b28..34e539f47e31 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -31,7 +31,6 @@ This article explains how site administrators can configure {% data variables.pr ## Review hardware requirements - The CPU and memory resources available to {% data variables.location.product_location %} determine the number of runners that can be configured without performance loss. {% data reusables.actions.minimum-hardware %} The peak quantity of connected runners without performance loss depends on such factors as job duration, artifact usage, number of repositories running Actions, and how much other work your instance is doing not related to Actions. Internal testing at GitHub demonstrated performance targets for GitHub Enterprise Server on a range of CPU and memory configurations. diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam.md index 32ae0a29aa80..4e250e198333 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam.md @@ -62,7 +62,6 @@ After you configure the application for {% data variables.product.product_name % {% endif %} - {% ifversion ghes %} {% data reusables.enterprise_user_management.external_auth_disables_2fa %} diff --git a/content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md b/content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md index b245e9d2d23a..95050a58973d 100644 --- a/content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md +++ b/content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md @@ -920,7 +920,6 @@ After running RuboCop and saving the linting results, this code runs the command The `rm -rf` command cannot be undone. To keep your app secure, the code in this tutorial checks incoming webhooks for injected malicious commands that could be used to remove a different directory than intended by your app. For example, if a bad actor sent a webhook with the repository name `./`, your app would remove the root directory. The `verify_webhook_signature` method validates the sender of the webhook. The `verify_webhook_signature` event handler also checks that the repository name is valid. For more information, see "[Define a `before` filter](#define-a-before-filter)." - ### Test the code The following steps will show you how to test that the code works and view the errors reported by RuboCop. diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md index c2afb11e4bbf..c2448672d5a4 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md @@ -25,7 +25,6 @@ Rolling {% data variables.product.prodname_code_scanning %} out across hundreds {% ifversion ghec %} {% data variables.product.prodname_code_scanning_caps %} is also available for all public repositories on {% data variables.product.prodname_dotcom_the_website %} without a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} - ### Preparing teams for {% data variables.product.prodname_code_scanning %} First, prepare your teams to use {% data variables.product.prodname_code_scanning %}. The more teams that use {% data variables.product.prodname_code_scanning %}, the more data you'll have to drive remediation plans and monitor progress on your rollout. During this phase, focus on leveraging APIs and running internal enablement events. diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts.md index 4ba40bc353e0..7c0dd9c26849 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts.md @@ -54,7 +54,6 @@ To calculate the security severity of an alert, we use Common Vulnerability Scor By default, any {% data variables.product.prodname_code_scanning %} results with a security severity of `Critical` or `High` will cause a check failure. You can specify which security severity level for {% data variables.product.prodname_code_scanning %} results should cause a check failure. For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning#defining-the-severities-causing-pull-request-check-failure)." - ### About {% ifversion remove-code-scanning-configurations %}alerts from multiple configurations{% else %}analysis origins{% endif %} {% ifversion remove-code-scanning-configurations %} diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md index 9a853d12317b..2c067581fdb2 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md +++ b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md @@ -74,7 +74,6 @@ From macOS version 10.15 ("Catalina") onwards you need to ensure that your web b 1. Click the **General** Tab. 1. Ensure the check-box labeled **Open "safe" files after downloading** is unchecked. - ### 2. Extract the zip archive For Linux, Windows, and macOS users (version 10.14 "Mojave", and earlier) simply extract the zip archive. diff --git a/content/code-security/getting-started/securing-your-repository.md b/content/code-security/getting-started/securing-your-repository.md index 142bb710c678..d0a9086b878a 100644 --- a/content/code-security/getting-started/securing-your-repository.md +++ b/content/code-security/getting-started/securing-your-repository.md @@ -71,7 +71,6 @@ For more information, see "[AUTOTITLE](/code-security/supply-chain-security/unde For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts){% ifversion fpt or ghec %}" and "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-security-and-analysis-settings-for-your-personal-account){% endif %}." - ## Managing dependency review Dependency review lets you visualize dependency changes in pull requests before they are merged into your repositories. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." diff --git a/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md b/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md index 7ee59d4f053e..aa4c4317da08 100644 --- a/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md +++ b/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md @@ -22,4 +22,3 @@ You can manually select the region that your codespaces will be created in, allo 1. Under "Region", select the setting you want: **Set automatically** or **Set manually**. 1. If you chose **Set manually**, select the dropdown menu and click your region. - diff --git a/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/content/codespaces/developing-in-codespaces/deleting-a-codespace.md index de52652a3d44..9c02b8fb46e8 100644 --- a/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/deleting-a-codespace.md @@ -55,7 +55,6 @@ There are costs associated with storing codespaces. You should therefore delete {% endnote %} - {% vscode %} {% data reusables.codespaces.deleting-a-codespace-in-vscode %} diff --git a/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md b/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md index 60a451b24ae7..ccb38c322959 100644 --- a/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md +++ b/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md @@ -81,7 +81,6 @@ Disabling the workflow runs for a prebuild configuration is useful if you need t {% endnote %} - Deleting a prebuild configuration also deletes all previously created prebuilds for that configuration. As a result, shortly after you delete a configuration, prebuilds generated by that configuration will no longer be available when you create a new codespace. After you delete a prebuild configuration, workflow runs for that configuration that have been queued or started will still run. They will be listed in the workflow run history, along with previously completed workflow runs. diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md index 33147ca64761..c99b65a377ac 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md @@ -56,7 +56,7 @@ assignees: octocat {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} 1. In the file name field: - - To make your issue template visible in the repository's root directory, type the name of your _issue_template_. For example, `issue_template.md`. + - To make your issue template visible in the repository's root directory, type the name of your _issue_template_. For example, `issue_template.md`. - To make your issue template visible in the repository's `docs` directory, type _docs/_ followed by the name of your _issue_template_. For example, `docs/issue_template.md`, - To store your file in a hidden directory, type _.github/_ followed by the name of your _issue_template_. For example, `.github/issue_template.md`. - To create multiple issue templates and use the `template` query parameter to specify a template to fill the issue body, type _.github/ISSUE_TEMPLATE/_, then the name of your issue template. For example, `.github/ISSUE_TEMPLATE/issue_template.md`. You can also store multiple issue templates in an `ISSUE_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." diff --git a/content/contributing/syntax-and-versioning-for-github-docs/changing-an-articles-title.md b/content/contributing/syntax-and-versioning-for-github-docs/changing-an-articles-title.md index 32cc21acd9f6..35f6e1ced59c 100644 --- a/content/contributing/syntax-and-versioning-for-github-docs/changing-an-articles-title.md +++ b/content/contributing/syntax-and-versioning-for-github-docs/changing-an-articles-title.md @@ -11,7 +11,6 @@ versions: Sometimes, it's necessary to change the title of a help article. There are several considerations to keep in mind when you retitle an article. - ## Background on changing the filename The title of the article corresponds directly to the name of the Markdown file that contains that article, for a couple of reasons: diff --git a/content/contributing/writing-for-github-docs/content-model.md b/content/contributing/writing-for-github-docs/content-model.md index b8472281577a..e01d8dc64ff1 100644 --- a/content/contributing/writing-for-github-docs/content-model.md +++ b/content/contributing/writing-for-github-docs/content-model.md @@ -380,7 +380,7 @@ Contents of tutorials: - Does not include the expected amount of time that it may take someone to complete the task - this depends on the experience level of the person completing the tutorial. - Procedural sections - Based on the tutorial's audience, the steps can be less explicit and formal than those used in procedural content. You do not have to use existing reusables to form these steps if the audience doesn’t require that level of detail. - - Use: "From your profile, click **Settings, and then click **Developer settings**.” + - Use: "From your profile, click **Settings**, and then click **Developer settings**.” - Avoid: In the upper-right corner of any page, click your profile photo, then click **Settings**. In the left sidebar, click **Developer settings**. - Link out to other articles or resources rather than replicating them, to avoid interrupting the flow of information in the tutorial. - Give visual cues. Use code blocks and screenshots heavily to help reassure people that they are performing the correct actions. diff --git a/content/contributing/writing-for-github-docs/style-guide.md b/content/contributing/writing-for-github-docs/style-guide.md index bd1b7fb984df..71b38352dfd4 100644 --- a/content/contributing/writing-for-github-docs/style-guide.md +++ b/content/contributing/writing-for-github-docs/style-guide.md @@ -995,7 +995,6 @@ Table content is left-aligned by default. Use Markdown table formatting, colons The following example shows part of a table from "[AUTOTITLE](/free-pro-team@latest/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file)." - diff --git a/content/contributing/writing-for-github-docs/templates.md b/content/contributing/writing-for-github-docs/templates.md index d26ece1a072a..b08db4d35aed 100644 --- a/content/contributing/writing-for-github-docs/templates.md +++ b/content/contributing/writing-for-github-docs/templates.md @@ -289,7 +289,6 @@ Include a bulleted list of tutorials or articles the user can reference to exten Use the content model for full instructions and examples on how to write for {% data variables.product.prodname_docs %}. For more information, see "[AUTOTITLE](/contributing/writing-for-github-docs/content-model)." - ```yaml {% raw %}--- title: Guide title 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 4c93dce91d7d..91f7cd618fba 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 @@ -11,7 +11,6 @@ versions: Videos are used rarely in the {% data variables.product.prodname_docs %}. When videos are necessary to provide the best user experience for an article, they are used together with written text. Videos are not a replacement for written content. Videos should never be the only way information is communicated because they are more difficult to keep up to date and are not accessible to everyone. - Use these guidelines to determine if a video is appropriate to include in an article or on a landing page in the docs. If you add a link to a video or embed a video in the {% data variables.product.prodname_docs %}, add the video's metadata to the "[Videos in {% data variables.product.prodname_docs %}](https://github.com/github/docs/blob/main/contributing/videos-in-github-docs.md)" file in the `github/docs` repository. diff --git a/content/issues/managing-your-tasks-with-tasklists/quickstart-for-tasklists.md b/content/issues/managing-your-tasks-with-tasklists/quickstart-for-tasklists.md index 141ee9df2e1f..3b831d1448e8 100644 --- a/content/issues/managing-your-tasks-with-tasklists/quickstart-for-tasklists.md +++ b/content/issues/managing-your-tasks-with-tasklists/quickstart-for-tasklists.md @@ -48,11 +48,11 @@ Draft tasks are text items that are added to your tasklist. Draft tasks appear i 1. Add some draft tasks to sketch out this work. Type your draft task and then press Enter after each one. - For our example landing page scenario, you can add: - * "Design new landing page" - * "Create content for landing page" - * "Translate content into supported languages" - + For our example landing page scenario, you can add: + - "Design new landing page" + - "Create content for landing page" + - "Translate content into supported languages" + ## Converting a draft task into an issue You can convert your draft tasks into issues. You can convert draft tasks when you're ready to start work on a particular task. The issues are created in the same repository you have used for your tracking issue. @@ -126,7 +126,6 @@ You can also track existing issues by adding them to your tasklist. You can add ![Screenshot of an issue being edited. There are two tasklists present and the "Update comment" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/tasklist-markdown-draft-edit.png) - You will see your new second tasklist displayed beneath your first tasklist. ## Tracking progress diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md index f94620370339..7350797832f4 100644 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md +++ b/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md @@ -15,7 +15,6 @@ topics: {% endif %} - ## About automatically archiving items You can configure your project's built-in workflows to automatically archive items. Archiving items will help you stay below the limit of {% data variables.projects.item_limit %} items in each project. diff --git a/content/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom.md b/content/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom.md index 552040095338..609e5bdd5680 100644 --- a/content/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom.md +++ b/content/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom.md @@ -56,7 +56,7 @@ The Migrations API is currently in a preview period, which means that the endpoi https://api.github.com/orgs/ORG_NAME/migrations ``` - - If you want to lock the repositories before migrating them, make sure `lock_repositories` is set to `true`. This is highly recommended. + - If you want to lock the repositories before migrating them, make sure `lock_repositories` is set to `true`. This is highly recommended. - You can exclude file attachments by passing `exclude_attachments: true` to the endpoint. {% data reusables.enterprise_migrations.exclude-file-attachments %} The final archive size must be less than 20 GB. This request returns a unique `id` which represents your migration. You'll need it for subsequent calls to the Migrations API. diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index db26d9d6df76..548f8ff9484d 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -66,7 +66,6 @@ If a private repository is made public and then deleted, its private forks will When you change a private repository to public, all the commits in that repository, including any commits made in the repositories it was forked into, will be visible to everyone. However, the private forks will not automatically become public. Instead, each private fork will become a separate private repository and create its own independent network of repositories. Any new changes made to these networks will not be accessible from the original repository. - ### Deleting the internal repository If you change the visibility of an internal repository and then delete the repository, the forks will continue to exist in a separate network. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md index b65eb1e0bb48..5c54801713fe 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md @@ -110,7 +110,7 @@ The following scenario outlines what happens when a CI reports a failing status 1. The merge queue creates a temporary branch with the prefix of `main/pr-1` that contains code changes from the target branch and pull request #1. A `merge_group` webhook event of type `checks_requested` is dispatched and the merge queue will await a response from your CI provider. 1. User adds pull request #2 to the merge queue. 1. The merge queue creates a temporary branch with the prefix of `main/pr-2` that contains code changes from the target branch, pull request #1, and pull request #2, and dispatches webhooks. -1. When the {% data variables.product.product_name %} API receives a failing status for `main/pr-1`, the merge queue automatically removes pull request #1 from the merge queue. +1. When the {% data variables.product.product_name %} API receives a failing status for `main/pr-1`, the merge queue automatically removes pull request #1 from the merge queue. 1. The merge queue recreates the temporary branch with the prefix of `main/pr-2` to only contain changes from the target branch and pull request #2. 1. When the {% data variables.product.product_name %} API receives successful CI responses for `merge_group` branch `main/pr-2`, the temporary branch `main/pr-2` will be merged in to the target branch without pull request #1 included. diff --git a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index 184b23c4a24f..e78fc8578ad4 100644 --- a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -28,9 +28,9 @@ topics: {% ifversion code-search-code-view %} You can also use suggestions and completions in the search bar to quickly find what you need. -- If you click on the search bar in the top navigation of GitHub.com, you will see a list of suggestions organized by category, including recent searches and suggested repositories, teams, and projects that you have access to. -- Clicking on any of the specific suggestions will take you directly to the page for that suggestion (for example, the repository or project page). If you click on a recent search, depending on the type of search, the search term will appear in the search bar or you will be taken to the search results page for the search term. -- Once you start typing, you will see a list of completions and suggestions that match your query. You can click on a suggestion to jump to a specific location. As you continue to type, you will see more specific suggestions, such as code files you can jump to directly. +- If you click on the search bar in the top navigation of GitHub.com, you will see a list of suggestions organized by category, including recent searches and suggested repositories, teams, and projects that you have access to. +- Clicking on any of the specific suggestions will take you directly to the page for that suggestion (for example, the repository or project page). If you click on a recent search, depending on the type of search, the search term will appear in the search bar or you will be taken to the search results page for the search term. +- Once you start typing, you will see a list of completions and suggestions that match your query. You can click on a suggestion to jump to a specific location. As you continue to type, you will see more specific suggestions, such as code files you can jump to directly. After typing a search query, you can press **Enter** to go to the full search results view, where you can see each match and a visual interface for applying filters. For more information, see "[Searching using a visual interface](#searching-using-a-visual-interface)." {% endif %} diff --git a/content/search-github/searching-on-github/searching-discussions.md b/content/search-github/searching-on-github/searching-discussions.md index 65846de27f4f..e35594ba75b7 100644 --- a/content/search-github/searching-on-github/searching-discussions.md +++ b/content/search-github/searching-on-github/searching-discussions.md @@ -145,7 +145,6 @@ You can filter discussions by specific labels that are applied to discussions. | :- | :- | | label: "LABEL NAME" | [**label:"Product Feedback"**](https://github.com/search?utf8=%E2%9C%93&q=label%3A%22product+feedback%22&type=discussions) matches discussions that match the label "Product Feedback". - ## Further reading - "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)" diff --git a/data/reusables/dependabot/beta-security-and-version-updates.md b/data/reusables/dependabot/beta-security-and-version-updates.md index a163af1e59c2..04666c28b92b 100644 --- a/data/reusables/dependabot/beta-security-and-version-updates.md +++ b/data/reusables/dependabot/beta-security-and-version-updates.md @@ -1,5 +1,4 @@ - {% ifversion ghae = 3.4 %} {% note %} diff --git a/data/reusables/enterprise_installation/replica-ssh.md b/data/reusables/enterprise_installation/replica-ssh.md index 558689d887f7..703ba8a25c5c 100644 --- a/data/reusables/enterprise_installation/replica-ssh.md +++ b/data/reusables/enterprise_installation/replica-ssh.md @@ -1,4 +1,4 @@ -1. Connect to the replica node over SSH as the `admin` user on port 122: +1. Connect to the replica node over SSH as the `admin` user on port 122: ```shell ssh -p 122 admin@REPLICA_HOST diff --git a/data/reusables/supported-languages/swift.md b/data/reusables/supported-languages/swift.md index d847f63d414c..0ad0c7a9a467 100644 --- a/data/reusables/supported-languages/swift.md +++ b/data/reusables/supported-languages/swift.md @@ -1,2 +1 @@ | Swift | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Unsupported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %}
Swift Package Manager | - From 288be954d7df5f0c5e7b82771405ab24147ce508 Mon Sep 17 00:00:00 2001 From: Jess Hosman <1183847+jhosman@users.noreply.github.com> Date: Thu, 20 Jul 2023 15:53:22 -0600 Subject: [PATCH 2/5] Fix broken link to "Videos in GitHub Docs" (#39316) --- .../writing-for-github-docs/using-videos-in-github-docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 91f7cd618fba..98bb86556371 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 @@ -13,7 +13,7 @@ Videos are used rarely in the {% data variables.product.prodname_docs %}. When v Use these guidelines to determine if a video is appropriate to include in an article or on a landing page in the docs. -If you add a link to a video or embed a video in the {% data variables.product.prodname_docs %}, add the video's metadata to the "[Videos in {% data variables.product.prodname_docs %}](https://github.com/github/docs/blob/main/contributing/videos-in-github-docs.md)" file in the `github/docs` repository. +If you add a link to a video or embed a video in the {% data variables.product.prodname_docs %}, add the video's metadata to the "[Videos in {% data variables.product.prodname_docs %}](https://github.com/github/docs/blob/main/contributing/videos-in-docs.md)" file in the `github/docs` repository. The Docs team does not create or maintain video content. Videos are purely supplemental to help communicate significant or complex topics, and should be used sparingly because they are not a content type owned by the Docs team. From 154f227e199a88ccd263d541fae6fe5b5737a1aa Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Thu, 20 Jul 2023 14:58:35 -0700 Subject: [PATCH 3/5] add severity to content linter results (#39388) --- src/content-linter/scripts/markdownlint.js | 35 +++++++++++++--------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/src/content-linter/scripts/markdownlint.js b/src/content-linter/scripts/markdownlint.js index 6a9cbd893821..22a052cf7607 100755 --- a/src/content-linter/scripts/markdownlint.js +++ b/src/content-linter/scripts/markdownlint.js @@ -71,18 +71,18 @@ async function main() { } } + const errorFileCount = getErrorCountByFile(results) // Used for a temparary way to allow us to see how many errors currently // exist for each rule in the content directory. - if (summaryByRule) { + if (summaryByRule && errorFileCount > 0) { reportSummaryByRule(results, config) - } else { + } else if (errorFileCount > 0) { reportResults(results) } const end = Date.now() - console.log(`🕦 Markdownlint finished in ${(end - start) / 1000} s`) + console.log(`\n🕦 Markdownlint finished in ${(end - start) / 1000} s`) - const errorFileCount = getErrorCountByFile(results) if (errorFileCount > 0) { spinner.fail(`Found ${errorFileCount} file(s) with error(s)`) process.exit(1) @@ -154,20 +154,21 @@ function reportSummaryByRule(results, config) { console.log(JSON.stringify(ruleCount, null, 2)) } -function reportResults(results) { +function reportResults(allResults) { console.log('\n\nMarkdownlint results:\n') - Object.entries(results) + Object.entries(allResults) // Each result key always has an array value, but it may be empty - .filter(([, result]) => result.length) - .forEach(([key, result]) => { + .filter(([, results]) => results.length) + .forEach(([key, results]) => { console.log(key) if (!verbose) { - result.forEach((flaw) => { - const simplifiedResult = formatResult(flaw) - console.log(simplifiedResult) - }) + const formattedResults = results.map((flaw) => formatResult(flaw)) + const errors = formattedResults.filter((result) => result.severity === 'error') + const warnings = formattedResults.filter((result) => result.severity === 'warning') + const sortedResult = [...errors, ...warnings] + console.log(sortedResult) } else { - console.log(result) + console.log(results) } }) } @@ -185,6 +186,12 @@ function getErrorCountByFile(results) { // Removes null values and properties that are not relevant to content // writers and transforms some error data into a more readable format. function formatResult(object) { + const formattedResult = {} + + // Add severity of error or warning + const ruleName = object.ruleNames[1] + formattedResult.severity = allConfig[ruleName].severity + return Object.entries(object).reduce((acc, [key, value]) => { if (key === 'fixInfo') { acc.fixable = !!value @@ -199,7 +206,7 @@ function formatResult(object) { } acc[key] = value return acc - }, {}) + }, formattedResult) } // Get a list of changed and staged files in the local git repo From fda47c8f2b6d8275f4e16ec9e29c541b8e300582 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 20 Jul 2023 14:59:39 -0700 Subject: [PATCH 4/5] Update OpenAPI Description (#39380) --- src/rest/data/fpt-2022-11-28/schema.json | 2 +- src/rest/data/ghae/schema.json | 44 +++++++++---------- src/rest/data/ghec-2022-11-28/schema.json | 2 +- src/rest/data/ghes-3.6/schema.json | 8 ++-- src/rest/data/ghes-3.7/schema.json | 8 ++-- src/rest/data/ghes-3.8/schema.json | 8 ++-- src/rest/data/ghes-3.9-2022-11-28/schema.json | 8 ++-- 7 files changed, 40 insertions(+), 40 deletions(-) diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 83dcae63e3c0..21157ce41847 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -541667,7 +541667,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
", + "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
 curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 149e9ea77b9a..1dd7c2a0b2f1 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -313466,7 +313466,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -314080,7 +314080,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -314167,7 +314167,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -314521,7 +314521,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -315124,7 +315124,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -315201,7 +315201,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -315559,7 +315559,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -316170,7 +316170,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -316247,7 +316247,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -316605,7 +316605,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -317212,7 +317212,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -317289,7 +317289,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -317651,7 +317651,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -318258,7 +318258,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -318335,7 +318335,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -318693,7 +318693,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -319300,7 +319300,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -319377,7 +319377,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -319737,7 +319737,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -320342,7 +320342,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] }, { @@ -320419,7 +320419,7 @@ } ], "previews": [ - "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview\n
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" ] } ] @@ -400658,7 +400658,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
", + "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
 curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index aedab10070e6..dce9771d4b99 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -562768,7 +562768,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
", + "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
 curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json index b85be8b3ab46..249d598bfc02 100644 --- a/src/rest/data/ghes-3.6/schema.json +++ b/src/rest/data/ghes-3.6/schema.json @@ -398971,8 +398971,8 @@ } ], "previews": [ - "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
", - "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json\n
", + "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] }, { @@ -403082,7 +403082,7 @@ } ], "previews": [ - "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] }, { @@ -461706,7 +461706,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
", + "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
 curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json index 83dd9bf1fa85..8a339d1e4c11 100644 --- a/src/rest/data/ghes-3.7/schema.json +++ b/src/rest/data/ghes-3.7/schema.json @@ -402704,8 +402704,8 @@ } ], "previews": [ - "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
", - "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json\n
", + "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] }, { @@ -406833,7 +406833,7 @@ } ], "previews": [ - "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] }, { @@ -465626,7 +465626,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
", + "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
 curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index c2474eb2942f..c3b298db349b 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -412893,8 +412893,8 @@ } ], "previews": [ - "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
", - "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json\n
", + "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] }, { @@ -417022,7 +417022,7 @@ } ], "previews": [ - "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] }, { @@ -475919,7 +475919,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
", + "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
 curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index f6720eaf7735..cbf6e7a0caa0 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -430836,8 +430836,8 @@ } ], "previews": [ - "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
", - "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json\n
", + "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] }, { @@ -435178,7 +435178,7 @@ } ], "previews": [ - "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] }, { @@ -494416,7 +494416,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
", + "descriptionHTML": "

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

\n
 curl -u username:token\n  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n
", "statusCodes": [ { "httpStatusCode": "200", From 2b7ee74092744a9c782b477c1c702c2c3cf06314 Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Thu, 20 Jul 2023 15:02:50 -0700 Subject: [PATCH 5/5] Lint rules that need manual fixes (#39334) --- ...-the-dependency-graph-for-your-enterprise.md | 17 +++++++---------- .../viewing-and-updating-dependabot-alerts.md | 2 +- .../changing-an-articles-title.md | 7 ++++--- .../about-githubs-documentation-philosophy.md | 2 +- .../writing-for-github-docs/content-model.md | 2 +- ...ration-data-from-github-enterprise-server.md | 6 ++++-- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md index 55c0eff2dcc7..1bd232b56fe8 100644 --- a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md +++ b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md @@ -18,9 +18,8 @@ topics: {% data reusables.dependency-review.dependency-review-enabled-ghes %} -After you enable the dependency graph for your enterprise, you can enable {% data variables.product.prodname_dependabot %} to detect insecure dependencies in your repository{% ifversion ghes %} and automatically fix the vulnerabilities{% endif %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." +After you enable the dependency graph for your enterprise, you can enable {% data variables.product.prodname_dependabot %} to detect insecure dependencies in your repository and automatically fix the vulnerabilities. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." -{% ifversion ghes %} You can enable the dependency graph via the {% data variables.enterprise.management_console %} or the administrative shell. We recommend using the {% data variables.enterprise.management_console %} unless {% data variables.location.product_location %} uses clustering. ## Enabling the dependency graph via the {% data variables.enterprise.management_console %} @@ -37,24 +36,22 @@ If {% data variables.location.product_location %} uses clustering, you cannot en ## Enabling the dependency graph via the administrative shell -{% endif %} {% data reusables.enterprise_site_admin_settings.sign-in %} 1. In the administrative shell, enable the dependency graph on {% data variables.location.product_location %}: - {% ifversion ghes %}```shell - ghe-config app.dependency-graph.enabled true + ```shell + ghe-config app.dependency-graph.enabled true ``` - {% else %}```shell - ghe-config app.github.dependency-graph-enabled true - ghe-config app.github.vulnerability-alerting-and-settings-enabled true - ```{% endif %} + {% note %} **Note**: For more information about enabling access to the administrative shell via SSH, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." {% endnote %} 1. Apply the configuration. + ```shell - $ ghe-config-apply + ghe-config-apply ``` + 1. Return to {% data variables.product.prodname_ghe_server %}. diff --git a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index c029022ae098..aaf20f0d637f 100644 --- a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -118,7 +118,7 @@ For more information, see "[Reviewing and fixing alerts](#reviewing-and-fixing-a 1. Optionally, to filter alerts, select a filter in a dropdown menu then click the filter that you would like to apply. You can also type filters into the search bar. {% ifversion dependabot-filter-label-security-advisory %}Alternatively, to filter by label, click a label assigned to an alert to automatically apply that filter to the alert list.{% endif %} For more information about filtering and sorting alerts, see "[Prioritizing {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-dependabot-alerts)." {%- ifversion dependabot-bulk-alerts %} - ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% endif %} + ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab.](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% endif %} 1. Click the alert that you would like to view. {% ifversion dependabot-filter-label-security-advisory %} 1. Optionally, to suggest an improvement to the related security advisory, on the right-hand side of the alert details page, click **Suggest improvements for this advisory on the {% data variables.product.prodname_advisory_database %}**. For more information, see "[AUTOTITLE](/code-security/security-advisories/global-security-advisories/editing-security-advisories-in-the-github-advisory-database)." diff --git a/content/contributing/syntax-and-versioning-for-github-docs/changing-an-articles-title.md b/content/contributing/syntax-and-versioning-for-github-docs/changing-an-articles-title.md index 35f6e1ced59c..7adcaf4e6c48 100644 --- a/content/contributing/syntax-and-versioning-for-github-docs/changing-an-articles-title.md +++ b/content/contributing/syntax-and-versioning-for-github-docs/changing-an-articles-title.md @@ -7,7 +7,7 @@ versions: feature: 'contributing' --- -# Changing the title of an article +## Changing the title of an article Sometimes, it's necessary to change the title of a help article. There are several considerations to keep in mind when you retitle an article. @@ -25,7 +25,7 @@ There are several places you may need to update when you give an article a new t Each article contains a metadata section or frontmatter located at the **top of the article** formatted using YAML syntax. This metadata section generates the title of the article and contains other important data, such as redirects and sometimes even short description conrefs that link to reusable intro text. -``` +```yaml --- title: Your article name intro: @@ -33,11 +33,12 @@ redirect_from: - /articles/older-outdated-article-name/ --- ``` + #### Frontmatter update checklist - Update title using sentence case - Update redirects. Almost every time we retitle an article, we should add a redirect referencing the article's old URL and make sure we keep any redirects in the old article's frontmatter. - + ### Filename You can use the [`git mv` command](https://git-scm.com/docs/git-mv) in your terminal to change the name of the file. diff --git a/content/contributing/writing-for-github-docs/about-githubs-documentation-philosophy.md b/content/contributing/writing-for-github-docs/about-githubs-documentation-philosophy.md index e5791b275da4..09d6f8eecf46 100644 --- a/content/contributing/writing-for-github-docs/about-githubs-documentation-philosophy.md +++ b/content/contributing/writing-for-github-docs/about-githubs-documentation-philosophy.md @@ -7,7 +7,7 @@ versions: feature: 'contributing' --- -# About the {% data variables.product.prodname_dotcom %} documentation philosophy +## About the {% data variables.product.prodname_dotcom %} documentation philosophy As the home to the world's largest community of developers, we want to make sure that our documentation is accurate, valuable, inclusive, and easy to use. Our documentation philosophy leads us toward these goals. diff --git a/content/contributing/writing-for-github-docs/content-model.md b/content/contributing/writing-for-github-docs/content-model.md index e01d8dc64ff1..164a9549a92b 100644 --- a/content/contributing/writing-for-github-docs/content-model.md +++ b/content/contributing/writing-for-github-docs/content-model.md @@ -434,7 +434,7 @@ Within an article, there is a standard order of content sections. Every article 11. Troubleshooting content 12. Further reading (conditional) -![Screenshot of article with title, intro, permissions, product callout, conceptual section, procedural section, and table of contents labeled](/assets/images/contributing/illustration-of-article-contents.png) +![Screenshot of article with title, intro, permissions, product callout, conceptual section, procedural section, and table of contents labeled.](/assets/images/contributing/illustration-of-article-contents.png) ### Titles diff --git a/content/migrations/using-ghe-migrator/exporting-migration-data-from-github-enterprise-server.md b/content/migrations/using-ghe-migrator/exporting-migration-data-from-github-enterprise-server.md index 81208a7da279..83c5c08491dc 100644 --- a/content/migrations/using-ghe-migrator/exporting-migration-data-from-github-enterprise-server.md +++ b/content/migrations/using-ghe-migrator/exporting-migration-data-from-github-enterprise-server.md @@ -38,14 +38,16 @@ shortTitle: Export from GHES {% data reusables.enterprise_installation.ssh-into-instance %} 1. To prepare a repository for export, use the `ghe-migrator add` command with the repository's URL: - If you're locking the repository, append the command with `--lock`. If you're performing a trial run, `--lock` is not needed. + ```shell - $ ghe-migrator add https://HOSTNAME/USERNAME/REPO-NAME --lock + ghe-migrator add https://HOSTNAME/USERNAME/REPO-NAME --lock ``` + - You can exclude file attachments by appending `--exclude_attachments` to the command. {% data reusables.enterprise_migrations.exclude-file-attachments %} - To prepare multiple repositories at once for export, create a text file listing each repository URL on a separate line, and run the `ghe-migrator add` command with the `-i` flag and the path to your text file. ```shell - $ ghe-migrator add -i PATH/TO/YOUR/REPOSITORY_URL.txt + ghe-migrator add -i PATH/TO/YOUR/REPOSITORY_URL.txt ``` 1. When prompted, enter your {% data variables.product.prodname_ghe_server %} username: