From cdb90bb2ae97f6a3f24565eaafb1cb2c72141e9c Mon Sep 17 00:00:00 2001 From: mc <42146119+mchammer01@users.noreply.github.com> Date: Thu, 16 Jan 2025 07:19:38 +0000 Subject: [PATCH 1/5] Hack week 2025: remove unneeded FBV instances (8) - Issues, Enterprise, and custom repo roles (#53935) --- .../viewing-peoples-roles-in-an-organization.md | 2 +- .../command-line-utilities.md | 2 -- .../enabling-and-scheduling-maintenance-mode.md | 11 ++--------- ...omizing-user-messages-for-your-enterprise.md | 17 +++-------------- ...ining-custom-patterns-for-secret-scanning.md | 7 +------ .../custom-patterns/managing-custom-patterns.md | 6 +----- .../managing-discussions.md | 3 --- .../moderating-discussions.md | 3 --- .../about-issues.md | 3 ++- ...ewing-the-audit-log-for-your-organization.md | 2 +- ...announcement-banner-for-your-organization.md | 3 ++- ...mmit-signoff-policy-for-your-organization.md | 4 +++- .../about-custom-repository-roles.md | 7 ++----- ...stom-repository-roles-for-an-organization.md | 3 ++- ...ting-base-permissions-for-an-organization.md | 2 +- .../about-commits.md | 7 +------ .../configuring-tag-protection-rules.md | 3 +-- ...commit-signoff-policy-for-your-repository.md | 4 +++- ...-scanning-dry-run-select-enterprise-repos.md | 5 ----- .../secret-scanning-dry-run-select-repos.md | 5 ----- .../audit_log/audit-log-action-categories.md | 2 +- .../custom-maintenance-message.md | 2 -- 22 files changed, 27 insertions(+), 76 deletions(-) diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md index aba42992ca38..d2ea9b248849 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md @@ -49,7 +49,7 @@ You can also view whether an enterprise owner has a specific role in the organiz | Enterprise owner | Organization owner | Able to configure organization settings and manage access to the organization's resources through teams, etc. | | Enterprise owner | Organization member | Able to access organization resources and content, such as repositories, without access to the organization's settings. | -To review all roles in an organization, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization). {% ifversion custom-repository-roles %} An organization member can also have a custom role for a specific repository. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %} +To review all roles in an organization, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization). {% ifversion ghec or ghes %} An organization member can also have a custom role for a specific repository. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %} For more information about the enterprise owner role, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner). diff --git a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md index bd107044f619..ad977dc00dc3 100644 --- a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md +++ b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md @@ -617,12 +617,10 @@ $ ghe-cluster-maintenance -q # Queries the current mode $ ghe-cluster-maintenance -s # Sets maintenance mode -{%- ifversion custom-maintenance-mode-message %} $ ghe-cluster-maintenance -s "MESSAGE" # Sets maintenance mode with a custom message $ ghe-cluster-maintenance -m "MESSAGE" # Updates the custom message -{%- endif %} $ ghe-cluster-maintenance -u # Unsets maintenance mode ``` diff --git a/content/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode.md b/content/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode.md index 932d3beabca4..5abb66194938 100644 --- a/content/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode.md +++ b/content/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode.md @@ -50,12 +50,11 @@ You can perform initial validation of your maintenance operation by configuring 1. In the top navigation bar, click **Maintenance**. ![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Maintenance", is highlighted with an orange outline.](/assets/images/enterprise/management-console/maintenance-tab.png) -1. Under "Enable and schedule", {% ifversion custom-maintenance-mode-message %}select **Enable maintenance mode**, then {% endif %}decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time. +1. Under "Enable and schedule", select **Enable maintenance mode**, then decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time. * To enable maintenance mode immediately, select the dropdown menu and click **now**. * To schedule a maintenance window for a future time, select the dropdown menu and click a start time. {% data reusables.enterprise_management_console.custom-maintenance-message %} -{% ifversion custom-maintenance-mode-message %}1. When you're satisfied with the timing of the window and the optional message, click **Save**. If you selected "now", your instance will be put into maintenance mode immediately. -{% else %}1. When you're satisfied with the timing of the window, select the checkbox next to "Enable maintenance mode". If you selected "now", your instance will be put into maintenance mode immediately.{% endif %} +1. When you're satisfied with the timing of the window and the optional message, click **Save**. If you selected "now", your instance will be put into maintenance mode immediately. {% ifversion ip-exception-list %} @@ -103,8 +102,6 @@ For more information, see [AUTOTITLE](/admin/administering-your-instance/adminis {% endif %} -{% ifversion custom-maintenance-mode-message %} - ## Managing maintenance mode using SSH If you have SSH access, you can use the `ghe-maintenance` command line utility to can set or unset maintenance mode for a {% data variables.product.product_name %} instance with one node, or multiple nodes in a high-availability configuration. For more information, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh) and [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-maintenance). @@ -120,14 +117,10 @@ $ ghe-cluster-maintenance -q # Queries the current mode $ ghe-cluster-maintenance -s # Sets maintenance mode -{%- ifversion custom-maintenance-mode-message %} $ ghe-cluster-maintenance -s "MESSAGE" # Sets maintenance mode with a custom message $ ghe-cluster-maintenance -m "MESSAGE" # Updates the custom message -{%- endif %} $ ghe-cluster-maintenance -u # Unsets maintenance mode ``` - -{% endif %} diff --git a/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md b/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md index 5a154f0e4ee0..a5a8ae021345 100644 --- a/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md @@ -107,8 +107,7 @@ Each time a user sees a mandatory message, an audit log event is created. The ev You can set a global announcement banner to be displayed to all users at the top of every page{% ifversion ghec %} within your enterprise, including every page in every organization owned by the enterprise{% endif %}. -{% ifversion custom-banner-messages %} -You can also create announcement banners at the organization level. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization).{% endif %} +You can also create announcement banners at the organization level. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization). {% ifversion ghes %} You can also set an announcement banner{% ifversion ghes %} in the administrative shell using a command line utility or{% endif %} using the API. For more information, see {% ifversion ghes %}[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-announce) and {% endif %}[AUTOTITLE](/rest/enterprise-admin#announcements). @@ -116,19 +115,9 @@ You can also set an announcement banner{% ifversion ghes %} in the administrativ {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} -{% data reusables.enterprise-accounts.messages-tab %}{% ifversion custom-banner-messages %}{% else %} -1. To the right of "Announcement", click **Add announcement**.{% endif %} -1. Under "Announcement", in the text field, type the announcement you want displayed in a banner. -1. Optionally, under "Expires on", select the calendar drop-down menu and click an expiration date. - {% ifversion ghe-announce-dismiss %} - - > [!NOTE] - > Announcements must either have an expiration date, be user dismissible, or both. - - {% endif %} +{% data reusables.enterprise-accounts.messages-tab %} {%- ifversion ghe-announce-dismiss %} 1. Optionally, to allow each user to dismiss the announcement, select **User dismissible**. -{%- endif %}{% ifversion custom-banner-messages %} -1. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**. {%- endif %} +1. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**. {% data reusables.enterprise_site_admin_settings.message-preview-save %} diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md index eafa766c51be..afe695d59e5c 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md +++ b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md @@ -60,10 +60,9 @@ Before defining a custom pattern, you must ensure that {% data variables.product {% data reusables.repositories.navigate-to-code-security-and-analysis %} {% data reusables.repositories.navigate-to-ghas-settings %} {% data reusables.advanced-security.secret-scanning-new-custom-pattern %} -{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}{% ifversion custom-pattern-dry-run-ga %} +{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} 1. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click **Save and dry run**. {% data reusables.advanced-security.secret-scanning-dry-run-results %} -{% endif %} {% data reusables.advanced-security.secret-scanning-create-custom-pattern %}{% ifversion secret-scanning-push-protection-custom-patterns %} 1. Optionally, to enable push protection for your custom pattern, click **Enable**. @@ -121,11 +120,9 @@ To enable {% data variables.product.prodname_secret_scanning %} on all repositor {% endif %} {% data reusables.advanced-security.secret-scanning-new-custom-pattern-org %} {% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} -{%- ifversion custom-pattern-dry-run-ga %} 1. When you're ready to test your new custom pattern, to identify matches in select repositories without creating alerts, click **Save and dry run**. {% data reusables.advanced-security.secret-scanning-dry-run-select-repos %} {% data reusables.advanced-security.secret-scanning-dry-run-results %} -{%- endif %} {% data reusables.advanced-security.secret-scanning-create-custom-pattern %}{% ifversion secret-scanning-push-protection-custom-patterns %} 1. Optionally, to enable push protection for your custom pattern, click **Enable**. For more information, see [AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-in-an-organization-for-a-custom-pattern). @@ -147,11 +144,9 @@ Before defining a custom pattern, you must ensure that you enable secret scannin 1. Under "{% ifversion code-security-wording-only-enterprise %}Code security{% else %}Code security and analysis{% endif %}", click **Security features**. 1. Under "Secret scanning custom patterns", click **New pattern**. {% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %} -{%- ifversion custom-pattern-dry-run-ga %} 1. When you're ready to test your new custom pattern, to identify matches in the enterprise without creating alerts, click **Save and dry run**. {% data reusables.advanced-security.secret-scanning-dry-run-select-enterprise-repos %} {% data reusables.advanced-security.secret-scanning-dry-run-results %} -{%- endif %} {% data reusables.advanced-security.secret-scanning-create-custom-pattern %}{% ifversion secret-scanning-push-protection-custom-patterns %} 1. Optionally, to enable push protection for your custom pattern, click **Enable**. For more information, see [AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning). {% indented_data_reference reusables.secret-scanning.push-protection-enterprise-note spaces=3 %}{% endif %} diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md index 391a6c004b70..78aff4306bc2 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md +++ b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md @@ -22,9 +22,7 @@ When you save a change to a custom pattern, this closes all the {% data variable {% data reusables.secret-scanning.view-custom-pattern %} 1. Under "{% data variables.product.prodname_secret_scanning_caps %}", to the right of the custom pattern you want to edit, click {% octicon "pencil" aria-label="Edit pattern" %}. -{%- ifversion custom-pattern-dry-run-ga %} 1. When you're ready to test your edited custom pattern, to identify matches without creating alerts, click **Save and dry run**. -{%- endif %} 1. When you have reviewed and tested your changes, click **Publish changes**.{% ifversion secret-scanning-push-protection-custom-patterns %} {% data reusables.advanced-security.secret-scanning-enable-push-protection-custom-pattern %} 1. Optionally, to disable push protection for your custom pattern, click **Disable**. @@ -52,7 +50,7 @@ You can enable {% data variables.product.prodname_secret_scanning %} as a push p {% data reusables.secret-scanning.push-protection-enterprise-note %} -Before enabling push protection for a custom pattern at enterprise level, you must also{% ifversion custom-pattern-dry-run-ga %} test your custom patterns using dry runs. {% data reusables.secret-scanning.dry-runs-enterprise-permissions %}{% else %} test your custom patterns in a repository before defining them for your entire enterprise, as there is no dry-run functionality. That way, you can avoid creating excess false-positive {% data variables.secret-scanning.alerts %}.{% endif %} +Before enabling push protection for a custom pattern at enterprise level, you must also test your custom patterns using dry runs. {% data reusables.secret-scanning.dry-runs-enterprise-permissions %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} @@ -60,9 +58,7 @@ Before enabling push protection for a custom pattern at enterprise level, you mu 1. Under "{% ifversion code-security-wording-only-enterprise %}Code security{% else %}Code security and analysis{% endif %}", click **Security features**. {% data reusables.advanced-security.secret-scanning-edit-custom-pattern %} - {% ifversion custom-pattern-dry-run-ga %} >[!NOTE] At the enterprise level, you can only edit and enable push protection for custom patterns that you created. - {%- endif %} 1. To enable push protection for your custom pattern, scroll down to "Push Protection", and click **Enable**. diff --git a/content/discussions/managing-discussions-for-your-community/managing-discussions.md b/content/discussions/managing-discussions-for-your-community/managing-discussions.md index f33dbf25146d..1380ce57b511 100644 --- a/content/discussions/managing-discussions-for-your-community/managing-discussions.md +++ b/content/discussions/managing-discussions-for-your-community/managing-discussions.md @@ -180,8 +180,6 @@ To transfer a discussion, you must have permissions to create discussions in the {% endif %} -{% ifversion converting-issues-to-discussions %} - ## Converting issues based on labels You can convert all issues with the same label to discussions in bulk. Future issues with this label will also automatically convert to the discussion and category you configure. @@ -192,4 +190,3 @@ You can convert all issues with the same label to discussions in bulk. Future is 1. Next to the label you want to convert to issues, click **Convert issues**. 1. Select the **Choose a category** drop-down menu, and click a category for your discussion. 1. Click **I understand, convert this issue to a discussion**. -{% endif %} diff --git a/content/discussions/managing-discussions-for-your-community/moderating-discussions.md b/content/discussions/managing-discussions-for-your-community/moderating-discussions.md index 7d9d9aa96c84..82a788f9912c 100644 --- a/content/discussions/managing-discussions-for-your-community/moderating-discussions.md +++ b/content/discussions/managing-discussions-for-your-community/moderating-discussions.md @@ -38,8 +38,6 @@ It's appropriate to lock a conversation when the entire conversation is not cons 1. To lock the conversation, click **Lock conversation**. 1. When you're ready to unlock the conversation, click **Unlock conversation** in the right margin of a discussion, then click **Unlock conversation**. -{% ifversion converting-issues-to-discussions %} - ## Converting an issue to a discussion When you convert an issue to a discussion, the discussion is automatically created using the content from the issue. People with write access to a repository, or source repository for organization discussions, can bulk convert issues based on labels. For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-discussions). @@ -50,7 +48,6 @@ When you convert an issue to a discussion, the discussion is automatically creat 1. In the right margin of an issue, click **Convert to discussion**. 1. Select the **Choose a category** drop-down menu, and click a category for your discussion. 1. Click **I understand, convert this issue to a discussion**. -{% endif %} {% ifversion discussions-hide-comments-on-block %} diff --git a/content/issues/tracking-your-work-with-issues/about-issues.md b/content/issues/tracking-your-work-with-issues/about-issues.md index 50c8f5831eaa..63ffa31b230a 100644 --- a/content/issues/tracking-your-work-with-issues/about-issues.md +++ b/content/issues/tracking-your-work-with-issues/about-issues.md @@ -60,5 +60,6 @@ You can @mention collaborators who have access to your repository in an issue to Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} For guidance on when to use an issue or a discussion, see [AUTOTITLE](/get-started/using-github/communicating-on-github). -{% ifversion converting-issues-to-discussions %}When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion.{% endif %} +When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion. + {% endif %} diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index ab157f28c0b4..0730427ddeea 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -123,7 +123,7 @@ To search for specific events, use the `action` qualifier in your query. Actions | {% ifversion fpt or ghec %} | | `repository_vulnerability_alerts` | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}. | {% endif %} | -| {% ifversion custom-repository-roles %} | +| {% ifversion ghec or ghes %} | | `role` | Contains all activities related to [custom repository roles](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization). | {% endif %} | | {% ifversion ghes or ghec %} | diff --git a/content/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization.md b/content/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization.md index 3d7111b3f3fe..35b9b8554522 100644 --- a/content/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization.md +++ b/content/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization.md @@ -3,7 +3,8 @@ title: Creating an announcement banner for your organization shortTitle: Create an announcement banner intro: Organization owners can create announcement banners for the organization. versions: - feature: custom-banner-messages + ghes: '*' + ghec: '*' type: how_to topics: - Maintenance diff --git a/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md b/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md index a77bbd9dd15c..f4c145018038 100644 --- a/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md @@ -2,7 +2,9 @@ title: Managing the commit signoff policy for your organization intro: 'You can require users to automatically sign off all commits they make in {% data variables.product.product_name %}''s web interface to repositories owned by your organization.' versions: - feature: commit-signoffs + fpt: '*' + ghec: '*' + ghes: '*' permissions: Organization owners can require all commits to repositories owned by the organization be signed off by the commit author. topics: - Organizations diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles.md index 40870b9348ce..0b62b9a0eaed 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles.md @@ -2,7 +2,8 @@ title: About custom repository roles intro: You can more granularly control access to your organization's repositories with custom repository roles. versions: - feature: custom-repository-roles + ghes: '*' + ghec: '*' topics: - Organizations - Teams @@ -23,12 +24,8 @@ You can have more granular control over the permissions you grant at the reposit After you create a custom role, anyone with admin access to a repository can assign the role to an individual or team. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-an-individuals-access-to-an-organization-repository) and [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository). -{% ifversion custom-repo-role-api %} - You can also use the REST API to create and manage custom repository roles. For more information, see [AUTOTITLE](/rest/orgs/custom-roles). -{% endif %} - {% ifversion custom-org-roles %} Custom repository roles manage access to specific repositories in your organization. To {% ifversion org-custom-role-with-repo-permissions %}grant access to all repositories, and to {% endif %}control access to your organization's administration settings, you can use custom organization roles. See [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles). diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization.md index 7a3879de291e..5f22c3161dc5 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization.md @@ -3,7 +3,8 @@ title: Managing custom repository roles for an organization intro: 'Learn how to create, edit, or delete custom repository roles for your organization.' permissions: Organization owners. versions: - feature: custom-repository-roles + ghes: '*' + ghec: '*' topics: - Organizations - Teams diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization.md index b4d697d4f463..f94b067e809e 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization.md @@ -24,7 +24,7 @@ You can set base permissions that apply to all members of an organization when a If someone with admin access to an organization's repository grants a member a higher level of access for the repository, the higher level of access overrides the base permission. -{% ifversion custom-repository-roles %} +{% ifversion ghec or ghes %} If you've created a custom repository role with an inherited role that is lower access than your organization's base permissions, any members assigned to that role will default to the organization's base permissions rather than the inherited role. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization). {% endif %} diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md index dc9e2053965e..9a0af64cb18f 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md @@ -16,8 +16,7 @@ versions: {% data reusables.commits.about-commits %} -{% ifversion commit-signoffs %} -If the repository you are committing to has compulsory commit signoffs enabled, and you are committing via the web interface, you will automatically sign off on the commit as part of the commit process. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository). {% endif %} +If the repository you are committing to has compulsory commit signoffs enabled, and you are committing via the web interface, you will automatically sign off on the commit as part of the commit process. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository). You can add a co-author on any commits you collaborate on. For more information, see [AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors). @@ -43,8 +42,6 @@ Once the commit is on the default branch, any tags that contain the commit will ![Screenshot of a commit summary. The tag icon and "v2.3.4" are highlighted with an orange outline.](/assets/images/help/commits/commit-tag-label.png) -{% ifversion commit-tree-view %} - ## Using the file tree You can use the file tree to navigate between files in a commit. @@ -60,8 +57,6 @@ You can use the file tree to navigate between files in a commit. ![Screenshot of the "Files changed" tab of a pull request. In the left sidebar, the file tree is outlined in dark orange.](/assets/images/help/repository/file-tree.png) 1. To filter by file path, enter part or all of the file path in the **Filter changed files** search box. -{% endif %} - ## Further reading * [AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits) on {% data variables.product.prodname_desktop %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md index b519586577fe..789f89459bcf 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md @@ -10,8 +10,7 @@ versions: When you add a tag protection rule, all tags that match the pattern provided will be protected. Only users with admin or maintain permissions, or custom roles with the "edit repository rules" permission in the repository will be able to create protected tags, and only users with admin permissions or custom roles with the "edit repository rules" permission in the repository will be able to delete protected tags. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role). {% data variables.product.prodname_github_apps %} require the `Repository administration: write` permission to modify a protected tag. -{% ifversion custom-repository-roles %} -Additionally, you can create custom repository roles to allow other groups of users to create or delete tags that match tag protection rules. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %} +Additionally, you can create custom repository roles to allow other groups of users to create or delete tags that match tag protection rules. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization). {% ifversion tag-protection-rules-import %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md index e4ca417bbd8e..79b580e4bcc9 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md @@ -2,7 +2,9 @@ title: Managing the commit signoff policy for your repository intro: 'You can require users to automatically sign off on the commits they make to your repository using {% data variables.product.product_name %}''s web interface.' versions: - feature: commit-signoffs + fpt: '*' + ghec: '*' + ghes: '*' permissions: Organization owners and repository administrators can require all commits to a repository to be signed off by the commit author. topics: - Repositories diff --git a/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md b/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md index edbd962a07ce..81a3c0c0e6d5 100644 --- a/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md +++ b/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md @@ -1,7 +1,2 @@ -{%- ifversion custom-pattern-dry-run-ga %} 1. Search for and select up to 10 repositories where you want to perform the dry run. 1. When you're ready to test your new custom pattern, click **Run**. -{%- else %} -1. Search for and select up to 10 repositories where you want to perform the dry run. -1. When you're ready to test your new custom pattern, click **Dry run**. -{%- endif %} diff --git a/data/reusables/advanced-security/secret-scanning-dry-run-select-repos.md b/data/reusables/advanced-security/secret-scanning-dry-run-select-repos.md index 0d58fa715f40..ce163b4a76ea 100644 --- a/data/reusables/advanced-security/secret-scanning-dry-run-select-repos.md +++ b/data/reusables/advanced-security/secret-scanning-dry-run-select-repos.md @@ -1,9 +1,4 @@ -{%- ifversion custom-pattern-dry-run-ga %} 1. Select the repositories where you want to perform the dry run. * To perform the dry run across the entire organization, select **All repositories in the organization**. * To specify the repositories where you want to perform the dry run, select **Selected repositories**, then search for and select up to 10 repositories. 1. When you're ready to test your new custom pattern, click **Run**. -{%- else %} -1. Search for and select up to 10 repositories where you want to perform the dry run. -1. When you're ready to test your new custom pattern, click **Dry run**. -{%- endif %} diff --git a/data/reusables/audit_log/audit-log-action-categories.md b/data/reusables/audit_log/audit-log-action-categories.md index 8e94dc75becc..11e1f55a5121 100644 --- a/data/reusables/audit_log/audit-log-action-categories.md +++ b/data/reusables/audit_log/audit-log-action-categories.md @@ -153,7 +153,7 @@ | {% ifversion ghec or ghes %} | | `restrict_notification_delivery` | Contains activities related to the restriction of email notifications to approved or verified domains for an enterprise. | | {% endif %} | -| {% ifversion custom-repository-roles %} | +| {% ifversion ghec or ghes %} | | `role` | Contains activities related to [custom repository roles](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization). | | {% endif %} | | {% ifversion ghec or ghes %} | diff --git a/data/reusables/enterprise_management_console/custom-maintenance-message.md b/data/reusables/enterprise_management_console/custom-maintenance-message.md index ea308a53d0ec..30d181b12577 100644 --- a/data/reusables/enterprise_management_console/custom-maintenance-message.md +++ b/data/reusables/enterprise_management_console/custom-maintenance-message.md @@ -1,3 +1 @@ -{%- ifversion custom-maintenance-mode-message %} 1. Optionally, to set a custom message for users to see during the maintenance window, in the "Set a maintenance mode message" field, type a message. -{%- endif %} From c74de3f2ef62e4cd31222a1cdeb0765db9df8af0 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Thu, 16 Jan 2025 08:53:26 +0000 Subject: [PATCH 2/5] Hack week 2025: Fix warnings in data/reusables/desktop (#53938) --- data/reusables/desktop/choose-a-branch-to-merge.md | 2 +- data/reusables/desktop/choose-clone-repository.md | 2 +- data/reusables/desktop/click-stash-all-changes.md | 2 +- data/reusables/desktop/cloning-location-tab.md | 2 +- data/reusables/desktop/delete-tag.md | 4 ++-- data/reusables/desktop/open-repository-settings.md | 3 +-- data/reusables/desktop/revert-commit.md | 2 +- data/reusables/desktop/select-fork-behavior.md | 2 +- data/reusables/desktop/use-local-git-config.md | 2 +- data/reusables/desktop/windows-choose-options.md | 2 +- data/reusables/desktop/windows-repository-settings-menu.md | 2 +- 11 files changed, 12 insertions(+), 13 deletions(-) diff --git a/data/reusables/desktop/choose-a-branch-to-merge.md b/data/reusables/desktop/choose-a-branch-to-merge.md index 65a1bc4acbda..07fbdf6fb2af 100644 --- a/data/reusables/desktop/choose-a-branch-to-merge.md +++ b/data/reusables/desktop/choose-a-branch-to-merge.md @@ -1,3 +1,3 @@ 1. Click **Choose a branch to merge into BRANCH**. - ![Screenshot of the "Current Branch" dropdown view. Below a list of branches, a button, labeled "Choose a branch to merge into my-feature", is outlined in orange.](/assets/images/help/desktop/merge-branch-button-list.png) + ![Screenshot of the "Current Branch" dropdown view. Below a list of branches, a "Choose a branch to merge into my-feature" button is outlined in orange.](/assets/images/help/desktop/merge-branch-button-list.png) diff --git a/data/reusables/desktop/choose-clone-repository.md b/data/reusables/desktop/choose-clone-repository.md index f921d6e239b6..bf65032fe775 100644 --- a/data/reusables/desktop/choose-clone-repository.md +++ b/data/reusables/desktop/choose-clone-repository.md @@ -8,6 +8,6 @@ {% windows %} - ![Screenshot of the "GitHub Desktop" menu bar on Windows. The "File" dropdown menu is expanded, and the "Clone Repository" option is highlighted with an orange outline.](/assets/images/help/desktop/clone-file-menu-windows.png) + ![Screenshot of the "GitHub Desktop" menu bar on Windows. The "File" dropdown menu is expanded, and the "Clone Repository" option is outlined in orange.](/assets/images/help/desktop/clone-file-menu-windows.png) {% endwindows %} diff --git a/data/reusables/desktop/click-stash-all-changes.md b/data/reusables/desktop/click-stash-all-changes.md index f8c141d63d4c..54b70529adef 100644 --- a/data/reusables/desktop/click-stash-all-changes.md +++ b/data/reusables/desktop/click-stash-all-changes.md @@ -1,3 +1,3 @@ 1. Click **Stash All Changes**. - ![Screenshot of the "Changes" tab. The header bar, labeled "1 changed file", is outlined in orange. In a context menu, the cursor hovers over "Stash All Changes".](/assets/images/help/desktop/mac-stash-all-changes.png) + ![Screenshot of the "Changes" tab. The header shows "1 changed file" and is outlined in orange. "Stash All Changes" is highlighted in a context menu.](/assets/images/help/desktop/mac-stash-all-changes.png) diff --git a/data/reusables/desktop/cloning-location-tab.md b/data/reusables/desktop/cloning-location-tab.md index 88d87e6ae2e1..ed9cf4ef408b 100644 --- a/data/reusables/desktop/cloning-location-tab.md +++ b/data/reusables/desktop/cloning-location-tab.md @@ -1,3 +1,3 @@ 1. Click the tab that corresponds to the location of the repository you want to clone. You can also click **URL** to manually enter the repository location. - ![Screenshot of the "Clone a repository" window. At the top of the window, tabs labeled "GitHub.com", "GitHub Enterprise" and "URL" are highlighted with an orange outline.](/assets/images/help/desktop/choose-repository-location-mac.png) + ![Screenshot of the "Clone a repository" window. At the top of the window, "GitHub.com", "GitHub Enterprise" and "URL" tabs are outlined in orange.](/assets/images/help/desktop/choose-repository-location-mac.png) diff --git a/data/reusables/desktop/delete-tag.md b/data/reusables/desktop/delete-tag.md index 80812dcacb2f..34734b82e85d 100644 --- a/data/reusables/desktop/delete-tag.md +++ b/data/reusables/desktop/delete-tag.md @@ -1,6 +1,6 @@ 1. Right-click the commit. * If a commit has only one tag, click **Delete Tag TAG NAME**. - ![Screenshot of a list of commits in the "History" tab. Next to a commit, in a context menu, the cursor hovers over an option labeled "Delete tag hello-tag".](/assets/images/help/desktop/select-delete-tag.png) + ![Screenshot of a list of commits in the "History" tab. The cursor hovers over an option labeled "Delete tag hello-tag" in a context window.](/assets/images/help/desktop/select-delete-tag.png) * If a commit has multiple tags, hover over **Delete Tag...** and then click the tag that you want to delete. - ![Screenshot of a context menu in the "History" tab. Next to "Delete tag", a second menu is expanded, and the cursor hovers over an option labeled "hello-tag".](/assets/images/help/desktop/delete-tag-multiple.png) + ![Screenshot of a context menu in the "History" tab. Next to "Delete tag", a second menu is expanded. The cursor hovers over "hello-tag".](/assets/images/help/desktop/delete-tag-multiple.png) diff --git a/data/reusables/desktop/open-repository-settings.md b/data/reusables/desktop/open-repository-settings.md index 351e5d6ce87b..3f0b92def992 100644 --- a/data/reusables/desktop/open-repository-settings.md +++ b/data/reusables/desktop/open-repository-settings.md @@ -8,7 +8,6 @@ {% windows %} - ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the open "Repository" dropdown menu, an option labeled "Repository Settings" is outlined in orange.](/assets/images/help/desktop/repository-settings-win.png) + ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the open "Repository" dropdown menu, the "Repository Settings" option is outlined.](/assets/images/help/desktop/repository-settings-win.png) {% endwindows %} - \ No newline at end of file diff --git a/data/reusables/desktop/revert-commit.md b/data/reusables/desktop/revert-commit.md index d803a464b03b..813ea5a68b7e 100644 --- a/data/reusables/desktop/revert-commit.md +++ b/data/reusables/desktop/revert-commit.md @@ -1,3 +1,3 @@ 1. Right-click the commit you want to revert and click **Revert Changes in Commit**. - ![Screenshot of a list of commits in the "History" tab. Next to a commit, in a context menu, the cursor hovers over the "Revert Changes in Commit" option.](/assets/images/help/desktop/commit-revert-mac.png) + ![Screenshot of a list of commits in the "History" tab. The cursor hovers over the "Revert Changes in Commit" option in a context menu.](/assets/images/help/desktop/commit-revert-mac.png) diff --git a/data/reusables/desktop/select-fork-behavior.md b/data/reusables/desktop/select-fork-behavior.md index a4a857d9bf3a..d8e495590b6a 100644 --- a/data/reusables/desktop/select-fork-behavior.md +++ b/data/reusables/desktop/select-fork-behavior.md @@ -1,6 +1,6 @@ 1. In the "Repository settings" window, in the left-hand sidebar, click **Fork Behavior**. 1. Under "I'll be using this fork...", use the radio buttons to select how you want to use the fork. - ![Screenshot of the "Fork Behavior" pane. Two radio buttons, labeled "To contribute to the parent repository" and "For my own purposes", are outlined in orange.](/assets/images/help/desktop/mac-fork-behavior-menu-contribute.png) + ![Screenshot of the "Fork Behavior" pane. Two radio buttons, "To contribute to the parent repository" and "For my own purposes", are outlined in orange.](/assets/images/help/desktop/mac-fork-behavior-menu-contribute.png) 1. Click **Save**. diff --git a/data/reusables/desktop/use-local-git-config.md b/data/reusables/desktop/use-local-git-config.md index d225bd72079d..d9a9368af0c7 100644 --- a/data/reusables/desktop/use-local-git-config.md +++ b/data/reusables/desktop/use-local-git-config.md @@ -1,2 +1,2 @@ 1. Under "For this repository I wish to", select **Use a local Git config**. -![Screenshot of the "Git Config" pane in the "Repository Settings" window. A selected radio button, labeled "Use a local Git config", is outlined in orange.](/assets/images/help/desktop/use-local-git-config.png) +![Screenshot of the "Git Config" pane in the "Repository Settings" window. The "Use a local Git config" radio button is selected and outlined in orange.](/assets/images/help/desktop/use-local-git-config.png) diff --git a/data/reusables/desktop/windows-choose-options.md b/data/reusables/desktop/windows-choose-options.md index f9f693bd1134..0e11ac6528a3 100644 --- a/data/reusables/desktop/windows-choose-options.md +++ b/data/reusables/desktop/windows-choose-options.md @@ -1,3 +1,3 @@ 1. Use the **File** menu, then click **Options**. - ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the expanded "File" dropdown menu, the "Options" item is highlighted with an orange outline.](/assets/images/help/desktop/windows-choose-options.png) + ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the expanded "File" dropdown menu, the "Options" item is outlined in orange.](/assets/images/help/desktop/windows-choose-options.png) diff --git a/data/reusables/desktop/windows-repository-settings-menu.md b/data/reusables/desktop/windows-repository-settings-menu.md index be91a5de4ac8..cbb10e1aa69e 100644 --- a/data/reusables/desktop/windows-repository-settings-menu.md +++ b/data/reusables/desktop/windows-repository-settings-menu.md @@ -1,3 +1,3 @@ 1. In the **Repository** menu, click **Repository settings...**. - ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the open "Repository" dropdown menu, an option labeled "Repository Settings" is outlined in orange.](/assets/images/help/desktop/repository-settings-win.png) + ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the open "Repository" dropdown menu, "Repository Settings" is outlined in orange.](/assets/images/help/desktop/repository-settings-win.png) From 62791c83b0e19fae0fcfe2b68bdfa016439d6e21 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Thu, 16 Jan 2025 08:53:54 +0000 Subject: [PATCH 3/5] Hack week 2025: Fix linter warnings in communities and contributing folder (#53934) --- .../blocking-a-user-from-your-organization.md | 4 ++-- .../unblocking-a-user-from-your-organization.md | 2 +- .../managing-disruptive-comments.md | 14 +++++++------- .../tracking-changes-in-a-comment.md | 2 +- ...t-community-profiles-for-public-repositories.md | 4 ++-- .../adding-a-code-of-conduct-to-your-project.md | 2 +- .../adding-a-license-to-a-repository.md | 6 +++--- .../creating-a-default-community-health-file.md | 2 -- .../about-issue-and-pull-request-templates.md | 10 ++++------ ...figuring-issue-templates-for-your-repository.md | 6 +----- .../syntax-for-issue-forms.md | 2 +- .../creating-diagrams-for-github-docs.md | 6 +++--- .../creating-screenshots.md | 2 +- 13 files changed, 27 insertions(+), 35 deletions(-) diff --git a/content/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization.md b/content/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization.md index 27f7f08cab33..283e600b57da 100644 --- a/content/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization.md +++ b/content/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization.md @@ -42,7 +42,7 @@ In your organization's repositories, blocked users also cannot: 1. Navigate to the comment whose author you would like to block. 1. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="Show options" %}, then click **Block user**. - ![Screenshot of a pull request comment by octo-user. Below an icon of three horizontal dots, a dropdown menu is expanded, and "Block user" is outlined in orange.](/assets/images/help/repository/comment-menu-block-user.png) + ![Screenshot of a pull request comment by octo-user. Below an icon of three dots, a dropdown menu is expanded, and "Block user" is outlined in orange.](/assets/images/help/repository/comment-menu-block-user.png) 1. If you'd like to set a time limit for the block, select the **Block user** dropdown menu, and click the amount of time you'd like to block the user. 1. If you'd like to hide all of the comments the user has made in the organization, select **Hide this user's comments** and choose a reason. @@ -66,7 +66,7 @@ In your organization's repositories, blocked users also cannot: 1. Navigate to the discussion whose author you would like to block. 1. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="Show options" %}, then click **Block user**. - ![Screenshot of a pull request comment by octo-user. Below an icon of three horizontal dots, a dropdown menu is expanded, and "Block user" is outlined in orange.](/assets/images/help/repository/comment-menu-block-user.png) + ![Screenshot of a pull request comment by octo-user. Below an icon of three dots, a dropdown menu is expanded, and "Block user" is outlined in orange.](/assets/images/help/repository/comment-menu-block-user.png) 1. If you'd like to set a time limit for the block, select the **Block user** dropdown menu, and click the amount of time you'd like to block the user. 1. If you'd like to hide all of the comments the user has made in the organization, select **Hide this user's comments** and choose a reason. diff --git a/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md b/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md index d9cc2dc438d8..1ce44bb5b72f 100644 --- a/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md +++ b/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md @@ -24,7 +24,7 @@ If you selected a specific amount of time to block the user, they will be automa 1. Navigate to the comment whose author you would like to unblock. 1. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="Show options" %}, then click **Unblock user**. - ![Screenshot of a pull request comment by octo-user. Below an icon of three horizontal dots, a dropdown menu is expanded, and "Unblock user" is outlined in orange.](/assets/images/help/repository/comment-menu-unblock-user.png) + ![Screenshot of a pull request comment by octo-user. Below an icon of three dots, a dropdown menu is expanded, and "Unblock user" is outlined in orange.](/assets/images/help/repository/comment-menu-unblock-user.png) 1. To confirm you would like to unblock the user, click **OK**. diff --git a/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md b/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md index a13df43660d7..3bf4201815ec 100644 --- a/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md +++ b/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md @@ -26,13 +26,13 @@ If a comment is off-topic, outdated, or resolved, you may want to hide a comment 1. Navigate to the comment you'd like to hide. 1. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Hide**. - ![Screenshot of a pull request comment by octo-user. Below an icon of three horizontal dots, a dropdown menu is expanded, and "Hide" is outlined in orange.](/assets/images/help/repository/comment-menu-hide.png) + ![Screenshot of a pull request comment by octo-user. Below an icon of three dots, a dropdown menu is expanded, and "Hide" is outlined in orange.](/assets/images/help/repository/comment-menu-hide.png) 1. Using the "Choose a reason" dropdown menu, choose a reason to hide the comment. Then select **Hide comment**. {% ifversion fpt or ghec %} - ![Screenshot of a {% data variables.product.prodname_dotcom %} comment showing a menu to select a reason to hide the comment: Spam, Abuse, Off Topic, Outdated, Duplicate, or Resolved.](/assets/images/help/repository/choose-reason-for-hiding-comment.png) + ![Screenshot of a comment showing a menu to select a reason to hide the comment: Spam, Abuse, Off Topic, Outdated, Duplicate, or Resolved.](/assets/images/help/repository/choose-reason-for-hiding-comment.png) {% else %} - ![Screenshot of a {% data variables.product.prodname_dotcom %} comment showing a menu to select a reason to hide the comment: Off Topic, Outdated, Duplicate, or Resolved.](/assets/images/help/repository/choose-reason-for-hiding-comment-ghe.png) + ![Screenshot of a comment showing a menu to select a reason to hide the comment: Off Topic, Outdated, Duplicate, or Resolved.](/assets/images/help/repository/choose-reason-for-hiding-comment-ghe.png) {% endif %} ## Unhiding a comment @@ -43,7 +43,7 @@ If a comment is off-topic, outdated, or resolved, you may want to hide a comment 1. On the right side of the comment, click **{% octicon "fold" aria-hidden="true" %} Show comment**. 1. On the right side of the expanded comment, select the {% octicon "kebab-horizontal" aria-label="Show options" %} dropdown menu, then click **Unhide**. - ![Screenshot of a pull request comment marked as spam. Below an icon of three horizontal dots, a dropdown menu is expanded, and "Unhide" is outlined in orange.](/assets/images/help/repository/comment-menu-hidden.png) + ![Screenshot of a pull request comment marked as spam. Below an icon of three dots, a dropdown menu is expanded, and "Unhide" is outlined in orange.](/assets/images/help/repository/comment-menu-hidden.png) ## Editing a comment @@ -55,7 +55,7 @@ Sometimes it may make sense to clearly indicate edits and their justification. That said, anyone with read access to a repository can view a comment's edit history. The **edited** dropdown at the top of the comment contains a history of edits showing the user and timestamp for each edit. -![Screenshot of a comment by octo-user, which has been partially redacted. In the comment header, next to the text "edited by octocat", a dropdown icon is outlined in orange.](/assets/images/help/repository/content-redacted-comment.png) +![Screenshot of a comment by octo-user, which is partially redacted. In the header, next to "edited by octocat", a dropdown icon is outlined in orange.](/assets/images/help/repository/content-redacted-comment.png) ## Redacting sensitive information @@ -64,7 +64,7 @@ Comment authors and anyone with write access to a repository can also delete sen 1. Navigate to the comment you'd like to edit. 1. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="Show options" %}, then click **Edit**. - ![Screenshot of a pull request comment by octo-user. Below an icon of three horizontal dots, a dropdown menu is expanded, and "Edit" is outlined in orange.](/assets/images/help/repository/comment-menu-edit.png) + ![Screenshot of a pull request comment by octo-user. Below an icon of three dots, a dropdown menu is expanded, and "Edit" is outlined in orange.](/assets/images/help/repository/comment-menu-edit.png) 1. In the comment window, delete the content you'd like to remove, then type `[REDACTED]` to replace it. 1. At the bottom of the comment, type a note indicating that you have edited the comment, and optionally, why you edited the comment. @@ -89,7 +89,7 @@ Deleting a comment creates a timeline event that is visible to anyone with read 1. Navigate to the comment you'd like to delete. 1. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Delete**. - ![Screenshot of a pull request comment by octo-user. Below an icon of three horizontal dots, a dropdown menu is expanded, and "Delete" is outlined in orange.](/assets/images/help/repository/comment-menu-delete.png) + ![Screenshot of a pull request comment by octo-user. Below an icon of three dots, a dropdown menu is expanded, and "Delete" is outlined in orange.](/assets/images/help/repository/comment-menu-delete.png) 1. Optionally, write a comment noting that you deleted a comment and why. {% ifversion fpt or ghec %} diff --git a/content/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment.md b/content/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment.md index 036befe8ed28..97c67878d23d 100644 --- a/content/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment.md +++ b/content/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment.md @@ -30,7 +30,7 @@ When you delete sensitive information from the comment's edit history, the perso {% data reusables.repositories.edited-comment-list %} 1. In the top right of the edit history window, click **Options**. Then click **Delete revision from history** to delete the diff that shows the content being added. - ![Screenshot of the edit history window for a comment. A dropdown menu, labeled "Options," is expanded, and the "Delete revision from history" option is outlined in orange.](/assets/images/help/repository/delete-comment-edit-details.png) + ![Screenshot of the edit history of a comment. The "Options" dropdown menu is expanded. The "Delete revision from history" option is outlined in orange.](/assets/images/help/repository/delete-comment-edit-details.png) 1. To confirm deletion, click **OK**. ## Further reading diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md b/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md index 1edf534400d7..af0dece0dce3 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md @@ -21,7 +21,7 @@ As a repository maintainer, you can use the community standards checklist to see If a project doesn't have one of the recommended files, you can click the associated **Add** button to draft and submit a file. -![Screenshot of the "Community Standards" maintainer checklist. Each item has an "Added" label (green checkmark) or a "Not added yet" label (orange circle).](/assets/images/help/repository/add-button-community-profile.png) +![Screenshot of the "Community Standards" maintainer checklist. Each item has an "Added" label (green check) or a "Not added yet" label (orange circle).](/assets/images/help/repository/add-button-community-profile.png) {% data reusables.repositories.security-guidelines %} @@ -33,7 +33,7 @@ As a potential contributor, use the community profile checklist to see if a proj If a project doesn't have a recommended file, you can click **Propose** to draft and submit a file to the repository maintainer for approval. -![Screenshot of the "Community Standards" contributor checklist. Each item has an "Added" label (green checkmark) or a "Not added yet" label (orange circle).](/assets/images/help/repository/propose-button-community-profile.png) +![Screenshot of the "Community Standards" contributor checklist. Each item has an "Added" icon (green check) or a "Not added yet" icon (orange circle).](/assets/images/help/repository/propose-button-community-profile.png) ## Further reading diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md index 086818bed10e..26c36654df32 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md @@ -31,7 +31,7 @@ You can create a default code of conduct for your organization or personal accou {% data reusables.files.add-file %} 1. In the file name field, type _CODE_OF_CONDUCT.md_. 1. Select **Choose a code of conduct template**. - ![Screenshot of a {% data variables.product.prodname_dotcom %} repository showing a new markdown file being created. A button at right, labeled "Choose a code of conduct template," is outlined in dark orange.](/assets/images/help/repository/code-of-conduct-tool.png) + ![Screenshot of a repository showing a new markdown file. A button at right, labeled "Choose a code of conduct template," is outlined in orange.](/assets/images/help/repository/code-of-conduct-tool.png) 1. On the left side of the page, select a code of conduct to preview and add to your project. 1. On the right side of the page, complete the fields to populate the selected code of conduct with the appropriate information. 1. Click **Review and submit**. diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md index c27c7d78f0b9..61cbb2ab843d 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md @@ -12,9 +12,9 @@ topics: - Community shortTitle: Add a license to a repo --- -If you include a detectable license in your repository, people who visit your repository will see it at the top of the repository page. To read the entire license file, click the license name. +If you include a detectable license in your repository, people who visit your repository will see it at the top of the repository page. To read the entire license file, click the license name (for example: [github-linguist/linguist](https://github.com/github-linguist/linguist)). -![Screenshot of the main page of the github-linguist/linguist repository. In the right sidebar, "MIT license," preceded by a law icon, is outlined in dark orange.](/assets/images/help/repository/repo-license-indicator.png) +![Screenshot of the main page of a repository. In the right sidebar, "MIT license," preceded by a law icon, is outlined in orange.](/assets/images/help/repository/repo-license-indicator.png) Open source licenses enable others to freely use, change, and distribute the project in your repository. For more information on repository licenses, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository). @@ -27,7 +27,7 @@ Open source licenses enable others to freely use, change, and distribute the pro 1. In the file name field, type _LICENSE_ or _LICENSE.md_ (with all caps). 1. Under the file name, click **Choose a license template**. - ![Screenshot of the new file form, with "LICENSE" entered in the file name field. A button, labeled "Choose a license template," is outlined in dark orange.](/assets/images/help/repository/license-tool.png) + ![Screenshot of the new file form, with "LICENSE" entered in the file name field. A "Choose a license template" button is outlined in dark orange.](/assets/images/help/repository/license-tool.png) 1. On the left side of the page, under "Add a license to your project," review the available licenses, then select a license from the list. 1. Click **Review and submit**. {% data reusables.files.write_commit_message %} diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index d62aed29cdbc..8ccdfb7ff79d 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -46,9 +46,7 @@ You can create defaults in your organization or personal account for the followi | _CODE_OF_CONDUCT.md_ | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project). | | {% endif %} | | _CONTRIBUTING.md_ | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors). | -| {% ifversion discussion-category-forms %} | | Discussion category forms | Discussion category forms customize the templates that are available for community members to use when they open new discussions in your repository. For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/creating-discussion-category-forms). | -| {% endif %} | | {% ifversion fpt or ghec %} | | _FUNDING.yml_ | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository). | | {% endif %} | diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md index 599bfadf2329..58e1ab0c2507 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md @@ -19,23 +19,21 @@ You can create default issue and pull request templates for your organization or ## Issue templates -When you create issue templates for your repository using the issue template builder{% ifversion issue-forms %} or with issue forms{% endif %}, contributors can select the appropriate template when they open new issues in the repository. +When you create issue templates for your repository using the issue template builder or with issue forms, contributors can select the appropriate template when they open new issues in the repository. ![Screenshot of the new issue page, with multiple templates to choose from.](/assets/images/help/issues/new-issue-page-with-multiple-templates.png) -Issue templates are helpful when you want to provide guidance for opening issues while allowing contributors to specify the content of their issues. {% ifversion issue-forms %} If you want contributors to provide specific, structured information when they open issues, issue forms help ensure that you receive your desired information.{% endif %} +Issue templates are helpful when you want to provide guidance for opening issues while allowing contributors to specify the content of their issues. If you want contributors to provide specific, structured information when they open issues, issue forms help ensure that you receive your desired information. Using the template builder, you can specify a title and description for each template, add the template content, and either commit the template to the default branch or open a pull request in the repository. The template builder automatically adds the YAML front matter markup that is required for the template to show on the new issue page. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository). -{% ifversion issue-forms %} With issue forms, you can create templates that have web form fields using the {% data variables.product.prodname_dotcom %} form schema. When a contributor opens an issue using an issue form, the form inputs are converted to a standard markdown issue comment. You can specify different input types and set inputs as required to help contributors open actionable issues in your repository. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms) and [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms). -{% endif %} {% data reusables.repositories.issue-template-config %} For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser). -Issue templates are stored on the repository's default branch, in a hidden `.github/ISSUE_TEMPLATE` directory. If you create a template in another branch, it will not be available for collaborators to use. Issue template filenames are not case sensitive, and need a _.md_ extension.{% ifversion issue-forms %} Issue templates created with issue forms need a _.yml_ extension.{% endif %} {% data reusables.repositories.valid-community-issues %} +Issue templates are stored on the repository's default branch, in a hidden `.github/ISSUE_TEMPLATE` directory. If you create a template in another branch, it will not be available for collaborators to use. Issue template filenames are not case sensitive, and need a _.md_ extension. Issue templates created with issue forms need a _.yml_ extension. {% data reusables.repositories.valid-community-issues %} -It is possible to manually create a single issue template in Markdown using the legacy issue template workflow, and project contributors will automatically see the template's contents in the issue body. However, we recommend using the upgraded multiple issue template builder{% ifversion issue-forms %} or issue forms{% endif %} to create issue templates. For more information about the legacy workflow, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository). +It is possible to manually create a single issue template in Markdown using the legacy issue template workflow, and project contributors will automatically see the template's contents in the issue body. However, we recommend using the upgraded multiple issue template builder or issue forms to create issue templates. For more information about the legacy workflow, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository). {% data reusables.repositories.security-guidelines %} diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md index ca416009179f..eb479765b73a 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md @@ -25,7 +25,7 @@ shortTitle: Configure ![Screenshot of the "Features" section of a repository's settings, with the "Issues" setting ticked and the green "Set up templates" button visible.](/assets/images/help/repository/set-up-issue-templates-button.png) 1. Use the **Add template** dropdown menu, and click on the type of template you'd like to create. - ![Screenshot of the "Add template" dropdown menu expanded to show the standard "Bug report" and "Feature request" templates. In addition, the "Custom template" is listed.](/assets/images/help/repository/add-template-drop-down-menu.png) + ![Screenshot of the "Add template" dropdown menu expanded to show standard templates, "Bug report" and "Feature request," with a "Custom template".](/assets/images/help/repository/add-template-drop-down-menu.png) 1. To preview or edit the template before committing it to the repository, next to the template, click **Preview and edit**. 1. To edit the template, click {% octicon "pencil" aria-label="Edit template" %}, and type in the fields to edit their contents. @@ -36,8 +36,6 @@ shortTitle: Configure 1. Below the commit message fields, select whether to commit your template directly to the default branch, or to create a new branch and open a pull request. For more information about pull requests, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). 1. Click **Commit changes**. Once these changes are merged into the default branch, the template will be available for contributors to use when they open new issues in the repository. -{% ifversion issue-forms %} - ## Creating issue forms {% data reusables.community.issue-forms-beta %} @@ -59,8 +57,6 @@ Here is the rendered version of the issue form. 1. In the body of the new file, type the contents of your issue form. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms). 1. Commit your file to the default branch of your repository. For more information, see [AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files). -{% endif %} - ## Configuring the template chooser {% data reusables.repositories.issue-template-config %} diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md index dc5bd4b170d2..45e1a9f4aa0e 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md @@ -45,7 +45,7 @@ You can set the following top-level keys for each issue form. | `labels` | Labels that will automatically be added to issues created with this template. If a label does not already exist in the repository, it will not be automatically added to the issue. | Optional | Array or comma-delimited string | | `title` | A default title that will be pre-populated in the issue submission form. | Optional | String | | {% ifversion projects-in-issue-forms %} | -| `projects` | Projects that any issues created with this template will automatically be added to. The format of this key is `PROJECT-OWNER/PROJECT-NUMBER`. > [!NOTE] The person opening the issue must have write permissions for the specified projects. {% ifversion projects-v2 %} If you don't expect people using this template to have write access, consider enabling your project's auto-add workflow. For more information, see [Adding items automatically](/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically).{% endif %} | Optional | Array or comma-delimited string | +| `projects` | Projects that any issues created with this template will automatically be added to. The format of this key is `PROJECT-OWNER/PROJECT-NUMBER`. > [!NOTE] The person opening the issue must have write permissions for the specified projects. If you don't expect people using this template to have write access, consider enabling your project's auto-add workflow. For more information, see [Adding items automatically](/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically). | Optional | Array or comma-delimited string | | {% endif %} | For the available `body` input types and their syntaxes, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema). diff --git a/content/contributing/writing-for-github-docs/creating-diagrams-for-github-docs.md b/content/contributing/writing-for-github-docs/creating-diagrams-for-github-docs.md index 7f34d53e0267..e0687b141a58 100644 --- a/content/contributing/writing-for-github-docs/creating-diagrams-for-github-docs.md +++ b/content/contributing/writing-for-github-docs/creating-diagrams-for-github-docs.md @@ -83,7 +83,7 @@ If you are creating a diagram to explain when or how something happens, consider * [Flowchart](https://en.wikipedia.org/wiki/Flowchart): Flowcharts are useful for showing the steps in a process. In this example, the rectangles represent steps in a process and the diamond represents a decision point where the chart branches into two possible endpoints. - ![An example flowchart that uses rectangles to represent steps in a process and a diamond to represent a decision point where the chart branches into two possible endpoints.](/assets/images/help/diagrams/flowchart-example.png) + ![An example flowchart that uses rectangles to represent steps in a process and a diamond to represent a decision point where the chart branches.](/assets/images/help/diagrams/flowchart-example.png) * [Gantt chart](https://en.wikipedia.org/wiki/Gantt_chart): Gantt charts are useful for showing how long tasks take and when they overlap. In this example, the horizontal axis is labelled "Time" and the blue rectangles represent three discrete tasks. Task 1 and task 2 overlap, which means that at least part of the tasks happen at the same time. Task 3 does not overlap with the other tasks, which means that it happens after the first two are completed. @@ -123,7 +123,7 @@ If you are creating a diagram to explain why something is the way that it is, co * [Venn diagram](https://en.wikipedia.org/wiki/Venn_diagram): Venn diagrams are useful for showing shared traits or overlap of ideas. Circles represent concepts or things, and the area where the circles overlap represent shared traits between things. In this example, the overlap between the circle labelled "Octopus" and the circle labelled "Cat" is labelled "Octocat," which is a combination of an octopus and a cat. - ![An example Venn diagram that shows two circles overlapping. One circle is labelled "Octopus" and the other is labelled "Cat". The overlapping section of the circles is labelled "Octocat".](/assets/images/help/diagrams/venn-diagram-example.png) + ![An example Venn diagram with two circles overlapping: one labeled "Octopus" and the other "Cat". The intersection of the circles is labeled "Octocat".](/assets/images/help/diagrams/venn-diagram-example.png) ## Style guidelines @@ -163,7 +163,7 @@ Use different types of lines to convey additional meaning of relationships. * Two-way lines that have an arrow on each side: Indicate reciprocation. ![Two blue rectangles connected by a line with an arrow on both ends.](/assets/images/help/diagrams/two-way-line-example.png) * Brackets: Establish hierarchy. In general, organize brackets vertically so that they are easier to navigate on a webpage. Indent each level of a hierarchy. - ![Two examples of blue rectangles connected by brackets. One has three rectangles arranged in a vertical bracket with two rectangles indented and connected to the top rectangle with lines. The other has two rectangles arranged horizontally connected to a rectangle above with lines.](/assets/images/help/diagrams/brackets-example.png) + ![Two examples demonstrating the difference between vertical (left) and horizontal (right) arrangement of three rectangles connected by brackets.](/assets/images/help/diagrams/brackets-example.png) ### Labels diff --git a/content/contributing/writing-for-github-docs/creating-screenshots.md b/content/contributing/writing-for-github-docs/creating-screenshots.md index 436b44325c23..e2e4ef21e9b2 100644 --- a/content/contributing/writing-for-github-docs/creating-screenshots.md +++ b/content/contributing/writing-for-github-docs/creating-screenshots.md @@ -138,7 +138,7 @@ The stroke is the color `fg.severe` in the [Primer Design System](https://primer 1. To download the Snagit theme, navigate to [`snagit-theme-github-docs.snagtheme`](https://github.com/github/docs/blob/main/contributing/images/snagit-theme-github-docs.snagtheme) in the `github/docs` repository, then click {% octicon "download" aria-label="Download raw content" %}. - ![Screenshot of the file view for "snagit-theme-github-docs.snagtheme." In the header of the file, a button labeled with a download icon is outlined in dark orange.](/assets/images/contributing/download-snagit-theme.png) + ![Screenshot of the file view for "snagit-theme-github-docs.snagtheme." In the header of the file, a button with a download icon is outlined in orange.](/assets/images/contributing/download-snagit-theme.png) 1. Open Snagit, then select the **Shape** tool. 1. Under "Quick styles," select **Import**. 1. Select the Snagit theme from your computer's files. This will install the shape preset. From 6f8c1dd447de8ead70e4a631b97a6a7ce254c853 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Thu, 16 Jan 2025 09:00:09 +0000 Subject: [PATCH 4/5] Hack week 2025: Fix linter warnings in `content/desktop` folder (#53937) Co-authored-by: Vanessa --- ...pository-from-your-local-computer-to-github-desktop.md | 8 ++++---- .../cloning-a-repository-from-github-to-github-desktop.md | 2 +- .../updating-github-desktop.md | 6 +++--- .../managing-branches-in-github-desktop.md | 2 +- .../viewing-the-branch-history-in-github-desktop.md | 2 +- .../checking-out-a-commit-in-github-desktop.md | 2 +- .../cherry-picking-a-commit-in-github-desktop.md | 2 +- .../managing-commits/managing-tags-in-github-desktop.md | 2 +- .../reordering-commits-in-github-desktop.md | 2 +- .../squashing-commits-in-github-desktop.md | 2 +- ...creating-your-first-repository-using-github-desktop.md | 4 ++-- .../launching-github-desktop-from-the-command-line.md | 2 +- ...eating-an-issue-or-pull-request-from-github-desktop.md | 2 +- .../syncing-your-branch-in-github-desktop.md | 6 +++--- .../viewing-a-pull-request-in-github-desktop.md | 2 +- .../viewing-and-re-running-checks-in-github-desktop.md | 6 +++--- 16 files changed, 26 insertions(+), 26 deletions(-) diff --git a/content/desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md b/content/desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md index ec0e481313a1..e168e2532337 100644 --- a/content/desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md +++ b/content/desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md @@ -16,9 +16,9 @@ shortTitle: Add a repository {% mac %} 1. In the menu bar, select **File**, then click **Add Local Repository**. - ![Screenshot of the menu bar on a Mac. The "File" dropdown menu is open, and an option labeled "Add Local Repository" is highlighted with an orange outline.](/assets/images/help/desktop/add-local-repository-mac.png) + ![Screenshot of the menu bar on a Mac. The "File" dropdown menu is open, and an option labeled "Add Local Repository" is outlined in orange.](/assets/images/help/desktop/add-local-repository-mac.png) 1. In the "Add Local Repository" window, click **Choose...**, then use the Finder window to navigate to the local repository you want to add. - ![Screenshot of the "Add Local Repository" window. Next to the "repository path" field, a button, labeled "Choose", is highlighted with an orange outline.](/assets/images/help/desktop/add-repo-choose-button-mac.png) + ![Screenshot of the "Add Local Repository" window. Next to the "repository path" field, a button, labeled "Choose", is outlined in orange.](/assets/images/help/desktop/add-repo-choose-button-mac.png) 1. When you have chosen the local repository, in the "Add Local Repository" window, click **Add Repository**. {% endmac %} @@ -26,9 +26,9 @@ shortTitle: Add a repository {% windows %} 1. In the menu bar, select **File**, then click **Add local repository**. - ![Screenshot of the menu bar on Windows. The "File" dropdown menu is open, and an option labeled "Add local repository" is highlighted with an orange outline.](/assets/images/help/desktop/add-local-repository-windows.png) + ![Screenshot of the menu bar on Windows. The "File" dropdown menu is open, and an option labeled "Add local repository" is outlined in orange.](/assets/images/help/desktop/add-local-repository-windows.png) 1. In the "Add local repository" window, click **Choose...**, then use Windows Explorer to navigate to the local repository you want to add. - ![Screenshot of the "Add local repository" window. Next to the "repository path" field, a button, labeled "Choose", is highlighted with an orange outline.](/assets/images/help/desktop/add-repo-choose-button-mac.png) + ![Screenshot of the "Add local repository" window. Next to the "repository path" field, a button, labeled "Choose", is outlined in orange.](/assets/images/help/desktop/add-repo-choose-button-mac.png) 1. Click **Add repository**. {% endwindows %} diff --git a/content/desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md b/content/desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md index 4c8a2fef2fe5..c9cc81ded262 100644 --- a/content/desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md +++ b/content/desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md @@ -18,7 +18,7 @@ shortTitle: Clone a GitHub repo {% data reusables.repositories.open-with-github-desktop %} 1. Click **Choose...** and navigate to a local directory where you want to clone the repository. - ![Screenshot of the "URL" tab of the "Clone a Repository" window. Next to the "Local Path" field, a button, labeled "Choose", is highlighted with an orange outline.](/assets/images/help/desktop/clone-choose-button-url-mac.png) + ![Screenshot of the "URL" tab of the "Clone a Repository" window. Next to the "Local Path" field, a button, labeled "Choose", is outlined in orange.](/assets/images/help/desktop/clone-choose-button-url-mac.png) > [!NOTE] > If the repository is configured to use LFS, you will be prompted to initialize {% data variables.large_files.product_name_short %}. diff --git a/content/desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md b/content/desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md index a69f4d9b928c..88fad4aaa73a 100644 --- a/content/desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md +++ b/content/desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md @@ -19,7 +19,7 @@ versions: ![Screenshot of the menu bar on a Mac. Under the open "GitHub Desktop" dropdown menu, a cursor hovers over "About GitHub Desktop", highlighted in blue.](/assets/images/help/desktop/desktop-menu-about-desktop-mac.png) 1. In the modal window, click **Check for Updates**. - ![Screenshot of the "GitHub Desktop" window. Under version details and links to external resources, a button, labeled "Check for Updates", is outlined in orange.](/assets/images/help/desktop/check-for-updates.png) + ![Screenshot of the "GitHub Desktop" window. Under version details and links to external resources, a "Check for Updates" button is outlined in orange.](/assets/images/help/desktop/check-for-updates.png) 1. If an update is available, quit and relaunch {% data variables.product.prodname_desktop %} to install the update. ## Resolving a crash at launch by updating {% data variables.product.prodname_desktop %} @@ -41,11 +41,11 @@ If you encounter a crash when attempting to launch {% data variables.product.pro 1. In the menu bar, select **Help**, then click **About GitHub Desktop**. - ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the open "Help" dropdown menu, an option labeled "About GitHub Desktop" is outlined in orange.](/assets/images/help/desktop/help-about-desktop-win.png) + ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the open "Help" dropdown menu, the "About GitHub Desktop" option is outlined in orange.](/assets/images/help/desktop/help-about-desktop-win.png) 1. Click **Check for Updates**. - ![Screenshot of the "GitHub Desktop" window. Under version details and links to external resources, a button, labeled "Check for Updates", is outlined in orange.](/assets/images/help/desktop/check-for-updates.png) + ![Screenshot of the "GitHub Desktop" window. Under version details and links to external resources, a "Check for Updates" button is outlined in orange.](/assets/images/help/desktop/check-for-updates.png) 1. If an update is available, quit and relaunch {% data variables.product.prodname_desktop %} to install the update. diff --git a/content/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md b/content/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md index 5fcf9684598a..df455356987d 100644 --- a/content/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md +++ b/content/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md @@ -52,7 +52,7 @@ Repository administrators can also enable rulesets. Rulesets can be used to requ {% data reusables.desktop.history-tab %} 1. Right-click on the commit you would like to create a new branch from and select **Create Branch from Commit**. - ![Screenshot of a list of commits in the "History" tab. Next to a commit, in a context menu, the cursor hovers over the "Create Branch from Commit" option.](/assets/images/help/desktop/create-branch-from-commit-context-menu.png) + ![Screenshot of a list of commits in the "History" tab. Next to a commit, the cursor hovers the "Create Branch from Commit" option in a context menu.](/assets/images/help/desktop/create-branch-from-commit-context-menu.png) {% data reusables.desktop.name-branch %} {% data reusables.desktop.confirm-new-branch-button %} diff --git a/content/desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md b/content/desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md index 39c711ef2579..655e0af5ba6d 100644 --- a/content/desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md +++ b/content/desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md @@ -36,7 +36,7 @@ Each commit shows: 1. If there are multiple files in the commit or range of commits, click on an individual file to see the changes made to that file. - ![Screenshot of a commit view. To the right of the "History" tab, in a list of files, the "hello.txt" file is selected and highlighted with an orange outline.](/assets/images/help/desktop/branch-history-file.png) + ![Screenshot of a commit view. To the right of the "History" tab, the "hello.txt" file is selected from a list and highlighted with an orange outline.](/assets/images/help/desktop/branch-history-file.png) ## Further reading diff --git a/content/desktop/managing-commits/checking-out-a-commit-in-github-desktop.md b/content/desktop/managing-commits/checking-out-a-commit-in-github-desktop.md index 1cd2ac9f4665..97de8cb0d0b6 100644 --- a/content/desktop/managing-commits/checking-out-a-commit-in-github-desktop.md +++ b/content/desktop/managing-commits/checking-out-a-commit-in-github-desktop.md @@ -21,7 +21,7 @@ Checking out a commit puts your repository in a "detached HEAD" state. In Git te {% data reusables.desktop.history-tab %} 1. Right-click on the commit you would like to checkout and select **Checkout commit**. - ![Screenshot of a list of commits in the "History" tab. Next to a commit, in a context menu, the "Checkout Commit" option is highlighted with an orange outline.](/assets/images/help/desktop/checkout-commit.png) + ![Screenshot of a list of commits in the "History" tab. Next to a commit, in a context menu, the "Checkout Commit" option is outlined in orange.](/assets/images/help/desktop/checkout-commit.png) 1. The **{% octicon "git-branch" aria-hidden="true" %} Current Branch** item in the repository bar will now show "Detached HEAD", along with the SHA of the commit that was checked out. ![Screenshot of the repository bar. The "Current Branch" item shows a "Detached HEAD" state and is highlighted with an orange outline.](/assets/images/help/desktop/branch-item.png) 1. To exit the "detached HEAD" state you will need to switch branches. For more information, see [AUTOTITLE](/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop#switching-between-branches). diff --git a/content/desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md b/content/desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md index 4901bd73d798..598a9ecd33f6 100644 --- a/content/desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md +++ b/content/desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md @@ -39,7 +39,7 @@ You can also use cherry-picking when collaborating with a team. Some projects in 1. Right-click the selected commit and click **Cherry pick commit**, then select the branch that you want to copy the commit to. You can also drag the commit that you want to cherry-pick from the "History" tab to the **{% octicon "git-branch" aria-hidden="true" %} Current Branch** dropdown menu, then drop the commit on the branch that you want to copy the commit to. - ![Screenshot of the "History" tab and the "Current Branch" dropdown view. The cursor hovers over the "my-feature" branch, and "plus one" icons indicate the addition of one commit.](/assets/images/help/desktop/cherry-picking.png) + ![Screenshot of the "History" tab and the "Current Branch" dropdown. The cursor hovers over "my-feature", and "plus one" icons show one extra commit.](/assets/images/help/desktop/cherry-picking.png) 1. The current branch changes to the branch onto which you cherry-picked the commit. You can now push the cherry-picked commit to the remote repository. diff --git a/content/desktop/managing-commits/managing-tags-in-github-desktop.md b/content/desktop/managing-commits/managing-tags-in-github-desktop.md index 588440638080..13d35d4a1d21 100644 --- a/content/desktop/managing-commits/managing-tags-in-github-desktop.md +++ b/content/desktop/managing-commits/managing-tags-in-github-desktop.md @@ -35,7 +35,7 @@ versions: 1. All tags associated with the commit are visible in that commit's metadata. - ![Screenshot of the detailed view of a commit. Above the commit's diff, in the commit's metadata, a tag icon and the label "hello-tag" are outlined in orange.](/assets/images/help/desktop/viewing-tags-in-commit.png) + ![Screenshot of the detailed view of a commit. Above the commit's diff, in the metadata, a tag icon and the label "hello-tag" are outlined in orange.](/assets/images/help/desktop/viewing-tags-in-commit.png) ## Deleting tags diff --git a/content/desktop/managing-commits/reordering-commits-in-github-desktop.md b/content/desktop/managing-commits/reordering-commits-in-github-desktop.md index 9e97bb7ff27b..5eb41ca94798 100644 --- a/content/desktop/managing-commits/reordering-commits-in-github-desktop.md +++ b/content/desktop/managing-commits/reordering-commits-in-github-desktop.md @@ -23,7 +23,7 @@ Reordering allows you to alter your commit history to provide a more meaningful {% data reusables.desktop.history-tab %} 1. Drag the commit that you want to reorder and drop it between two adjoining commits. - ![Screenshot of a list of commits in the "History" tab. The cursor hovers over a narrow horizontal line between two commits, with a "one" icon indicating one commit is being moved.](/assets/images/help/desktop/reorder-drag-and-drop.png) + ![Screenshot of a list of commits in the "History" tab. The cursor hovers over a narrow line between two commits as one commit is moved, see "one" icon.](/assets/images/help/desktop/reorder-drag-and-drop.png) While the application reorders the commits, a **Reorder in process** dialog indicates the progress of the change. diff --git a/content/desktop/managing-commits/squashing-commits-in-github-desktop.md b/content/desktop/managing-commits/squashing-commits-in-github-desktop.md index 3a6fdd202801..31dd11e07f2f 100644 --- a/content/desktop/managing-commits/squashing-commits-in-github-desktop.md +++ b/content/desktop/managing-commits/squashing-commits-in-github-desktop.md @@ -32,7 +32,7 @@ Squashing allows you to combine multiple commits in your branch's history into a {% endwindows %} - ![Screenshot of a list of commits in the "History" tab. The cursor hovers over a commit, highlighted in blue. A hover-over text box says, "Squash 2 commits".](/assets/images/help/desktop/squash-drag-and-drop.png) + ![Screenshot of a list of commits in the "History" tab. The cursor hovers over a commit, highlighted in blue. A hover-over box shows "Squash 2 commits".](/assets/images/help/desktop/squash-drag-and-drop.png) 1. Modify the commit message of your new commit. The commit messages of the selected commits you want to squash are pre-filled into the **Summary** and **Description** fields. 1. Click **Squash Commits**. diff --git a/content/desktop/overview/creating-your-first-repository-using-github-desktop.md b/content/desktop/overview/creating-your-first-repository-using-github-desktop.md index 50b307065c91..6c0ab00e27a7 100644 --- a/content/desktop/overview/creating-your-first-repository-using-github-desktop.md +++ b/content/desktop/overview/creating-your-first-repository-using-github-desktop.md @@ -60,7 +60,7 @@ In the file menu at the top of the screen, you can access settings and actions t At the top of the {% data variables.product.prodname_desktop %} app, you will see a bar that shows the current state of your repository. -![Screenshot of the GitHub Desktop app. A bar displaying details for the "hello-world" repository spans the top of the window, and is outlined in orange.](/assets/images/help/desktop/explore-github-desktop.png) +![Screenshot of the GitHub Desktop app. A bar showing details for the "hello-world" repository spans the top of the window, and is outlined in orange.](/assets/images/help/desktop/explore-github-desktop.png) * **Current repository** shows the name of the repository you're working on. You can click **Current repository** to switch to a different repository in {% data variables.product.prodname_desktop %}. * **Current branch** shows the name of the branch you're working on. You can click **Current branch** to view all the branches in your repository, switch to a different branch, or create a new branch. Once you create pull requests in your repository, you can also view these by clicking on **Current branch**. @@ -70,7 +70,7 @@ At the top of the {% data variables.product.prodname_desktop %} app, you will se In the left sidebar, you'll find the **Changes** and **History** views. -![Screenshot of the GitHub Desktop app. A sidebar on the left-hand side, with tabs labeled "Changes" and "History", is highlighted with an orange outline.](/assets/images/help/desktop/changes-and-history.png) +![Screenshot of the GitHub Desktop app. A sidebar on the left-hand side, with tabs labeled "Changes" and "History", is outlined in orange.](/assets/images/help/desktop/changes-and-history.png) * The **Changes** view shows changes you've made to files in your current branch but haven't committed to your local repository. At the bottom, there is a box with "Summary" and "Description" text boxes and a **Commit to BRANCH** button. This is where you'll commit new changes. The **Commit to BRANCH** button is dynamic and will display which branch you're committing your changes to. * The **History** view shows the previous commits on the current branch of your repository. You should see an "Initial commit" that was created by {% data variables.product.prodname_desktop %} when you created your repository. To the right of the commit, depending on the options you selected while creating your repository, you may see _.gitattributes_, _.gitignore_, LICENSE, or README files. You can click each file to see a diff for that file, which is the changes made to the file in that commit. The diff only shows the parts of the file that have changed, not the entire contents of the file diff --git a/content/desktop/overview/launching-github-desktop-from-the-command-line.md b/content/desktop/overview/launching-github-desktop-from-the-command-line.md index 367ed71abacb..4c665124bfc8 100644 --- a/content/desktop/overview/launching-github-desktop-from-the-command-line.md +++ b/content/desktop/overview/launching-github-desktop-from-the-command-line.md @@ -12,7 +12,7 @@ versions: {% mac %} 1. In the menu bar, select the **{% data variables.product.prodname_desktop %}** menu, then click **Install Command Line Tool**. -![Screenshot of the menu bar on a Mac. Under the expanded "GitHub Desktop" dropdown menu, the cursor hovers over "Install command line tool", highlighted in blue.](/assets/images/help/desktop/mac-install-command-line-tool.png) +![Screenshot of the menu bar on a Mac. Under the "GitHub Desktop" dropdown menu, the option "Install command line tool" is highlighted in blue.](/assets/images/help/desktop/mac-install-command-line-tool.png) 1. Open Terminal. 1. {% data reusables.desktop.launch-desktop-from-command-line %} diff --git a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md index 411e1c851939..294c1c6c2d9f 100644 --- a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md +++ b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md @@ -37,7 +37,7 @@ Before you create a pull request, you'll need to push changes to a branch on {% {% windows %} - ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the expanded "Repository" dropdown menu, an option labeled "Create Issue on GitHub" is outlined in orange.](/assets/images/help/desktop/create-issue-windows.png) + ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the "Repository" dropdown menu, the "Create Issue on GitHub" option is outlined in orange.](/assets/images/help/desktop/create-issue-windows.png) {% endwindows %} diff --git a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop.md b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop.md index 0af01820e5f8..ef8b570f92bc 100644 --- a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop.md +++ b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop.md @@ -57,7 +57,7 @@ Some workflows require or benefit from rebasing instead of merging. By rebasing {% windows %} - ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the expanded "Branch" dropdown menu, an option labeled "Rebase Current Branch" is outlined in orange.](/assets/images/help/desktop/windows-rebase-current-branch.png) + ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the "Branch" dropdown menu, the "Rebase Current Branch" option is outlined in orange.](/assets/images/help/desktop/windows-rebase-current-branch.png) {% endwindows %} @@ -74,13 +74,13 @@ Some workflows require or benefit from rebasing instead of merging. By rebasing {% mac %} - ![Screenshot of the menu bar on a Mac. On the expanded "Branch" dropdown menu, the cursor hovers over an option labeled "Squash and Merge into Current Branch".](/assets/images/help/desktop/squash-and-merge-menu.png) + ![Screenshot of the menu bar on a Mac. On the expanded "Branch" dropdown menu, the cursor hovers over the "Squash and Merge into Current Branch" option.](/assets/images/help/desktop/squash-and-merge-menu.png) {% endmac %} {% windows %} - ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the expanded "Branch" dropdown menu, option labeled "Squash and merge into curre..." is outlined in orange.](/assets/images/help/desktop/windows-squash-and-merge-menu.png) + ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the "Branch" dropdown menu, the "Squash and merge into curre..." option is outlined.](/assets/images/help/desktop/windows-squash-and-merge-menu.png) {% endwindows %} diff --git a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md index 1bc31310775d..3933691b4b96 100644 --- a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md +++ b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md @@ -41,7 +41,7 @@ You cannot comment on a pull request from {% data variables.product.prodname_des 1. In the list of pull requests, click the pull request that you would like to open in {% data variables.product.prodname_desktop %}. 1. To the right of the title of the pull request, click **{% octicon "code" aria-hidden="true" %} Code**, then, on the **Local** tab, click **Checkout with GitHub Desktop**. - ![Screenshot of a pull request on GitHub. The "Code" dropdown menu is expanded, and a button, labeled "Checkout with GitHub Desktop" is outlined in orange.](/assets/images/help/desktop/open-pr-in-desktop-button.png) + ![Screenshot of a pull request on GitHub. The "Code" dropdown menu is expanded, and the "Checkout with GitHub Desktop" button is outlined in orange.](/assets/images/help/desktop/open-pr-in-desktop-button.png) {% data reusables.desktop.checked-out-pr %} diff --git a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md index 6c76b104af4d..2f43e1407a5d 100644 --- a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md +++ b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md @@ -20,11 +20,11 @@ redirect_from: {% data reusables.desktop.choose-pr-from-list %} 1. Click on the pull request number, to the right of the pull request branch name. - ![Screenshot of the repository bar. Next to the "Current Branch" button, a numbered label, displayed with a red cross for failing checks, is outlined in orange.](/assets/images/help/desktop/checks-dialog.png) + ![Screenshot of the repository bar. Next to the "Current Branch" button, a numbered label, with a red cross for failing checks, is outlined in orange.](/assets/images/help/desktop/checks-dialog.png) 1. To re-run failed checks, click **{% octicon "sync" aria-hidden="true" %} Re-run** and select **Re-run Failed Checks**. - ![Screenshot of a dropdown view from a pull request label. Next to the message "Some checks were not successful", a button labeled "Re-run" is outlined in orange.](/assets/images/help/desktop/re-run-failed-checks.png) + ![Screenshot of a dropdown view from a pull request label. Next to "Some checks were not successful", a button labeled "Re-run" is outlined in orange.](/assets/images/help/desktop/re-run-failed-checks.png) 1. To re-run individual checks, hover over the individual check you want to re-run and select the {% octicon "sync" aria-label="The sync icon" %} icon to re-run the check. - ![Screenshot of a dropdown view from a pull request label. The cursor hovers over a check, and an icon of two arrows forming a circle is outlined in orange.](/assets/images/help/desktop/re-run-individual-checks.png) + ![Screenshot of a dropdown view from a pull request label. The cursor hovers over a check. An icon of two arrows forming a circle is outlined in orange.](/assets/images/help/desktop/re-run-individual-checks.png) 1. You will see a confirmation dialog with the summary of the checks that will be re-run. Click **Re-run Checks** to confirm that you want to perform the re-run. From c86be62ccbfc3921390a636c39b56742e0622582 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Thu, 16 Jan 2025 09:00:25 +0000 Subject: [PATCH 5/5] Hack week 2025: Fix warnings in authentication and billing folders (#53930) Co-authored-by: Vanessa --- .../sudo-mode.md | 8 +------- ...adding-a-gpg-key-to-your-github-account.md | 19 ++----------------- ...your-github-advanced-security-licensing.md | 4 ++-- ...ing-your-github-advanced-security-usage.md | 2 +- .../about-billing-on-github.md | 2 +- .../adding-or-editing-a-payment-method.md | 2 +- ...ging-the-duration-of-your-billing-cycle.md | 2 +- 7 files changed, 9 insertions(+), 30 deletions(-) diff --git a/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md b/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md index 2828b5b6c762..39dc14cac93e 100644 --- a/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md +++ b/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md @@ -42,19 +42,17 @@ After you authenticate to perform a sensitive action, your session is temporaril ## Confirming access for sudo mode -To confirm access for sudo mode, you {% ifversion totp-and-mobile-sudo-challenge %}can{% else %}must{% endif %} authenticate with your password.{% ifversion totp-and-mobile-sudo-challenge %} Optionally, you can use a different authentication method, like {% ifversion passkeys %}a passkey, {% endif %}{% ifversion fpt or ghec %}a security key, {% data variables.product.prodname_mobile %}, or a 2FA code{% elsif ghes %}a security key or a 2FA code{% endif %}.{% endif %} +To confirm access for sudo mode, you can authenticate with your password. Optionally, you can use a different authentication method, like {% ifversion passkeys %}a passkey, {% endif %}{% ifversion fpt or ghec %}a security key, {% data variables.product.prodname_mobile %}, or a 2FA code{% elsif ghes %}a security key or a 2FA code{% endif %}. {%- ifversion passkeys %} * [Confirming access using a passkey key](#confirming-access-using-a-passkey) {%- endif %} -{%- ifversion totp-and-mobile-sudo-challenge %} * [Confirming access using a security key](#confirming-access-using-a-security-key) {%- ifversion fpt or ghec %} * [Confirming access using GitHub Mobile](#confirming-access-using-github-mobile) {%- endif %} * [Confirming access using a 2FA code](#confirming-access-using-a-2fa-code) * [Confirming access using your password](#confirming-access-using-your-password) -{%- endif %} {% ifversion passkeys %} @@ -63,8 +61,6 @@ To confirm access for sudo mode, you {% ifversion totp-and-mobile-sudo-challenge You must have a passkey registered to your account to confirm access to your account for sudo mode using a passkey. See [AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys). {% endif %} -{% ifversion totp-and-mobile-sudo-challenge %} - ### Confirming access using a security key You must configure two-factor authentication (2FA) for your account using a security key to confirm access to your account for sudo mode using the security key. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key). @@ -94,6 +90,4 @@ When prompted to authenticate for sudo mode, type the authentication code from y ### Confirming access using your password -{% endif %} - When prompted to authenticate for sudo mode, type your password, then click **Confirm**. diff --git a/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md b/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md index abc0a6941cee..e5e97d864646 100644 --- a/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md +++ b/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md @@ -26,10 +26,9 @@ To sign commits associated with your account on {% data variables.product.produc You can add multiple public keys to your account on {% data variables.product.product_name %}. Commits signed by any of the corresponding private keys will show as verified. {% ifversion persistent-commit-verification %}Once a commit has been verified, any commits signed by the corresponding private key will continue to show as verified, even if the public key is removed.{% else %}If you remove a public key, any commits signed by the corresponding private key will no longer show as verified.{% endif %} -![Screenshot of a list of commits. One commit is marked with a "Verified" label. Next to the label, a dropdown explains that the commit was signed and shows a timestamp of when it was signed.](/assets/images/help/settings/verified-persistent-commit.png) +![Screenshot of a list of commits. One commit is marked as "Verified." A dropdown shows the commit was signed and when it was signed.](/assets/images/help/settings/verified-persistent-commit.png) -{% ifversion upload-expired-or-revoked-gpg-key %} -To verify as many of your commits as possible, you can add expired and revoked keys. If the key meets all other verification requirements, commits that were previously signed by any of the corresponding private keys will show as verified and indicate that their signing key is expired or revoked.{% endif %} +To verify as many of your commits as possible, you can add expired and revoked keys. If the key meets all other verification requirements, commits that were previously signed by any of the corresponding private keys will show as verified and indicate that their signing key is expired or revoked. {% data reusables.gpg.supported-gpg-key-algorithms %} @@ -45,20 +44,6 @@ When verifying a signature, {% data variables.product.product_name %} extracts t 1. Click **Add GPG key**. 1. If prompted, authenticate to your {% data variables.product.prodname_dotcom %} account to confirm the action. -{% ifversion upload-expired-or-revoked-gpg-key %} -{% else %} - -## Updating an expired GPG key - -When verifying a signature, {% data variables.product.product_name %} checks that the key is not revoked or expired. If your signing key is revoked or expired, {% data variables.product.product_name %} cannot verify your signatures. - -If your key is expired, you must [update its expiration](https://www.gnupg.org/gph/en/manual.html#AEN329), export the new key, delete the expired key in your account on {% data variables.product.product_name %}, and add the new key to your account as described above. Your previous commits and tags will show as verified, as long as the key meets all other verification requirements. - -If your key is revoked, use the primary key or another key that is not revoked to sign your commits. - -If your key is invalid and you don't use another valid key in your key set, but instead generate a new GPG key with a new set of credentials, then your commits made with the revoked or expired key will continue to show as unverified. Also, your new credentials will not be able to re-sign or verify your old commits and tags. -{% endif %} - ## Further reading * [AUTOTITLE](/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys) diff --git a/content/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md b/content/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md index 6f6baea2bfe4..d01ef0348193 100644 --- a/content/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md +++ b/content/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md @@ -34,7 +34,7 @@ Each license for {% data variables.product.prodname_GH_advanced_security %} spec 1. Under "Committers", click **Manage committers**. 1. Under "Total committers", click the plus or minus buttons to add or remove committers. - ![Screenshot of the {% data variables.product.prodname_GH_advanced_security %} committers screen. A text box with the number 5, a minus button on its left, and a plus button on its right, are highlighted in an orange outline.](/assets/images/help/enterprises/ghas-add-committers.png) + ![Screenshot of the {% data variables.product.prodname_GH_advanced_security %} committers screen. A text box with the number 5, with a minus and a plus button, are outlined in orange.](/assets/images/help/enterprises/ghas-add-committers.png) 1. Click **Update committers**. ## Canceling your {% data variables.product.prodname_GH_advanced_security %} subscription @@ -44,5 +44,5 @@ Each license for {% data variables.product.prodname_GH_advanced_security %} spec {% data reusables.enterprise-accounts.license-tab %} 1. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Manage**, then click **Cancel Subscription**. - ![Screenshot of the "Manage" dropdown in the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Cancel Subscription" button is highlighted with an orange outline.](/assets/images/help/enterprises/ghas-cancel-subscription.png) + ![Screenshot of the "Manage" dropdown in the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Cancel Subscription" button is outlined in orange.](/assets/images/help/enterprises/ghas-cancel-subscription.png) 1. To confirm your cancellation, click **I understand, cancel Advanced Security**. diff --git a/content/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md b/content/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md index dff77a72a22f..52fc30fbe39c 100644 --- a/content/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md +++ b/content/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md @@ -141,7 +141,7 @@ You can download the {% data variables.product.prodname_advanced_security %} lic {%- ifversion ghec %} 1. Under "{% data variables.product.prodname_GH_advanced_security %}," click the **Manage** dropdown and then click **Download report**. - ![Screenshot of the "Manage" dropdown in the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Download Report" button is highlighted with an orange outline.](/assets/images/help/enterprises/ghas-download-report.png) + ![Screenshot of the "Manage" dropdown in the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Download Report" button is outlined in orange.](/assets/images/help/enterprises/ghas-download-report.png) {%- elsif ghes %} 1. Under "{% data variables.product.prodname_GH_advanced_security %}," click **{% octicon "download" aria-hidden="true" %} CSV report** in the header of the "Committers" table. diff --git a/content/billing/using-the-billing-platform/about-billing-on-github.md b/content/billing/using-the-billing-platform/about-billing-on-github.md index 5697be2d5531..7b36458f7d64 100644 --- a/content/billing/using-the-billing-platform/about-billing-on-github.md +++ b/content/billing/using-the-billing-platform/about-billing-on-github.md @@ -139,6 +139,6 @@ If you're an organization or enterprise owner, you can switch between settings f {% data reusables.user-settings.access_settings %} 1. At the top of the page, to the right of your name, click **Switch settings context**. - ![Screenshot of the "Public profile" settings page for The Octocat. Next to the text "Your personal profile," a link, labeled "Switch settings context," is outlined in orange.](/assets/images/help/settings/context-switcher-button.png) + ![Screenshot of the "Public profile" settings for The Octocat. Next to "Your personal profile," a "Switch settings context" link is outlined in orange.](/assets/images/help/settings/context-switcher-button.png) 1. Start typing the name of the account you want to switch to, then click the name of the account. 1. In the left sidebar, click **{% octicon "credit-card" aria-hidden="true" %} Billing and plans**. diff --git a/content/billing/using-the-billing-platform/adding-or-editing-a-payment-method.md b/content/billing/using-the-billing-platform/adding-or-editing-a-payment-method.md index e28482f5b5bd..57a8f68dac73 100644 --- a/content/billing/using-the-billing-platform/adding-or-editing-a-payment-method.md +++ b/content/billing/using-the-billing-platform/adding-or-editing-a-payment-method.md @@ -91,7 +91,7 @@ You can update your enterprise account's credit card or PayPal details, or you c {% data reusables.enterprise-accounts.billing-tab %} 1. Under "Payment information", click **Switch to invoice**. - ![Screenshot of the billing page for an enterprise account. In the "Payment information" section, a link, labeled "Switch to invoice", is outlined in dark orange.](/assets/images/help/billing/switch-to-invoice.png) + ![Screenshot of the billing page for an enterprise account. In the "Payment information" section, a "Switch to invoice" link is outlined in orange.](/assets/images/help/billing/switch-to-invoice.png) 1. Complete the form, then click **Contact Sales**. {% endif %} diff --git a/content/billing/using-the-billing-platform/changing-the-duration-of-your-billing-cycle.md b/content/billing/using-the-billing-platform/changing-the-duration-of-your-billing-cycle.md index 1285a811986c..2a4326efa17c 100644 --- a/content/billing/using-the-billing-platform/changing-the-duration-of-your-billing-cycle.md +++ b/content/billing/using-the-billing-platform/changing-the-duration-of-your-billing-cycle.md @@ -63,7 +63,7 @@ When you change your billing cycle's duration, your {% data variables.product.pr {% data reusables.enterprise-accounts.billing-tab %} 1. Under "Payment information", click **Switch to yearly billing and save** or **Switch to monthly billing**. - ![Screenshot of the billing page for an enterprise account. In the "Payment information" section, a link, labeled "Switch to yearly billing and save", is outlined in dark orange.](/assets/images/help/billing/switch-to-yearly-billing.png) + ![Screenshot of the billing page for an enterprise account. In "Payment information", a "Switch to yearly billing and save" link is outlined in orange.](/assets/images/help/billing/switch-to-yearly-billing.png) 1. Under "How often do you want to be billed?", select a billing cycle. 1. Click **Change your account's billing cycle**. {% endif %}