From cbda3f24344e19678a412f7e9b595ba433e5fee7 Mon Sep 17 00:00:00 2001 From: Grace Park Date: Fri, 23 Jun 2023 10:45:10 -0700 Subject: [PATCH] Fix trailing spaces in content and data (#37904) --- ...-of-your-personal-accounts-repositories.md | 2 +- ...an-email-address-to-your-github-account.md | 2 +- ...evels-for-a-personal-account-repository.md | 2 +- .../managing-multiple-accounts.md | 4 +-- ...ilding-and-testing-xamarin-applications.md | 2 +- .../creating-a-javascript-action.md | 2 +- .../developing-a-third-party-cli-action.md | 2 +- ...ublishing-actions-in-github-marketplace.md | 2 +- ...-workflows-from-your-private-repository.md | 4 +-- ...ions-and-workflows-with-your-enterprise.md | 4 +-- ...ns-and-workflows-with-your-organization.md | 4 +-- .../deploying-nodejs-to-azure-app-service.md | 3 +- .../deploying-to-azure-static-web-app.md | 2 +- ...g-openid-connect-in-amazon-web-services.md | 2 +- ...-openid-connect-with-reusable-workflows.md | 12 ++++---- .../about-self-hosted-runners.md | 2 +- .../adding-self-hosted-runners.md | 2 +- ...and-troubleshooting-self-hosted-runners.md | 2 +- .../learn-github-actions/expressions.md | 4 +-- .../scheduling-issue-creation.md | 2 +- .../downloading-workflow-artifacts.md | 4 +-- .../removing-workflow-artifacts.md | 4 +-- ...-migration-with-github-actions-importer.md | 2 +- ...tions-importer-with-custom-transformers.md | 2 +- ...rom-bamboo-with-github-actions-importer.md | 8 +++--- ...om-jenkins-with-github-actions-importer.md | 2 +- .../publishing-docker-images.md | 1 + content/actions/quickstart.md | 4 +-- .../security-hardening-for-github-actions.md | 2 +- .../about-service-containers.md | 2 +- .../customizing-github-hosted-runners.md | 4 +-- ...hing-dependencies-to-speed-up-workflows.md | 8 +++--- .../events-that-trigger-workflows.md | 2 +- ...ot-to-work-with-limited-internet-access.md | 10 +++---- .../about-enterprise-configuration.md | 2 +- .../configuring-applications.md | 4 +-- .../configuring-backups-on-your-appliance.md | 4 +-- .../configuring-web-commit-signing.md | 6 ++-- .../troubleshooting-tls-errors.md | 2 +- .../about-repository-caching.md | 2 +- .../about-cluster-nodes.md | 4 +-- ...ter-nodes-with-node-eligibility-service.md | 8 +++--- ...ng-a-failover-to-your-replica-appliance.md | 4 +-- ...oring-a-high-availability-configuration.md | 4 +-- .../increasing-storage-capacity.md | 2 +- ...n-issues-with-upgrades-to-your-instance.md | 4 +-- .../upgrade-requirements.md | 2 +- .../upgrading-github-enterprise-server.md | 2 +- ...ating-your-enterprise-to-github-actions.md | 2 +- .../about-using-actions-in-your-enterprise.md | 6 ++-- ...manually-syncing-actions-from-githubcom.md | 6 ++-- .../using-actions-in-github-ae.md | 2 +- ...d-access-management-for-your-enterprise.md | 2 +- ...f-your-identity-provider-is-unavailable.md | 2 +- .../inviting-people-to-use-your-instance.md | 2 +- ...for-your-idps-conditional-access-policy.md | 8 +++--- ...le-sign-on-for-enterprise-managed-users.md | 4 +-- ...ovisioning-for-enterprise-managed-users.md | 4 +-- ...se-to-a-new-identity-provider-or-tenant.md | 10 +++---- ...ning-for-your-enterprise-using-azure-ad.md | 2 +- ...visioning-with-scim-for-your-enterprise.md | 2 +- ...n-organization-to-an-enterprise-account.md | 4 +-- ...lling-github-enterprise-server-on-azure.md | 2 +- .../exporting-server-statistics.md | 4 +-- ...ng-server-statistics-using-the-rest-api.md | 2 +- .../exploring-user-activity/log-forwarding.md | 4 +-- .../audit-log-events-for-your-enterprise.md | 2 +- ...uring-the-audit-log-for-your-enterprise.md | 4 +-- content/admin/overview/about-github-ae.md | 12 ++++---- .../about-the-github-enterprise-api.md | 2 +- .../creating-an-enterprise-account.md | 2 +- content/admin/overview/system-overview.md | 2 +- .../about-enterprise-policies.md | 2 +- ...s-for-github-actions-in-your-enterprise.md | 6 ++-- ...adding-organizations-to-your-enterprise.md | 2 +- .../creating-an-oauth-app.md | 2 +- ...nces-between-github-apps-and-oauth-apps.md | 2 +- ...-available-for-github-enterprise-server.md | 2 +- ...ing-and-modifying-installed-github-apps.md | 2 +- ...authentication-with-saml-single-sign-on.md | 8 +++--- .../about-anonymized-urls.md | 2 +- .../creating-a-strong-password.md | 2 +- ...moving-sensitive-data-from-a-repository.md | 6 ++-- .../reviewing-your-ssh-keys.md | 8 +++--- .../sudo-mode.md | 2 +- .../token-expiration-and-revocation.md | 2 +- .../viewing-and-managing-your-sessions.md | 6 ++-- ...-github-using-two-factor-authentication.md | 6 ++-- .../configuring-two-factor-authentication.md | 4 +-- ...uthentication-for-your-personal-account.md | 2 +- .../error-permission-denied-publickey.md | 10 +++---- ...-your-spending-limit-for-github-actions.md | 2 +- ...ut-billing-for-github-advanced-security.md | 2 +- ...your-github-advanced-security-licensing.md | 6 ++-- ...-up-a-trial-of-github-advanced-security.md | 2 +- ...signing-up-for-github-advanced-security.md | 4 +-- ...nformation-for-github-advanced-security.md | 6 ++-- .../about-billing-for-github-codespaces.md | 2 +- ...your-spending-limit-for-github-packages.md | 2 +- .../about-per-user-pricing.md | 4 +-- .../adding-information-to-your-receipts.md | 2 +- .../setting-your-billing-email.md | 4 +-- ...ing-license-usage-for-github-enterprise.md | 4 +-- ...pting-github-advanced-security-at-scale.md | 2 +- .../phase-2-preparing-to-enable-at-scale.md | 6 ++-- ...figuring-code-scanning-for-a-repository.md | 6 ++-- ...-codeql-workflow-for-compiled-languages.md | 2 +- ...nning-alerts-in-issues-using-task-lists.md | 10 +++---- ...onfiguring-codeql-cli-in-your-ci-system.md | 2 +- .../about-codeql-packs.md | 6 ++-- .../creating-and-working-with-codeql-packs.md | 2 +- .../creating-codeql-databases.md | 6 ++-- ...your-actions-up-to-date-with-dependabot.md | 6 ++-- ...he-detection-of-vulnerable-dependencies.md | 2 +- ...ing-custom-patterns-for-secret-scanning.md | 6 ++-- .../protecting-pushes-with-secret-scanning.md | 6 ++-- .../secret-scanning-patterns.md | 4 +-- .../about-global-security-advisories.md | 2 +- .../about-the-github-advisory-database.md | 8 +++--- ...isories-in-the-github-advisory-database.md | 4 +-- ...-disclosure-of-security-vulnerabilities.md | 6 ++-- ...-writing-repository-security-advisories.md | 2 +- ...ately-reported-security-vulnerabilities.md | 4 +-- ...tely-reporting-a-security-vulnerability.md | 4 +-- ...ulnerability-reporting-for-a-repository.md | 2 +- ...erability-reporting-for-an-organization.md | 2 +- ...g-the-security-settings-of-a-repository.md | 6 ++-- ...blishing-a-repository-security-advisory.md | 2 +- .../end-to-end-supply-chain-overview.md | 2 +- .../end-to-end-supply-chain/securing-code.md | 2 +- .../about-dependency-review.md | 2 +- ...e-bill-of-materials-for-your-repository.md | 2 +- ...disaster-recovery-for-github-codespaces.md | 2 +- .../changing-the-shell-in-a-codespace.md | 6 ++-- ...ur-default-editor-for-github-codespaces.md | 6 ++-- .../connecting-to-a-private-network.md | 4 +-- .../using-source-control-in-your-codespace.md | 2 +- ...github-codespaces-for-your-organization.md | 2 +- ...ing-the-codespaces-in-your-organization.md | 4 +-- ...-and-organization-for-github-codespaces.md | 2 +- ...-github-codespaces-in-your-organization.md | 8 +++--- ...ion-billed-codespaces-a-user-can-create.md | 4 +-- content/codespaces/overview.md | 2 +- ...a-prebuild-to-access-other-repositories.md | 16 +++++------ ...ng-recommended-secrets-for-a-repository.md | 4 +-- ...shooting-authentication-to-a-repository.md | 6 ++-- ...ing-creation-and-deletion-of-codespaces.md | 2 +- ...-gpg-verification-for-github-codespaces.md | 8 +++--- .../troubleshooting-included-usage.md | 2 +- ...shooting-personalization-for-codespaces.md | 2 +- .../about-wikis.md | 2 +- .../getting-started-with-github-copilot.md | 14 +++++----- ...iewing-a-pull-request-in-github-desktop.md | 2 +- .../updating-github-desktop.md | 8 +++--- .../creating-discussion-category-forms.md | 8 +++--- .../syntax-for-discussion-category-forms.md | 2 +- .../about-github-campus-program.md | 2 +- .../about-github-classroom.md | 2 +- .../replit-with-github-classroom.md | 2 +- .../about-assignments.md | 2 +- ...-to-contribute-to-open-source-on-github.md | 2 +- .../saving-repositories-with-stars.md | 4 +-- .../caching-your-github-credentials-in-git.md | 2 +- ...hy-is-git-always-asking-for-my-password.md | 2 +- .../access-permissions-on-github.md | 4 +-- .../getting-started-with-github-team.md | 2 +- .../get-started/quickstart/create-a-repo.md | 4 +-- content/get-started/quickstart/fork-a-repo.md | 2 +- .../get-started/quickstart/git-cheatsheet.md | 2 +- content/get-started/quickstart/hello-world.md | 4 +-- content/get-started/quickstart/set-up-git.md | 10 +++---- ...g-a-subfolder-out-into-a-new-repository.md | 4 +-- .../saving-gists-with-stars.md | 2 +- .../creating-a-saved-reply.md | 2 +- .../migrating-graphql-global-node-ids.md | 6 ++-- .../about-project-boards.md | 2 +- .../editing-a-project-board.md | 2 +- .../adding-items-automatically.md | 2 +- .../archiving-items-automatically.md | 2 +- .../using-the-api-to-manage-projects.md | 16 +++++------ .../customizing-the-table-layout.md | 4 +-- .../managing-your-views.md | 4 +-- .../managing-access-to-your-projects.md | 12 ++++---- .../about-single-select-fields.md | 12 ++++---- .../about-text-and-number-fields.md | 2 +- .../configuring-charts.md | 2 +- .../about-tasklists.md | 2 +- ...embers-saml-access-to-your-organization.md | 2 +- ...owed-ip-addresses-for-your-organization.md | 2 +- ...tor-authentication-in-your-organization.md | 2 +- ...access-to-an-organization-project-board.md | 2 +- ...ng-a-former-member-of-your-organization.md | 4 +-- ...ng-github-actions-for-your-organization.md | 4 +-- .../about-scim-for-organizations.md | 2 +- ...-identity-provider-to-your-organization.md | 2 +- ...access-management-for-your-organization.md | 10 +++---- .../about-teams.md | 6 ++-- content/packages/quickstart.md | 2 +- .../about-custom-domains-and-github-pages.md | 2 +- .../about-pull-request-merges.md | 2 +- ...out-permissions-and-visibility-of-forks.md | 2 +- .../comparing-commits.md | 2 +- .../managing-rulesets/about-rulesets.md | 2 +- .../best-practices-for-repositories.md | 2 +- .../creating-a-new-repository.md | 2 +- .../restoring-a-deleted-repository.md | 2 +- .../about-repository-languages.md | 2 +- ...anding-connections-between-repositories.md | 2 +- .../adding-a-file-to-a-repository.md | 2 +- .../downloading-source-code-archives.md | 2 +- content/rest/actions/artifacts.md | 2 +- content/rest/apps/oauth-applications.md | 2 +- content/rest/code-scanning.md | 2 +- content/rest/deployments/branch-policies.md | 2 +- content/rest/enterprise-admin/scim.md | 2 +- content/rest/guides/working-with-comments.md | 2 +- content/rest/quickstart.md | 12 ++++---- content/rest/scim.md | 2 +- content/rest/teams/discussion-comments.md | 2 +- content/rest/teams/external-groups.md | 2 +- .../about-searching-on-github.md | 6 ++-- ...understanding-github-code-search-syntax.md | 18 ++++++------ .../github-acceptable-use-policies.md | 6 ++-- .../github-active-malware-or-exploits.md | 4 +-- ...isrupting-the-experience-of-other-users.md | 12 ++++---- .../github-hate-speech-and-discrimination.md | 2 +- ...ithub-misinformation-and-disinformation.md | 2 +- ...olence-and-gratuitously-violent-content.md | 2 +- .../dmca-takedown-policy.md | 8 +++--- ...thub-private-information-removal-policy.md | 8 +++--- ...de-to-submitting-a-dmca-takedown-notice.md | 4 +-- .../github-community-code-of-conduct.md | 4 +-- .../github-community-guidelines.md | 2 +- .../github-corporate-terms-of-service.md | 4 +-- .../github-marketplace-developer-agreement.md | 4 +-- .../github-marketplace-terms-of-service.md | 2 +- .../github-terms/github-terms-of-service.md | 4 +-- .../github-and-trade-controls.md | 2 +- .../github-deceased-user-policy.md | 4 +-- .../github-candidate-privacy-policy.md | 28 +++++++++---------- ...-copilot-for-business-privacy-statement.md | 6 ++-- .../github-octernships-terms-of-service.md | 4 +-- .../tax-information-for-github-sponsors.md | 6 ++-- .../paying-for-github-sponsors-by-invoice.md | 2 +- ...paces-your-instant-dev-box-in-the-cloud.md | 2 +- .../actions/comparing-artifacts-caching.md | 2 +- .../disable-selfhosted-runners-overview.md | 2 +- .../actions/example-docs-engineering-intro.md | 2 +- .../actions/example-workflow-intro-ci.md | 2 +- .../actions/general-security-hardening.md | 2 +- .../actions/inputs-vs-github-event-inputs.md | 2 +- ...running-jobs-in-a-container-credentials.md | 2 +- .../actions/jobs/using-matrix-strategy.md | 2 +- .../runner-group-assign-policy-workflow.md | 4 +-- ...-runner-management-permissions-required.md | 2 +- .../self-hosted-runner-ports-protocols.md | 2 +- .../actions/workflow-permissions-modifying.md | 2 +- ...ret-scanning-push-protection-enterprise.md | 2 +- .../apps/oauth-app-access-restrictions.md | 2 +- .../audit_log/git-events-export-limited.md | 4 +-- data/reusables/billing/edit-payment-method.md | 2 +- data/reusables/billing/email-notifications.md | 2 +- data/reusables/billing/license-statuses.md | 2 +- data/reusables/classroom/supported-lmses.md | 2 +- .../you-can-choose-a-template-repository.md | 2 +- .../code-scanning/beta-codeql-ml-queries.md | 2 +- .../example-configuration-files.md | 2 +- .../codeql-cli/codeql-site-migration-note.md | 2 +- .../changing-machine-type-in-vscode.md | 2 +- .../codespaces/codespaces-machine-types.md | 2 +- .../publishing-template-codespaces.md | 2 +- .../codespaces/source-control-pull-request.md | 6 ++-- data/reusables/codespaces/source-control.md | 12 ++++---- .../codespaces/usage-report-download.md | 2 +- .../reusables/command-palette/open-palette.md | 2 +- .../reusables/command_line/start_ssh_agent.md | 2 +- .../copilot/differences-cfi-cfb-table.md | 2 +- .../reusables/copilot/type-function-header.md | 1 - .../dependabot/dependabot-alerts-filters.md | 4 +-- .../dependabot/private-registry-support.md | 2 +- ...ull-request-security-vs-version-updates.md | 2 +- .../dependabot/vulnerable-calls-beta.md | 2 +- .../about-dependency-submission.md | 2 +- .../desktop/authenticate-in-browser.md | 2 +- data/reusables/desktop/choose-a-theme.md | 2 +- data/reusables/desktop/fork-type-prompt.md | 2 +- data/reusables/desktop/history-tab.md | 2 +- .../desktop/mac-repository-settings-menu.md | 2 +- .../desktop/open-repository-settings.md | 10 +++---- data/reusables/desktop/push-origin.md | 2 +- .../reusables/desktop/select-fork-behavior.md | 2 +- .../desktop/windows-choose-options.md | 2 +- .../windows-repository-settings-menu.md | 2 +- .../discussion-category-forms-name.md | 2 +- data/reusables/education/benefits-page.md | 2 +- .../note-on-student-codespaces-usage.md | 2 +- .../emu-azure-admin-consent.md | 2 +- .../check-migration.md | 2 +- .../enterprise-migration-tool/edit-csv.md | 2 +- .../migration-destination-query.md | 2 +- .../reclaim-individual-mannequin.md | 2 +- .../running-your-migrations.md | 2 +- .../skip-releases.md | 2 +- .../enterprise-migration-tool/ssl-flag.md | 2 +- .../timeline-tasks.md | 2 +- .../enterprise/apply-configuration.md | 2 +- .../create-pgp-key-web-commit-signing.md | 4 +-- .../SAML-to-OIDC-migration-for-EMU.md | 2 +- data/reusables/files/add-file.md | 2 +- data/reusables/gated-features/codeql.md | 2 +- .../gated-features/dependabot-alerts.md | 10 +++---- .../dependabot-security-updates.md | 6 ++-- .../dependabot-version-updates.md | 6 ++-- .../enterprise_account_webhooks.md | 2 +- data/reusables/gated-features/packages.md | 4 +-- data/reusables/gpg/list-keys-with-note.md | 2 +- data/reusables/gpg/paste-gpg-key-id.md | 2 +- data/reusables/gpg/set-auto-sign.md | 2 +- .../about-editing-ip-allow-list-entries.md | 2 +- .../about-enabling-allowed-ip-addresses.md | 2 +- .../ip-allow-lists-enterprise.md | 2 +- .../org-enterprise-allow-list-interaction.md | 2 +- .../vigilant-mode-verification-statuses.md | 2 +- .../issue-events/label-properties.md | 2 +- .../issue-events/review-request-properties.md | 2 +- .../email-notification-caveats.md | 2 +- .../organizations/about-organizations.md | 2 +- .../team-discussions-migration.md | 2 +- .../package_registry/about-graphql-support.md | 2 +- ...uthenticate-to-container-registry-steps.md | 2 +- .../container-registry-ghes-beta.md | 2 +- .../pages/about-private-publishing.md | 2 +- data/reusables/pages/admin-must-push.md | 2 +- .../profile/navigating-to-profile.md | 2 +- data/reusables/projects/about-board-layout.md | 2 +- data/reusables/projects/about-table-layout.md | 2 +- data/reusables/projects/create-issue-modal.md | 4 +-- .../projects/enable-basic-workflow.md | 6 ++-- data/reusables/projects/graphql-ghes.md | 2 +- data/reusables/projects/projects-api.md | 2 +- .../rebase_and_merge_verification.md | 4 +-- .../scheduled-reminders-limitations.md | 2 +- .../repositories/create-ruleset-step.md | 2 +- .../repositories/fork-definition-long.md | 2 +- .../repositories/github-security-lab.md | 2 +- .../repositories/navigate-to-branches.md | 2 +- .../repositories/rulesets-metadata-step.md | 6 ++-- .../repositories/sidebar-dependabot-alerts.md | 2 +- data/reusables/saml/authentication-loop.md | 4 +-- data/reusables/search/code-view-link.md | 2 +- .../push-protection-command-line-choice.md | 2 +- .../push-protection-multiple-branch-note.md | 2 +- ...ility-reporting-configure-notifications.md | 2 +- ...rivate-vulnerability-reporting-overview.md | 2 +- ...erability-reporting-security-researcher.md | 2 +- data/reusables/sponsors/tier-details.md | 4 +-- data/reusables/stars/stars-page-navigation.md | 2 +- data/reusables/subversion/sunset.md | 2 +- data/reusables/support/view-open-tickets.md | 2 +- data/reusables/time_date/time_format.md | 2 +- .../two_fa/mandatory-2fa-contributors-2023.md | 2 +- .../access_authorized_oauth_apps.md | 2 +- .../user-settings/access_settings.md | 2 +- data/reusables/user-settings/deleted-repos.md | 2 +- .../user-settings/developer_settings.md | 2 +- data/reusables/user-settings/patv2-filters.md | 6 ++-- .../user-settings/review-oauth-apps.md | 2 +- .../user-settings/select_primary_email.md | 2 +- data/reusables/webhooks/public_short_desc.md | 2 +- 369 files changed, 642 insertions(+), 641 deletions(-) diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md index 5d77387cd798..033c17d4e9c8 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md @@ -33,7 +33,7 @@ The person you invite to be your successor must have a {% data variables.product {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.account_settings %} 3. Under "Successor settings", to invite a successor, begin typing a username, full name, or email address, then click their name when it appears. - + ![Screenshot of the "Successor settings" section. The string "octocat" is entered in a search field, and Octocat's profile is listed in a dropdown below.](/assets/images/help/settings/settings-invite-successor-search-field.png) 4. Click **Add successor**. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md index 167e178d2795..094567516439 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md @@ -19,7 +19,7 @@ shortTitle: Add an email address {% note %} -**Notes**: +**Notes**: - {% data reusables.user-settings.no-verification-disposable-emails %} - If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %}, you cannot make changes to your email address on {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.emu-more-info-account %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository.md index a953998725c6..7be313fcc775 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository.md @@ -52,7 +52,7 @@ The repository owner has full control of the repository. In addition to the acti | Archive the repository | "[AUTOTITLE](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt or ghec %} | Create security advisories | "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/about-repository-security-advisories)" | | Display a sponsor button | "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %} -| Allow or disallow auto-merge for pull requests | "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository)" | +| Allow or disallow auto-merge for pull requests | "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository)" | | Manage webhooks and deploy keys | "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys)" | ## Collaborator access for a repository owned by a personal account diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md index 74fc4e83934d..15f6ce1fbba0 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -12,7 +12,7 @@ shortTitle: Manage multiple accounts ## About management of multiple accounts -In some cases, you may need to use multiple accounts on {% data variables.location.product_location %}. For example, you may have a personal account for open source contributions, and your employer may also create and manage a user account for you within an enterprise. +In some cases, you may need to use multiple accounts on {% data variables.location.product_location %}. For example, you may have a personal account for open source contributions, and your employer may also create and manage a user account for you within an enterprise. You cannot use your {% data variables.enterprise.prodname_managed_user %} to contribute to public projects on {% data variables.location.product_location %}, so you must contribute to those resources using your personal account. For more information, see "[About {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}."{% endif %} @@ -28,7 +28,7 @@ If you aren't required to use a {% data variables.enterprise.prodname_managed_us ## Contributing to two accounts using HTTPS and SSH -If you contribute with two accounts from one workstation, you can access repositories by using a different protocol and credentials for each account. +If you contribute with two accounts from one workstation, you can access repositories by using a different protocol and credentials for each account. Git can use either the HTTPS or SSH protocol to access and update data in repositories on {% data variables.location.product_location %}. The protocol you use to clone a repository determines which credentials your workstation will use to authenticate when you access the repository. With this approach to account management, you store the credentials for one account to use for HTTPS connections and upload an SSH key to the other account to use for SSH connections. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-xamarin-applications.md b/content/actions/automating-builds-and-tests/building-and-testing-xamarin-applications.md index 510434659c13..908260dafe28 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-xamarin-applications.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-xamarin-applications.md @@ -108,5 +108,5 @@ jobs: ## Specifying a .NET version To use a preinstalled version of the .NET Core SDK on a {% data variables.product.prodname_dotcom %}-hosted runner, use the `setup-dotnet` action. This action finds a specific version of .NET from the tools cache on each runner, and adds the necessary binaries to `PATH`. These changes will persist for the remainder of the job. - + The `setup-dotnet` action is the recommended way of using .NET with {% data variables.product.prodname_actions %}, because it ensures consistent behavior across different runners and different versions of .NET. If you are using a self-hosted runner, you must install .NET and add it to `PATH`. For more information, see the [`setup-dotnet`](https://github.com/marketplace/actions/setup-net-core-sdk) action. diff --git a/content/actions/creating-actions/creating-a-javascript-action.md b/content/actions/creating-actions/creating-a-javascript-action.md index 569163bf21ab..025a91e79c53 100644 --- a/content/actions/creating-actions/creating-a-javascript-action.md +++ b/content/actions/creating-actions/creating-a-javascript-action.md @@ -211,7 +211,7 @@ Checking in your `node_modules` directory can cause problems. As an alternative, ## Testing out your action in a workflow -Now you're ready to test your action out in a workflow. +Now you're ready to test your action out in a workflow. Public actions can be used by workflows in any repository. When an action is in a private{% ifversion ghec or ghes or ghae%} or internal{% endif %} repository, the repository settings dictate whether the action is available only within the same repository or also to other repositories owned by the same {% ifversion ghec or ghes or ghae %}organization or enterprise{% else %}user or organization{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)." diff --git a/content/actions/creating-actions/developing-a-third-party-cli-action.md b/content/actions/creating-actions/developing-a-third-party-cli-action.md index e9e41c929a9e..afa557c4af56 100644 --- a/content/actions/creating-actions/developing-a-third-party-cli-action.md +++ b/content/actions/creating-actions/developing-a-third-party-cli-action.md @@ -23,7 +23,7 @@ Your action should: - Work across {% data variables.product.product_name %}-hosted and self-hosted runners - Leverage community tooling when possible -This article will demonstrate how to write an action that retrieves a specific version of your CLI, installs it, adds it to the path, and (optionally) caches it. This type of action (an action that sets up a tool) is often named `setup-$TOOL`. +This article will demonstrate how to write an action that retrieves a specific version of your CLI, installs it, adds it to the path, and (optionally) caches it. This type of action (an action that sets up a tool) is often named `setup-$TOOL`. ## Prerequisites diff --git a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index 8ec66f139c10..ca0715070eab 100644 --- a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -42,7 +42,7 @@ To draft a new release and publish the action to {% data variables.product.prodn 1. Under "Release Action", select **Publish this Action to the {% data variables.product.prodname_marketplace %}**. {% note %} - + **Note**: The "Publish" checkbox is disabled if the account that owns the repository has not yet accepted the {% data variables.product.prodname_marketplace %} Developer Agreement. If you own the repository or are an organization owner, click the link to "accept the GitHub Marketplace Developer Agreement", then accept the agreement. If there is no link, send the organization owner a link to this "Release Action" page and ask them to accept the agreement. {% endnote %} diff --git a/content/actions/creating-actions/sharing-actions-and-workflows-from-your-private-repository.md b/content/actions/creating-actions/sharing-actions-and-workflows-from-your-private-repository.md index 111b3b4cdde7..84296578ce88 100644 --- a/content/actions/creating-actions/sharing-actions-and-workflows-from-your-private-repository.md +++ b/content/actions/creating-actions/sharing-actions-and-workflows-from-your-private-repository.md @@ -12,13 +12,13 @@ shortTitle: Share from your private repository ## About {% data variables.product.prodname_actions %} access to private repositories -You can share actions and reusable workflows from your private repository, without making them public, by allowing {% data variables.product.prodname_actions %} workflows to access a private repository that contains the action or reusable workflow. +You can share actions and reusable workflows from your private repository, without making them public, by allowing {% data variables.product.prodname_actions %} workflows to access a private repository that contains the action or reusable workflow. Any actions or reusable workflows stored in the private repository can be used in workflows defined in other private repositories owned by the same organization or user. Actions and reusable workflows stored in private repositories cannot be used in public repositories. {% warning %} -**Warning**: +**Warning**: - If you make a private repository accessible to {% data variables.product.prodname_actions %} workflows in other repositories, outside collaborators on the other repositories can indirectly access the private repository, even though they do not have direct access to these repositories. The outside collaborators can view logs for workflow runs when actions or workflows from the private repository are used. - {% data reusables.actions.scoped-token-note %} diff --git a/content/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise.md b/content/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise.md index 6f8388304a0d..92f82bfd8259 100644 --- a/content/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise.md +++ b/content/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise.md @@ -12,13 +12,13 @@ shortTitle: Share with your enterprise ## About {% data variables.product.prodname_actions %} access to internal {% ifversion private-actions %}and private {% endif %}repositories -If your organization is owned by an enterprise account, you can share actions and reusable workflows within your enterprise, without publishing them publicly, by allowing {% data variables.product.prodname_actions %} workflows to access an internal {% ifversion private-actions %}or private {% endif %}repository that contains the action or reusable workflow. +If your organization is owned by an enterprise account, you can share actions and reusable workflows within your enterprise, without publishing them publicly, by allowing {% data variables.product.prodname_actions %} workflows to access an internal {% ifversion private-actions %}or private {% endif %}repository that contains the action or reusable workflow. Any actions or reusable workflows stored in the internal {% ifversion private-actions %}or private {% endif %}repository can be used in workflows defined in other internal or private repositories owned by the same organization, or by any organization owned by the enterprise. Actions and reusable workflows stored in internal repositories cannot be used in public repositories {% ifversion private-actions %}and actions and reusable workflows stored in private repositories cannot be used in public or internal repositories{% endif %}. {% warning %} -**Warning**: +**Warning**: - {% data reusables.actions.outside-collaborators-actions %} - {% data reusables.actions.scoped-token-note %} diff --git a/content/actions/creating-actions/sharing-actions-and-workflows-with-your-organization.md b/content/actions/creating-actions/sharing-actions-and-workflows-with-your-organization.md index a982aacb52b2..ba4e7d81ea97 100644 --- a/content/actions/creating-actions/sharing-actions-and-workflows-with-your-organization.md +++ b/content/actions/creating-actions/sharing-actions-and-workflows-with-your-organization.md @@ -12,13 +12,13 @@ shortTitle: Share with your organization ## About {% data variables.product.prodname_actions %} access to private {% ifversion internal-actions %} or internal {% endif %}repositories -You can share actions and reusable workflows within your organization, without publishing them publicly, by allowing {% data variables.product.prodname_actions %} workflows to access a private {% ifversion internal-actions %} or internal {% endif %}repository that contains the action or reusable workflow. +You can share actions and reusable workflows within your organization, without publishing them publicly, by allowing {% data variables.product.prodname_actions %} workflows to access a private {% ifversion internal-actions %} or internal {% endif %}repository that contains the action or reusable workflow. Any actions or reusable workflows stored in the private repository can be used in workflows defined in other private {% ifversion internal-actions %} or internal {% endif %}repositories owned by the same organization. Actions and reusable workflows stored in internal repositories cannot be used in public repositories {% ifversion private-actions %}and actions and reusable workflows stored in private repositories cannot be used in public or internal repositories{% endif %}. {% warning %} -**Warning**: +**Warning**: - {% data reusables.actions.outside-collaborators-actions %} - {% data reusables.actions.scoped-token-note %} diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md index 54dd23cff337..73e36e818c9d 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md @@ -134,6 +134,5 @@ The following resources may also be useful: - For the original starter workflow, see [`azure-webapps-node.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-node.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository. - The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. -- For more examples of GitHub Action workflows that deploy to Azure, see the -[actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. +- For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. - The "[Create a Node.js web app in Azure](https://docs.microsoft.com/azure/app-service/quickstart-nodejs)" quickstart in the Azure web app documentation demonstrates using {% data variables.product.prodname_vscode %} with the [Azure App Service extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice). diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md index 3bd2b42686f6..544e70e9e5f2 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md @@ -32,7 +32,7 @@ This guide explains how to use {% data variables.product.prodname_actions %} to Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps: -1. Create an Azure Static Web App using the 'Other' option for deployment source. For more information, see "[Quickstart: Building your first static site in the Azure portal](https://docs.microsoft.com/azure/static-web-apps/get-started-portal)" in the Azure documentation. +1. Create an Azure Static Web App using the 'Other' option for deployment source. For more information, see "[Quickstart: Building your first static site in the Azure portal](https://docs.microsoft.com/azure/static-web-apps/get-started-portal)" in the Azure documentation. 2. Create a secret called `AZURE_STATIC_WEB_APPS_API_TOKEN` with the value of your static web app deployment token. For more information about how to find your deployment token, see "[Reset deployment tokens in Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/deployment-token-management)" in the Azure documentation. diff --git a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md index d178341c141d..53bbdcfb9de7 100644 --- a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md +++ b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md @@ -15,7 +15,7 @@ topics: ## Overview -OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Amazon Web Services (AWS), without needing to store the AWS credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. +OpenID Connect (OIDC) allows your {% data variables.product.prodname_actions %} workflows to access resources in Amazon Web Services (AWS), without needing to store the AWS credentials as long-lived {% data variables.product.prodname_dotcom %} secrets. This guide explains how to configure AWS to trust {% data variables.product.prodname_dotcom %}'s OIDC as a federated identity, and includes a workflow example for the [`aws-actions/configure-aws-credentials`](https://github.com/aws-actions/configure-aws-credentials) that uses tokens to authenticate to AWS and access resources. diff --git a/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 2496748ccd9c..9870ef633877 100644 --- a/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -26,11 +26,11 @@ You should be familiar with the concepts described in "[AUTOTITLE](/actions/usin When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. The available options will vary depending on your cloud provider: -- **Using `job_workflow_ref`**: - - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. -- **Customizing the token claims**: +- **Customizing the token claims**: - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## How the token works with reusable workflows @@ -95,9 +95,9 @@ You can configure a custom claim that filters for any reusable workflow in a spe You can configure a custom claim that filters for a specific reusable workflow. In this example, the workflow run must have originated from a job defined in the reusable workflow `octo-org/octo-automation/.github/workflows/deployment.yml`, and in any repository that is owned by the `octo-org` organization. - **Subject**: - - Syntax: `repo:ORG_NAME/*` - - Example: `repo:octo-org/*` + - Syntax: `repo:ORG_NAME/*` + - Example: `repo:octo-org/*` - **Custom claim**: - - Syntax: `job_workflow_ref:ORG_NAME/REPO_NAME/.github/workflows/WORKFLOW_FILE@ref` + - Syntax: `job_workflow_ref:ORG_NAME/REPO_NAME/.github/workflows/WORKFLOW_FILE@ref` - Example: `job_workflow_ref:octo-org/octo-automation/.github/workflows/deployment.yml@ 10040c56a8c0253d69db7c1f26a0d227275512e2` diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md index b64d63b40a66..14a976a8815f 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md @@ -289,7 +289,7 @@ For more information about security hardening for self-hosted runners, see "[AUT ### Restricting the use of self-hosted runners -{% data reusables.actions.disable-selfhosted-runners-crossrefs %} +{% data reusables.actions.disable-selfhosted-runners-crossrefs %} {% endif %} diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners.md index 04229a48375c..24c27d1362f6 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners.md @@ -56,7 +56,7 @@ You can add self-hosted runners to a single repository. To add a self-hosted run {% note %} -**Note**: {% data reusables.actions.disable-selfhosted-runners-crossrefs %} +**Note**: {% data reusables.actions.disable-selfhosted-runners-crossrefs %} {% endnote %} diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md index 0421a37d0339..9277c18b4e11 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -24,7 +24,7 @@ shortTitle: Monitor & troubleshoot You may not be able to create a self-hosted runner for an organization-owned repository. -{% data reusables.actions.disable-selfhosted-runners-crossrefs %} +{% data reusables.actions.disable-selfhosted-runners-crossrefs %} {% endif %} diff --git a/content/actions/learn-github-actions/expressions.md b/content/actions/learn-github-actions/expressions.md index b56190b445a8..b7dd43e5d466 100644 --- a/content/actions/learn-github-actions/expressions.md +++ b/content/actions/learn-github-actions/expressions.md @@ -119,7 +119,7 @@ env: {% endraw %} In this example, we're using a ternary operator to set the value of the `MY_ENV_VAR` environment variable based on whether the {% data variables.product.prodname_dotcom %} reference is set to `refs/heads/main` or not. If it is, the variable is set to `value_for_main_branch`. Otherwise, it is set to `value_for_other_branches`. -It is important to note that the first value after the `&&` condition must be `truthy` otherwise the value after the `||` will always be returned. +It is important to note that the first value after the `&&` condition must be `truthy` otherwise the value after the `||` will always be returned. ## Functions @@ -317,7 +317,7 @@ steps: ### always -Causes the step to always execute, and returns `true`, even when canceled. The `always` expression is best used at the step level or on tasks that you expect to run even when a job is canceled. For example, you can use `always` to send logs even when a job is canceled. +Causes the step to always execute, and returns `true`, even when canceled. The `always` expression is best used at the step level or on tasks that you expect to run even when a job is canceled. For example, you can use `always` to send logs even when a job is canceled. {% note %} diff --git a/content/actions/managing-issues-and-pull-requests/scheduling-issue-creation.md b/content/actions/managing-issues-and-pull-requests/scheduling-issue-creation.md index 96342e4fdf55..20ae03fabb14 100644 --- a/content/actions/managing-issues-and-pull-requests/scheduling-issue-creation.md +++ b/content/actions/managing-issues-and-pull-requests/scheduling-issue-creation.md @@ -33,7 +33,7 @@ In the tutorial, you will first make a workflow file that uses the [`imjohnbo/is {% indented_data_reference reusables.actions.actions-not-certified-by-github-comment spaces=4 %} {% indented_data_reference reusables.actions.actions-use-sha-pinning-comment spaces=4 %} - + name: Weekly Team Sync on: schedule: diff --git a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md index aac92ba6121b..fb10ed4d05a7 100644 --- a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md @@ -23,9 +23,9 @@ By default, {% data variables.product.product_name %} stores build logs and arti {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} 1. In the "Artifacts" section, click the artifact you want to download. - + ![Screenshot of the "Artifacts" section of a workflow run. The name of an artifact generated by the run, "artifact," is highlighted with a dark orange outline.](/assets/images/help/repository/artifact-drop-down-updated.png) - + {% endwebui %} {% cli %} diff --git a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md index 353ec5952080..d4a93dbb4648 100644 --- a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md @@ -28,9 +28,9 @@ shortTitle: Remove workflow artifacts {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} 1. Under **Artifacts**, click {% octicon "trash" aria-label="Remove artifact ARTIFACT-NAME" %} next to the artifact you want to remove. - + ![Screenshot showing artifacts created during a workflow run. A trash can icon, used to remove an artifact, is outlined in dark orange.](/assets/images/help/repository/actions-delete-artifact-updated.png) - + ## Setting the retention period for an artifact Retention periods for artifacts and logs can be configured at the repository, organization, and enterprise level. For more information, see {% ifversion fpt or ghec or ghes %}"[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy)."{% elsif ghae %}"[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)," "[AUTOTITLE](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)," or "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-artifact-and-log-retention-in-your-enterprise)."{% endif %} diff --git a/content/actions/migrating-to-github-actions/automated-migrations/automating-migration-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/automating-migration-with-github-actions-importer.md index 64f124cdb088..36ec4568d10f 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/automating-migration-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/automating-migration-with-github-actions-importer.md @@ -166,7 +166,7 @@ For more information about setting up self-serve migrations with IssueOps, see t ## Using the {% data variables.product.prodname_actions_importer %} labs repository -The {% data variables.product.prodname_actions_importer %} labs repository contains platform-specific learning paths that teach you how to use {% data variables.product.prodname_actions_importer %} and how to approach migrations to {% data variables.product.prodname_actions %}. You can use this repository to learn how to use {% data variables.product.prodname_actions_importer %} to help plan, forecast, and automate your migration to {% data variables.product.prodname_actions %}. +The {% data variables.product.prodname_actions_importer %} labs repository contains platform-specific learning paths that teach you how to use {% data variables.product.prodname_actions_importer %} and how to approach migrations to {% data variables.product.prodname_actions %}. You can use this repository to learn how to use {% data variables.product.prodname_actions_importer %} to help plan, forecast, and automate your migration to {% data variables.product.prodname_actions %}. To learn more, see the [GitHub Actions Importer labs repository](https://github.com/actions/importer-labs/tree/main#readme). diff --git a/content/actions/migrating-to-github-actions/automated-migrations/extending-github-actions-importer-with-custom-transformers.md b/content/actions/migrating-to-github-actions/automated-migrations/extending-github-actions-importer-with-custom-transformers.md index da298db05246..2cd769fe368f 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/extending-github-actions-importer-with-custom-transformers.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/extending-github-actions-importer-with-custom-transformers.md @@ -26,7 +26,7 @@ shortTitle: 'Extending GitHub Actions Importer' ## Using custom transformers with {% data variables.product.prodname_actions_importer %} -A custom transformer contains mapping logic that {% data variables.product.prodname_actions_importer %} can use to transform your plugins, tasks, runner labels, or environment variables to work with {% data variables.product.prodname_actions %}. Custom transformers are written with a domain-specific language (DSL) built on top of Ruby, and are defined within a file with the `.rb` file extension. +A custom transformer contains mapping logic that {% data variables.product.prodname_actions_importer %} can use to transform your plugins, tasks, runner labels, or environment variables to work with {% data variables.product.prodname_actions %}. Custom transformers are written with a domain-specific language (DSL) built on top of Ruby, and are defined within a file with the `.rb` file extension. You can use the `--custom-transformers` CLI option to specify which custom transformer files to use with the `audit`, `dry-run`, and `migrate` commands. diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bamboo-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bamboo-with-github-actions-importer.md index c98b0748a68b..7933af4c42c8 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bamboo-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bamboo-with-github-actions-importer.md @@ -69,7 +69,7 @@ The `configure` CLI command is used to set required credentials and options for After creating the token, copy it and save it in a safe location for later use. 1. Create a Bamboo {% data variables.product.pat_generic %}. For more information, see [{% data variables.product.pat_generic_title_case_plural %}](https://confluence.atlassian.com/bamboo/personal-access-tokens-976779873.html) in the Bamboo documentation. - + Your token must have the following permissions, depending on which resources will be transformed. Resource Type | View | View Configuration | Edit @@ -173,7 +173,7 @@ Listed below are some key terms that can appear in the forecast report: - **Execution time** describes the amount of time a runner spent on a job. This metric can be used to help plan for the cost of {% data variables.product.prodname_dotcom %}-hosted runners. - This metric is correlated to how much you should expect to spend in {% data variables.product.prodname_actions %}. This will vary depending on the hardware used for these minutes. You can use the [{% data variables.product.prodname_actions %} pricing calculator](https://github.com/pricing/calculator) to estimate the costs. - **Queue time** metrics describe the amount of time a job spent waiting for a runner to be available to execute it. -- **Concurrent jobs** metrics describe the amount of jobs running at any given time. This metric can be used to +- **Concurrent jobs** metrics describe the amount of jobs running at any given time. This metric can be used to ## Perform a dry-run migration of a Bamboo pipeline @@ -181,7 +181,7 @@ You can use the `dry-run` command to convert a Bamboo pipeline to an equivalent ### Running a dry-run migration for a build plan -To perform a dry run of migrating your Bamboo build plan to {% data variables.product.prodname_actions %}, run the following command in your terminal, replacing `:my_plan_slug` with the plan's project and plan key in the format `-` (for example: `PAN-SCRIP`). +To perform a dry run of migrating your Bamboo build plan to {% data variables.product.prodname_actions %}, run the following command in your terminal, replacing `:my_plan_slug` with the plan's project and plan key in the format `-` (for example: `PAN-SCRIP`). ```shell gh actions-importer dry-run bamboo build --plan-slug :my_plan_slug --output-dir tmp/dry-run ``` @@ -308,7 +308,7 @@ gh actions-importer dry-run bamboo build --plan-slug IN-COM -o tmp/bamboo --conf The following table shows the type of properties that {% data variables.product.prodname_actions_importer %} is currently able to convert. | Bamboo | GitHub Actions | Status | -| :---------------------------------- | :-----------------------------------------------| ---------------------: | +| :---------------------------------- | :-----------------------------------------------| ---------------------: | | `environments` | `jobs` | Supported | | `environments.` | `jobs.` | Supported | | `.artifacts` | `jobs..steps.actions/upload-artifact` | Supported | diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md index 6b47d66e0bc9..e3e2e60e6f87 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md @@ -77,7 +77,7 @@ The `configure` CLI command is used to set required credentials and options for Enter the following values (leave empty to omit): ✔ {% data variables.product.pat_generic_caps %} for GitHub: *************** ✔ Base url of the GitHub instance: https://github.com - ✔ {% data variables.product.pat_generic_caps %} for Jenkins: *************** + ✔ {% data variables.product.pat_generic_caps %} for Jenkins: *************** ✔ Username of Jenkins user: admin ✔ Base url of the Jenkins instance: https://localhost Environment variables successfully updated. diff --git a/content/actions/publishing-packages/publishing-docker-images.md b/content/actions/publishing-packages/publishing-docker-images.md index 5c6007cef018..2ffb668ee295 100644 --- a/content/actions/publishing-packages/publishing-docker-images.md +++ b/content/actions/publishing-packages/publishing-docker-images.md @@ -136,6 +136,7 @@ The `metadata-action` option required for {% data variables.product.prodname_reg {% endif %} The `build-push-action` options required for {% data variables.product.prodname_registry %} are:{% ifversion fpt or ghec %} + - `context`: Defines the build's context as the set of files located in the specified path.{% endif %} - `push`: If set to `true`, the image will be pushed to the registry if it is built successfully.{% ifversion fpt or ghec %} - `tags` and `labels`: These are populated by output from `metadata-action`.{% else %} diff --git a/content/actions/quickstart.md b/content/actions/quickstart.md index a6bb61484ff1..2fe15f43fdfe 100644 --- a/content/actions/quickstart.md +++ b/content/actions/quickstart.md @@ -19,7 +19,7 @@ shortTitle: Quickstart ## Introduction -You only need a {% data variables.product.prodname_dotcom %} repository to create and run a {% data variables.product.prodname_actions %} workflow. In this guide, you'll add a workflow that demonstrates some of the essential features of {% data variables.product.prodname_actions %}. +You only need a {% data variables.product.prodname_dotcom %} repository to create and run a {% data variables.product.prodname_actions %} workflow. In this guide, you'll add a workflow that demonstrates some of the essential features of {% data variables.product.prodname_actions %}. The following example shows you how {% data variables.product.prodname_actions %} jobs can be automatically triggered, where they run, and how they can interact with the code in your repository. @@ -71,7 +71,7 @@ Committing the workflow file to a branch in your repository triggers the `push` 1. The log shows you how each of the steps was processed. Expand any of the steps to view its details. ![Screenshot of steps run by the workflow.](/assets/images/help/repository/actions-quickstart-logs.png) - + For example, you can see the list of files in your repository: ![Screenshot of the "List files in the repository" step expanded to show the log output. The output for the step is highlighted with a dark orange highlight.](/assets/images/help/repository/actions-quickstart-log-detail.png) diff --git a/content/actions/security-guides/security-hardening-for-github-actions.md b/content/actions/security-guides/security-hardening-for-github-actions.md index eea3fe8f36ef..f0f57bc961b1 100644 --- a/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/content/actions/security-guides/security-hardening-for-github-actions.md @@ -309,7 +309,7 @@ SBOMs are available for Ubuntu, Windows, and macOS runner images. You can locate {% ifversion actions-disable-repo-runners %} -{% data reusables.actions.disable-selfhosted-runners-crossrefs %} +{% data reusables.actions.disable-selfhosted-runners-crossrefs %} {% endif %} diff --git a/content/actions/using-containerized-services/about-service-containers.md b/content/actions/using-containerized-services/about-service-containers.md index 8caa40701db6..3a4c2a5a4fce 100644 --- a/content/actions/using-containerized-services/about-service-containers.md +++ b/content/actions/using-containerized-services/about-service-containers.md @@ -22,7 +22,7 @@ topics: Service containers are Docker containers that provide a simple and portable way for you to host services that you might need to test or operate your application in a workflow. For example, your workflow might need to run integration tests that require access to a database and memory cache. -You can configure service containers for each job in a workflow. {% data variables.product.prodname_dotcom %} creates a fresh Docker container for each service configured in the workflow, and destroys the service container when the job completes. Steps in a job can communicate with all service containers that are part of the same job. However, you cannot create and use service containers inside a composite action. +You can configure service containers for each job in a workflow. {% data variables.product.prodname_dotcom %} creates a fresh Docker container for each service configured in the workflow, and destroys the service container when the job completes. Steps in a job can communicate with all service containers that are part of the same job. However, you cannot create and use service containers inside a composite action. {% data reusables.actions.docker-container-os-support %} diff --git a/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md b/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md index ffedf0898a9b..4042227c3b5a 100644 --- a/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md @@ -12,7 +12,7 @@ shortTitle: Customize runners {% data reusables.actions.enterprise-github-hosted-runners %} -If you require additional software packages on {% data variables.product.prodname_dotcom %}-hosted runners, you can create a job that installs the packages as part of your workflow. +If you require additional software packages on {% data variables.product.prodname_dotcom %}-hosted runners, you can create a job that installs the packages as part of your workflow. To see which packages are already installed by default, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software)." @@ -40,7 +40,7 @@ jobs: {% note %} -**Note:** Always run `sudo apt-get update` before installing a package. In case the `apt` index is stale, this command fetches and re-indexes any available packages, which helps prevent package installation failures. +**Note:** Always run `sudo apt-get update` before installing a package. In case the `apt` index is stale, this command fetches and re-indexes any available packages, which helps prevent package installation failures. {% endnote %} diff --git a/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index e5b8684e1dc9..fb926f5a1f2a 100644 --- a/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -48,7 +48,7 @@ For more information on workflow run artifacts, see "[AUTOTITLE](/actions/using- ## Restrictions for accessing a cache -Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. Workflow runs can restore caches created in either the current branch or the default branch (usually `main`). If a workflow run is triggered for a pull request, it can also restore caches created in the base branch, including base branches of forked repositories. For example, if the branch `feature-b` has the base branch `feature-a`, a workflow run triggered on a pull request would have access to caches created in the default `main` branch, the base `feature-a` branch, and the current `feature-b` branch. Workflow runs cannot restore caches created for child branches or sibling branches. For example, a cache created for the child `feature-b` branch would not be accessible to a workflow run triggered on the parent `main` branch. Similarly, a cache created for the `feature-a` branch with the base `main` would not be accessible to its sibling `feature-c` branch with the base `main`. Workflow runs also cannot restore caches created for different tag names. For example, a cache created for the tag `release-a` with the base `main` would not be accessible to a workflow run triggered for the tag `release-b` with the base `main`. @@ -246,7 +246,7 @@ For example, if a pull request contains a `feature` branch and targets the defau ## Usage limits and eviction policy -{% data variables.product.prodname_dotcom %} will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited{% ifversion actions-cache-policy-apis %}. By default, the limit is 10 GB per repository, but this limit might be different depending on policies set by your enterprise owners or repository administrators.{% else %} to 10 GB.{% endif %} +{% data variables.product.prodname_dotcom %} will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited{% ifversion actions-cache-policy-apis %}. By default, the limit is 10 GB per repository, but this limit might be different depending on policies set by your enterprise owners or repository administrators.{% else %} to 10 GB.{% endif %} {% data reusables.actions.cache-eviction-process %} {% ifversion actions-cache-ui %}The cache eviction process may cause cache thrashing, where caches are created and deleted at a high frequency. To reduce this, you can review the caches for a repository and take corrective steps, such as removing caching from specific workflows. For more information, see "[Managing caches](#managing-caches)."{% endif %}{% ifversion actions-cache-admin-ui %} You can also increase the cache size limit for a repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-cache-storage-for-a-repository)." @@ -306,7 +306,7 @@ Users with `write` access to a repository can use the {% data variables.product. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.repositories.actions-cache-list %} -1. To the right of the cache entry you want to delete, click {% octicon "trash" aria-label="Delete cache" %}. +1. To the right of the cache entry you want to delete, click {% octicon "trash" aria-label="Delete cache" %}. ![Screenshot of the list of cache entries. A trash can icon, used to delete a cache, is highlighted with a dark orange outline.](/assets/images/help/repository/actions-cache-delete.png) @@ -318,7 +318,7 @@ Users with `write` access to a repository can use the {% data variables.product. ### Force deleting cache entries -Caches have branch scope restrictions in place, which means some caches have limited usage options. For more information on cache scope restrictions, see "[AUTOTITLE](/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache)." If caches limited to a specific branch are using a lot of storage quota, it may cause caches from the `default` branch to be created and deleted at a high frequency. +Caches have branch scope restrictions in place, which means some caches have limited usage options. For more information on cache scope restrictions, see "[AUTOTITLE](/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache)." If caches limited to a specific branch are using a lot of storage quota, it may cause caches from the `default` branch to be created and deleted at a high frequency. For example, a repository could have many new pull requests opened, each with their own caches that are restricted to that branch. These caches could take up the majority of the cache storage for that repository. Once a repository has reached its maximum cache storage, the cache eviction policy will create space by deleting the oldest caches in the repository. In order to prevent cache thrashing when this happens, you can set up workflows to delete caches on a faster cadence than the cache eviction policy will. You can use the [`gh-actions-cache`](https://github.com/actions/gh-actions-cache/) CLI extension to delete caches for specific branches. diff --git a/content/actions/using-workflows/events-that-trigger-workflows.md b/content/actions/using-workflows/events-that-trigger-workflows.md index 43ead6004c69..225836821078 100644 --- a/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/content/actions/using-workflows/events-that-trigger-workflows.md @@ -1154,7 +1154,7 @@ jobs: {% note %} -**Notes**: +**Notes**: - The maximum number of top-level properties in `client_payload` is 10. - The payload can contain a maximum of 65,535 characters. diff --git a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md index 0668057da774..391a961d2199 100644 --- a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md +++ b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md @@ -23,16 +23,16 @@ The instructions below assume that you need to set up {% data variables.product. - No internet access. - Access to limited internal resources, such as private registries for {% data variables.product.prodname_dependabot %}. -## Restricting internet access for {% data variables.product.prodname_dependabot %} runners +## Restricting internet access for {% data variables.product.prodname_dependabot %} runners Before configuring {% data variables.product.prodname_dependabot %}, install Docker on your self-hosted runner. For more information, see "[AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates#configuring-self-hosted-runners-for-dependabot-updates)." -1. On {% data variables.location.product_location %}, navigate to the `github/dependabot-action` repository and retrieve information about the `dependabot-updater` and `dependabot-proxy` container images from the `containers.json` file. +1. On {% data variables.location.product_location %}, navigate to the `github/dependabot-action` repository and retrieve information about the `dependabot-updater` and `dependabot-proxy` container images from the `containers.json` file. Each release of {% data variables.product.product_name %} includes an updated `containers.json` file at: `https://HOSTNAME/github/dependabot-action/blob/ghes-VERSION/docker/containers.json`. You can see the {% data variables.product.prodname_dotcom_the_website %} version of the file at: [containers.json](https://github.com/github/dependabot-action/blob/main/docker/containers.json). 1. Preload all the container images from the {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_container_registry %} onto the {% data variables.product.prodname_dependabot %} runner using the `docker pull` command. {% ifversion ghes > 3.8 %}Alternatively, preload the `dependabot-proxy` image and then preload only the container images for the ecosystems you require. - + For example, to support npm and {% data variables.product.prodname_actions %} you could use the following commands, copying details of the images to load from the `containers.json` file to ensure that you have the correct version and SHA for each image. ``` @@ -48,7 +48,7 @@ Before configuring {% data variables.product.prodname_dependabot %}, install Doc {% endnote %} -1. When you have finished adding these images to the runner, you are ready to restrict internet access to the {% data variables.product.prodname_dependabot %} runner, ensuring that it can still access your private registries for the required ecosystems and for {% data variables.location.product_location %}. +1. When you have finished adding these images to the runner, you are ready to restrict internet access to the {% data variables.product.prodname_dependabot %} runner, ensuring that it can still access your private registries for the required ecosystems and for {% data variables.location.product_location %}. You must add the images first because {% data variables.product.prodname_dependabot %} runners pull `dependabot-updater` and `dependabot-proxy` from the {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_container_registry %} when {% data variables.product.prodname_dependabot %} jobs start running. @@ -60,6 +60,6 @@ Before configuring {% data variables.product.prodname_dependabot %}, install Doc 1. For ecosystems that you want to test, click **Last checked TIME ago** to display the "Update logs" view. 1. Click **Check for updates** to check for new updates to dependencies for that ecosystem. -When the check for updates is complete, you should check the "Update logs" view to verify that {% data variables.product.prodname_dependabot %} accessed the configured private registries on {% data variables.location.product_location %} to check for version updates. +When the check for updates is complete, you should check the "Update logs" view to verify that {% data variables.product.prodname_dependabot %} accessed the configured private registries on {% data variables.location.product_location %} to check for version updates. After you have verified that the configuration is correct, ask repository administrators to update their {% data variables.product.prodname_dependabot %} configurations to use private registries only. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/removing-dependabot-access-to-public-registries)." diff --git a/content/admin/configuration/configuring-your-enterprise/about-enterprise-configuration.md b/content/admin/configuration/configuring-your-enterprise/about-enterprise-configuration.md index c98d055fde1b..eb32b8f39cbf 100644 --- a/content/admin/configuration/configuring-your-enterprise/about-enterprise-configuration.md +++ b/content/admin/configuration/configuring-your-enterprise/about-enterprise-configuration.md @@ -26,7 +26,7 @@ To get started with {% data variables.product.product_name %}, you first need to The first time you access your enterprise, you will complete an initial configuration to get {% data variables.product.product_name %} ready to use. The initial configuration includes connecting your enterprise with an identity provider (IdP), authenticating with SAML SSO, configuring policies for repositories and organizations in your enterprise, and configuring SMTP for outbound email. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." -Later, you can use the site admin dashboard and enterprise settings to further configure your enterprise, manage users, organizations and repositories, and set policies that reduce risk and increase quality. +Later, you can use the site admin dashboard and enterprise settings to further configure your enterprise, manage users, organizations and repositories, and set policies that reduce risk and increase quality. All enterprises are configured with subdomain isolation and support for TLS 1.2 and higher for encrypted traffic only. {% endif %} diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-applications.md b/content/admin/configuration/configuring-your-enterprise/configuring-applications.md index d4949c66fed8..888d7af1ccdd 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-applications.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-applications.md @@ -30,8 +30,8 @@ You can enable a retention policy for checks, actions, and associated data by se {% data reusables.enterprise_site_admin_settings.management-console %} 1. In the "Settings" sidebar, click **Checks**. 2. Select **Enable archiving of Checks-related data**. -3. Under "Archive threshold (days)", type the number of days for the archival threshold. Checks older than this number of days will be archived. -4. Under "Delete threshold (days)", type the number of days for the deletion threshold. Archived checks older than this number of days will be permanently deleted. +3. Under "Archive threshold (days)", type the number of days for the archival threshold. Checks older than this number of days will be archived. +4. Under "Delete threshold (days)", type the number of days for the deletion threshold. Archived checks older than this number of days will be permanently deleted. {% data reusables.enterprise_management_console.save-settings %} {% endif %} diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md b/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md index c2ecc1856084..e89b4ed7c7a2 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md @@ -100,7 +100,7 @@ Backup snapshots are written to the disk path set by the `GHE_DATA_DIR` data dir ```shell ./bin/ghe-host-check - ``` + ``` 1. To create an initial full backup, run the following command. ```shell @@ -244,7 +244,7 @@ Optionally, to validate the restore, configure an IP exception list to allow acc {% note %} -**Note:** +**Note:** - The network settings are excluded from the backup snapshot. You must manually configure the network on the target {% data variables.product.prodname_ghe_server %} appliance as required for your environment. diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing.md b/content/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing.md index 1db482419575..83df7becee00 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing.md @@ -39,11 +39,11 @@ You can enable web commit signing, rotate the private key used for web commit si ghe-config-apply ``` 1. Create a new user on {% data variables.location.product_location %} via built-in authentication or external authentication. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." - - The user's username must be the same username you used when creating the PGP key in step 1 above, for example, `web-flow`. - - The user's email address must be the same address you used when creating the PGP key. + - The user's username must be the same username you used when creating the PGP key in step 1 above, for example, `web-flow`. + - The user's email address must be the same address you used when creating the PGP key. {% data reusables.enterprise_site_admin_settings.add-key-to-web-flow-user %} {% data reusables.enterprise_site_admin_settings.email-settings %} -1. Under "No-reply email address", type the same email address you used when creating the PGP key. +1. Under "No-reply email address", type the same email address you used when creating the PGP key. {% note %} diff --git a/content/admin/configuration/configuring-your-enterprise/troubleshooting-tls-errors.md b/content/admin/configuration/configuring-your-enterprise/troubleshooting-tls-errors.md index f19a7e07fc81..290bdecdfca8 100644 --- a/content/admin/configuration/configuring-your-enterprise/troubleshooting-tls-errors.md +++ b/content/admin/configuration/configuring-your-enterprise/troubleshooting-tls-errors.md @@ -49,7 +49,7 @@ Otherwise, you can use the SSL Converter tool to convert your certificate into t ## Unresponsive installation after uploading a key -If {% data variables.location.product_location %} is unresponsive after uploading an TLS key, please [contact {% data variables.product.prodname_enterprise %} Support](https://enterprise.github.com/support) with specific details, including a copy of your TLS certificate. Ensure that your private key **is not** included. +If {% data variables.location.product_location %} is unresponsive after uploading an TLS key, please [contact {% data variables.product.prodname_enterprise %} Support](https://enterprise.github.com/support) with specific details, including a copy of your TLS certificate. Ensure that your private key **is not** included. ## Certificate validity errors diff --git a/content/admin/enterprise-management/caching-repositories/about-repository-caching.md b/content/admin/enterprise-management/caching-repositories/about-repository-caching.md index 8df30914fedd..af3829eab175 100644 --- a/content/admin/enterprise-management/caching-repositories/about-repository-caching.md +++ b/content/admin/enterprise-management/caching-repositories/about-repository-caching.md @@ -10,7 +10,7 @@ topics: {% data reusables.enterprise.repository-caching-release-phase %} -If you have teams and CI farms located around the world, you may experience reduced performance on your primary {% data variables.product.prodname_ghe_server %} instance. While active geo-replicas can improve the performance of read requests, this comes at the cost of limiting write throughput. To reduce load on your primary instance and improve write throughput performance, you can configure a repository cache, an asynchronous read-only mirror of repositories located near these geographically-distributed clients. +If you have teams and CI farms located around the world, you may experience reduced performance on your primary {% data variables.product.prodname_ghe_server %} instance. While active geo-replicas can improve the performance of read requests, this comes at the cost of limiting write throughput. To reduce load on your primary instance and improve write throughput performance, you can configure a repository cache, an asynchronous read-only mirror of repositories located near these geographically-distributed clients. A repository cache eliminates the need for {% data variables.product.product_name %} to transmit the same Git data over a long-haul network link multiple times to serve multiple clients, by serving your repository data close to CI farms and distributed teams. For instance, if your primary instance is in North America and you also have a large presence in Asia, you will benefit from setting up the repository cache in Asia for use by CI runners there. diff --git a/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md b/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md index 2377275b79db..1f03df99bddd 100644 --- a/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md +++ b/content/admin/enterprise-management/configuring-clustering/about-cluster-nodes.md @@ -15,7 +15,7 @@ topics: --- ## About {% data variables.product.product_name %} cluster nodes -Each node in a {% data variables.product.product_name %} cluster is a virtual machine (VM) that runs the {% data variables.product.product_name %} software. Before you deploy a cluster, you can review hardware requirements, required services, and design recommendations. +Each node in a {% data variables.product.product_name %} cluster is a virtual machine (VM) that runs the {% data variables.product.product_name %} software. Before you deploy a cluster, you can review hardware requirements, required services, and design recommendations. {% data reusables.enterprise_clustering.clustering-requires-https %} @@ -31,7 +31,7 @@ Each node must have a root volume, as well as a separate data volume. These are ## Services required for clustering -{% data variables.product.prodname_ghe_server %} comprises a set of services. In a cluster, these services run across multiple nodes, and the instance balances requests between the nodes. The instance automatically stores redundant copies of data on separate nodes. Most services are equal peers with other instances of the same service. The exceptions to this distribution are the `mysql-server` and `redis-server` services, which operate with a single primary node with one or more replica nodes. +{% data variables.product.prodname_ghe_server %} comprises a set of services. In a cluster, these services run across multiple nodes, and the instance balances requests between the nodes. The instance automatically stores redundant copies of data on separate nodes. Most services are equal peers with other instances of the same service. The exceptions to this distribution are the `mysql-server` and `redis-server` services, which operate with a single primary node with one or more replica nodes. For adequate redundancy, use these minimum nodes operating each service. diff --git a/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster-nodes-with-node-eligibility-service.md b/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster-nodes-with-node-eligibility-service.md index f3a3b0cf9417..458fe1b65349 100644 --- a/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster-nodes-with-node-eligibility-service.md +++ b/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster-nodes-with-node-eligibility-service.md @@ -68,7 +68,7 @@ By default, {% data variables.product.prodname_nes %} is disabled. You can enabl nomad status nes ``` -## Configuring TTL settings for {% data variables.product.prodname_nes %} +## Configuring TTL settings for {% data variables.product.prodname_nes %} To determine how {% data variables.product.prodname_nes %} notifies you, you can configure TTL settings for `fail` and `warn` states. The TTL for the `fail` state must be higher than the TTL for the `warn` state. @@ -137,7 +137,7 @@ After {% data variables.product.prodname_nes %} detects that a node has exceeded ```shell copy nomad node status ``` - + - If the node's status is `ineligible`, make the node eligible by connecting to the node via SSH and running the following command. ```shell copy @@ -165,14 +165,14 @@ You can view logs for {% data variables.product.prodname_nes %} from any node in nomad alloc logs -job nes ``` 1. Alternatively, you can view logs for {% data variables.product.prodname_nes %} on the node that runs the service. The service writes logs to the systemd journal. - + - To determine which node runs {% data variables.product.prodname_nes %}, run the following command. ```shell copy nomad job status "nes" | grep running | grep "${nomad_node_id}" | awk 'NR==2{ print $1 }' | xargs nomad alloc status | grep "Node Name" ``` - To view logs on the node, connect to the node via SSH, then run the following command. - + ```shell copy journalctl -t nes ``` diff --git a/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md b/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md index 312e69762f3f..39679a125b0f 100644 --- a/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md +++ b/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md @@ -29,12 +29,12 @@ The time required to failover depends on how long it takes to manually promote t $ ghe-maintenance -s ``` - - When the number of active Git operations, MySQL queries, and Resque jobs reaches zero, wait 30 seconds. + - When the number of active Git operations, MySQL queries, and Resque jobs reaches zero, wait 30 seconds. {% note %} **Note:** Nomad will always have jobs running, even in maintenance mode, so you can safely ignore these jobs. - + {% endnote %} - To verify all replication channels report `OK`, use the `ghe-repl-status -vv` command. diff --git a/content/admin/enterprise-management/configuring-high-availability/monitoring-a-high-availability-configuration.md b/content/admin/enterprise-management/configuring-high-availability/monitoring-a-high-availability-configuration.md index 962b51b74e54..0c4cb22ab513 100644 --- a/content/admin/enterprise-management/configuring-high-availability/monitoring-a-high-availability-configuration.md +++ b/content/admin/enterprise-management/configuring-high-availability/monitoring-a-high-availability-configuration.md @@ -69,7 +69,7 @@ Replication requires that the primary node and all replica nodes can communicate ### Under-replication -If you run the `ghe-repl-status` command-line utility on a replica node and Git repositories, repository networks, or storage objects are under-replicated, one or more replica nodes are not fully synchronized with the primary node. Under-replication may occur if the primary node is unable to communicate with the replica nodes, or if the replica nodes are unable to communicate with the primary node. +If you run the `ghe-repl-status` command-line utility on a replica node and Git repositories, repository networks, or storage objects are under-replicated, one or more replica nodes are not fully synchronized with the primary node. Under-replication may occur if the primary node is unable to communicate with the replica nodes, or if the replica nodes are unable to communicate with the primary node. If you've recently configured high availability or geo-replication, the initial sync will take some time. The duration of the initial sync depends on how much data exists and network conditions. @@ -110,7 +110,7 @@ ghe-storage info OID ### Getting support from {% data variables.product.company_short %} -If you review the troubleshooting advice for replication and continue to experience issues on your instance, collect the following information, then contact {% data variables.contact.contact_ent_support %}. +If you review the troubleshooting advice for replication and continue to experience issues on your instance, collect the following information, then contact {% data variables.contact.contact_ent_support %}. - On each affected node, run `ghe-repl-status -vv`, then copy the output to your ticket. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-repl-status)." - On each affected node, create a support bundle to attach to your ticket. For more information, see "[AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)." diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md index eabb7b8ac35f..61c78d697d37 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md @@ -77,7 +77,7 @@ As more users join {% data variables.location.product_location %}, you may need ```shell $ ghe-repl-stop ``` - + 1. To install the {% data variables.product.prodname_ghe_server %} software on the newly partitioned disk, run the `ghe-upgrade` command. You must replace **PACKAGE-NAME.pkg** with the path to a platform-specific upgrade package that matches the version of {% data variables.product.prodname_ghe_server %} already running on the appliance. You cannot use a universal hotpatch upgrade package, such as `github-enterprise-2.11.9.hpkg`. After the `ghe-upgrade` command completes, application services will automatically terminate. ```shell diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance.md index b2b68450114c..0eb52380ce90 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance.md @@ -84,7 +84,7 @@ The following instructions are only intended for {% data variables.product.prod {% data reusables.enterprise_installation.ssh-into-instance %} 1. To validate the current flushing method for InnoDB, run the following command. - + ```shell copy ghe-config mysql.innodb-flush-no-fsync ``` @@ -101,7 +101,7 @@ The following instructions are only intended for {% data variables.product.prod You can reduce pending operations, increase IOPS, and improve performance by provisioning faster storage for your instance's nodes. To upgrade your instance's storage, back up your instance and restore the backup to a new replacement instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)." -### Sharing data with {% data variables.product.company_short %} +### Sharing data with {% data variables.product.company_short %} Finally, if you're willing to help {% data variables.product.company_short %} understand the real-world impact of the upgrade to MySQL 8, you can provide the data you've collected to {% data variables.contact.github_support %}. Provide the baseline and post-upgrade observations from the monitor dashboard, along with a support bundle that covers the period when you collected data. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-github-support)" and "[AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support)." diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md index 59452bfe5422..d44ae04226be 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md @@ -30,7 +30,7 @@ topics: - Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} - Use a staging instance to test the upgrade steps. For more information, see "[AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)." - When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete. -- Take a snapshot before upgrading your virtual machine. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#taking-a-snapshot)." +- Take a snapshot before upgrading your virtual machine. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#taking-a-snapshot)." - Ensure you have a recent, successful backup of your instance. For more information, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README.md file](https://github.com/github/backup-utils#readme). ## Requirements diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index fee9e82f851f..784dd4e83922 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -149,7 +149,7 @@ If the upgrade target you're presented with is a feature release instead of a pa admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg *** verifying upgrade package signature... ``` -1. If at least one service or system component requires a reboot, the hotpatch upgrade script notifies you. For example, updates to the kernel, MySQL, or Elasticsearch may require a reboot. +1. If at least one service or system component requires a reboot, the hotpatch upgrade script notifies you. For example, updates to the kernel, MySQL, or Elasticsearch may require a reboot. ### Upgrading an instance with multiple nodes using a hotpatch diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md index 5f8fff4effea..ed548de961d5 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions.md @@ -60,7 +60,7 @@ Determine the migration approach that will work best for your enterprise. Smalle We recommend an iterative approach that combines active management with self service. Start with a small group of early adopters that can act as your internal champions. Identify a handful of workflows that are comprehensive enough to represent the breadth of your business. Work with your early adopters to migrate those workflows to {% data variables.product.prodname_actions %}, iterating as needed. This will give other teams confidence that their workflows can be migrated, too. -Then, make {% data variables.product.prodname_actions %} available to your larger organization. Provide resources to help these teams migrate their own workflows to {% data variables.product.prodname_actions %}, and inform the teams when the existing systems will be retired. +Then, make {% data variables.product.prodname_actions %} available to your larger organization. Provide resources to help these teams migrate their own workflows to {% data variables.product.prodname_actions %}, and inform the teams when the existing systems will be retired. Finally, inform any teams that are still using your old systems to complete their migrations within a specific timeframe. You can point to the successes of other teams to reassure them that migration is possible and desirable. diff --git a/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md b/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md index 1855293652f3..184817358323 100644 --- a/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md +++ b/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md @@ -22,7 +22,7 @@ shortTitle: About actions in your enterprise {% data variables.product.prodname_actions %} workflows can use _actions_, which are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. -{% data reusables.actions.enterprise-no-internet-actions %} You can restrict your developers to using actions that are stored on {% data variables.location.product_location %}, which includes most official {% data variables.product.company_short %}-authored actions, as well as any actions your developers create. Alternatively, to allow your developers to benefit from the full ecosystem of actions built by industry leaders and the open source community, you can configure access to other actions from {% data variables.product.prodname_dotcom_the_website %}. +{% data reusables.actions.enterprise-no-internet-actions %} You can restrict your developers to using actions that are stored on {% data variables.location.product_location %}, which includes most official {% data variables.product.company_short %}-authored actions, as well as any actions your developers create. Alternatively, to allow your developers to benefit from the full ecosystem of actions built by industry leaders and the open source community, you can configure access to other actions from {% data variables.product.prodname_dotcom_the_website %}. We recommend allowing automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. {% ifversion ghes %}However, this does require {% data variables.product.product_name %} to make outbound connections to {% data variables.product.prodname_dotcom_the_website %}. If you don't want to allow these connections, or{% else %}If{% endif %} you want to have greater control over which actions are used on your enterprise, you can manually sync specific actions from {% data variables.product.prodname_dotcom_the_website %}. @@ -45,7 +45,7 @@ Each action is a repository in the `actions` organization, and each action repos {% note %} -**Notes:** +**Notes:** - When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.product_name %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)." - When {% data variables.product.product_name %} is updated, bundled actions are automatically replaced with default versions in the upgrade package. @@ -55,7 +55,7 @@ Each action is a repository in the `actions` organization, and each action repos {% data reusables.actions.access-actions-on-dotcom %} -The recommended approach is to enable automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)". +The recommended approach is to enable automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)". {% ifversion ghes %} {% note %} diff --git a/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md b/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md index 53aa95ac5838..1e0d147ffb75 100644 --- a/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md +++ b/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md @@ -34,7 +34,7 @@ The `actions-sync` tool can only download actions from {% data variables.product {% note %} -**Note:** The `actions-sync` tool is intended for use in systems where {% data variables.product.prodname_github_connect %} is not enabled. If you run the tool on a system with {% data variables.product.prodname_github_connect %} enabled, you may see the error `The repository has been retired and cannot be reused`. This indicates that a workflow has used that action directly on {% data variables.product.prodname_dotcom_the_website %} and the namespace is retired on {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)." +**Note:** The `actions-sync` tool is intended for use in systems where {% data variables.product.prodname_github_connect %} is not enabled. If you run the tool on a system with {% data variables.product.prodname_github_connect %} enabled, you may see the error `The repository has been retired and cannot be reused`. This indicates that a workflow has used that action directly on {% data variables.product.prodname_dotcom_the_website %} and the namespace is retired on {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect#automatic-retirement-of-namespaces-for-actions-accessed-on-githubcom)." {% endnote %} @@ -84,12 +84,12 @@ This example demonstrates using the `actions-sync` tool to sync an individual ac - `--destination-token`: A {% data variables.product.pat_generic %} for the destination enterprise instance. - `--destination-url`: The URL of the destination enterprise instance. - `--repo-name`: The action repository to sync. This takes the format of `owner/repository:destination_owner/destination_repository`. - + - The above example syncs the [`actions/stale`](https://github.com/actions/stale) repository to the `synced-actions/actions-stale` repository on the destination enterprise instance. You must create the organization named `synced-actions` in your enterprise before running the above command. - If you omit `:destination_owner/destination_repository`, the tool uses the original owner and repository name for your enterprise. Before running the command, you must create a new organization in your enterprise that matches the owner name of the action. Consider using a central organization to store the synced actions in your enterprise, as this means you will not need to create multiple new organizations if you sync actions from different owners. - You can sync multiple actions by replacing the `--repo-name` parameter with `--repo-name-list` or `--repo-name-list-file`. For more information, see the [`actions-sync` README](https://github.com/actions/actions-sync#actions-sync). 1. After the action repository is created in your enterprise, people in your enterprise can use the destination repository to reference the action in their workflows. For the example action shown above: - + ```yaml uses: synced-actions/actions-stale@v1 ``` diff --git a/content/admin/github-actions/using-github-actions-in-github-ae/using-actions-in-github-ae.md b/content/admin/github-actions/using-github-actions-in-github-ae/using-actions-in-github-ae.md index 5228957db100..ab9d008f0345 100644 --- a/content/admin/github-actions/using-github-actions-in-github-ae/using-actions-in-github-ae.md +++ b/content/admin/github-actions/using-github-actions-in-github-ae/using-actions-in-github-ae.md @@ -19,7 +19,7 @@ shortTitle: Use actions Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.prodname_ghe_managed %}, and are captured at a point in time from {% data variables.product.prodname_marketplace %}. When your {% data variables.product.prodname_ghe_managed %} instance is updated, the bundled official actions are also updated. -The bundled official actions include `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, and various `actions/setup-` actions, among others. To see which of the official actions are included, browse to the following organizations on your instance: +The bundled official actions include `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, and various `actions/setup-` actions, among others. To see which of the official actions are included, browse to the following organizations on your instance: - https://HOSTNAME/actions - https://HOSTNAME/github diff --git a/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md b/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md index 841c95ca62d7..2ab39b86721e 100644 --- a/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md +++ b/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md @@ -37,7 +37,7 @@ When a configuration error or an issue with your identity provider IdP prevents Azure AD will retry SCIM provisioning attempts automatically during the next Azure AD sync cycle. The default SCIM provisioning interval for Azure AD is 40 minutes. For more information about this retry behavior, see the [Microsoft documentation](https://learn.microsoft.com/en-us/azure/active-directory/app-provisioning/how-provisioning-works#errors-and-retries) or contact Azure support if you need additional assistance. -Okta will retry failed SCIM provisioning attempts with manual Okta admin intervention. For more information about how an Okta admin can retry a failed task for a specific application, see the [Okta documentation](https://support.okta.com/help/s/article/How-to-retry-failed-tasks-for-a-specific-application?language=en_US) or contact Okta support if you need additional assistance. +Okta will retry failed SCIM provisioning attempts with manual Okta admin intervention. For more information about how an Okta admin can retry a failed task for a specific application, see the [Okta documentation](https://support.okta.com/help/s/article/How-to-retry-failed-tasks-for-a-specific-application?language=en_US) or contact Okta support if you need additional assistance. {% endif %} ## SAML authentication errors diff --git a/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/accessing-your-enterprise-account-if-your-identity-provider-is-unavailable.md b/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/accessing-your-enterprise-account-if-your-identity-provider-is-unavailable.md index 879405b38fe0..3434048de6b4 100644 --- a/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/accessing-your-enterprise-account-if-your-identity-provider-is-unavailable.md +++ b/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/accessing-your-enterprise-account-if-your-identity-provider-is-unavailable.md @@ -13,7 +13,7 @@ topics: permissions: Enterprise owners can use a recovery code to access an enterprise account. --- -You can use a recovery code to access your enterprise account when an authentication configuration error or an issue with your identity provider (IdP) prevents you from using SSO. +You can use a recovery code to access your enterprise account when an authentication configuration error or an issue with your identity provider (IdP) prevents you from using SSO. In order to access your enterprise account this way, you must have previously downloaded and stored the recovery codes for your enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)." diff --git a/content/admin/identity-and-access-management/using-built-in-authentication/inviting-people-to-use-your-instance.md b/content/admin/identity-and-access-management/using-built-in-authentication/inviting-people-to-use-your-instance.md index 94e4a5e2a0e1..6a6d8571b80a 100644 --- a/content/admin/identity-and-access-management/using-built-in-authentication/inviting-people-to-use-your-instance.md +++ b/content/admin/identity-and-access-management/using-built-in-authentication/inviting-people-to-use-your-instance.md @@ -19,7 +19,7 @@ shortTitle: Invite people You can disable unauthenticated sign-ups and require an invitation to create a new user account on your instance. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-built-in-authentication/disabling-unauthenticated-sign-ups)." -{% data reusables.enterprise_user_management.alternatively-enable-external-authentication %} +{% data reusables.enterprise_user_management.alternatively-enable-external-authentication %} ## Inviting people to create a user account diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md index 4d45c63e01b9..ea27ea81873f 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md @@ -30,7 +30,7 @@ For more information about using OIDC with {% data variables.product.prodname_em ### {% data variables.product.prodname_actions %} -Actions that use a {% data variables.product.pat_generic %} will likely be blocked by your IdP's CAP. We recommend that {% data variables.product.pat_generic %}s are created by a service account which is then exempted from IP controls in your IdP's CAP. +Actions that use a {% data variables.product.pat_generic %} will likely be blocked by your IdP's CAP. We recommend that {% data variables.product.pat_generic %}s are created by a service account which is then exempted from IP controls in your IdP's CAP. If you're unable to use a service account, another option for unblocking actions that use {% data variables.product.pat_generic %}s is to allow the IP ranges used by {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses)." @@ -38,12 +38,12 @@ If you're unable to use a service account, another option for unblocking actions {% data variables.product.prodname_github_codespaces %} may not be available if your enterprise uses OIDC SSO with CAP to restrict access by IP addresses. This is because codespaces are created with dynamic IP addresses which it's likely your IdP’s CAP will block. Other CAP policies may also affect {% data variables.product.prodname_github_codespaces %}'s availability, depending on the policy's specific setup. -### {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} +### {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} -When {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} sign a user in and make requests on that user's behalf, {% data variables.product.prodname_dotcom %} will send the IP address of the app's server to your IdP for validation. If the IP address of the app's server is not validated by your IdP's CAP, the request will fail. +When {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} sign a user in and make requests on that user's behalf, {% data variables.product.prodname_dotcom %} will send the IP address of the app's server to your IdP for validation. If the IP address of the app's server is not validated by your IdP's CAP, the request will fail. When {% data variables.product.prodname_github_apps %} call {% data variables.product.prodname_dotcom %} APIs acting either as the app itself or as an installation, these calls are not performed on behalf of a user. Since your IdP's CAP executes and applies policies to user accounts, these application requests cannot be validated against CAP and are always allowed through. For more information on {% data variables.product.prodname_github_apps %} authenticating as themselves or as an installation, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)". -You can contact the owners of the apps you want to use, ask for their IP ranges, and configure your IdP's CAP to allow access from those IP ranges. If you're unable to contact the owners, you can review your IdP sign-in logs to review the IP addresses seen in the requests, then allow-list those addresses. +You can contact the owners of the apps you want to use, ask for their IP ranges, and configure your IdP's CAP to allow access from those IP ranges. If you're unable to contact the owners, you can review your IdP sign-in logs to review the IP addresses seen in the requests, then allow-list those addresses. If you do not wish to allow all of the IP ranges for all of your enterprise's apps, you can also exempt installed {% data variables.product.prodname_github_apps %} and authorized {% data variables.product.prodname_oauth_apps %} from the IdP allow list. If you do so, these apps will continue working regardless of the originating IP address. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#allowing-access-by-github-apps)." diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users.md index bca2adb0827d..5e4ec91b1931 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users.md @@ -60,9 +60,9 @@ To configure your IdP, follow the instructions they provide for configuring the - [{% data variables.product.prodname_emu_idp_application %} application on Azure Active Directory](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/aad.githubenterprisemanageduser?tab=Overview) - [{% data variables.product.prodname_emu_idp_application %} application on Okta](https://www.okta.com/integrations/github-enterprise-managed-user) - [{% data variables.product.prodname_emu_idp_application %} connector on PingFederate](https://www.pingidentity.com/en/resources/downloads/pingfederate.html) (public beta) - + To download the PingFederate connector, navigate to the **Add-ons** tab and select **GitHub EMU Connector 1.0**. - + {% indented_data_reference reusables.enterprise-accounts.public-beta-pingfed-for-emu spaces=3 %} 2. To configure the {% data variables.product.prodname_emu_idp_application %} application and your IdP, click the link below and follow the instructions provided by your IdP: diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md index fd413dd9cdf0..ef973871177e 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md @@ -17,7 +17,7 @@ topics: ## About provisioning for {% data variables.product.prodname_emus %} -You must configure provisioning for {% data variables.product.prodname_emus %} to create, manage, and deactivate user accounts for your enterprise members. +You must configure provisioning for {% data variables.product.prodname_emus %} to create, manage, and deactivate user accounts for your enterprise members. After you configure provisioning for {% data variables.product.prodname_emus %}, users assigned to the {% data variables.product.prodname_emu_idp_application %} application in your identity provider are provisioned as new {% data variables.enterprise.prodname_managed_users %} on {% data variables.product.prodname_dotcom %} via SCIM, and the {% data variables.enterprise.prodname_managed_users %} are added to your enterprise. If you assign a group to the application, all users within the group will be provisioned as new {% data variables.enterprise.prodname_managed_users %}. @@ -59,7 +59,7 @@ To configure provisioning for your {% data variables.enterprise.prodname_emu_ent ## Configuring provisioning for {% data variables.product.prodname_emus %} -After creating your {% data variables.product.pat_generic %} and storing it securely, you can configure provisioning on your identity provider. +After creating your {% data variables.product.pat_generic %} and storing it securely, you can configure provisioning on your identity provider. {% data reusables.scim.emu-scim-rate-limit %} diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-your-enterprise-to-a-new-identity-provider-or-tenant.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-your-enterprise-to-a-new-identity-provider-or-tenant.md index 798bce64af0b..c16b586c1866 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-your-enterprise-to-a-new-identity-provider-or-tenant.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-your-enterprise-to-a-new-identity-provider-or-tenant.md @@ -43,15 +43,15 @@ To migrate to a new IdP or tenant, you cannot edit your existing SAML configurat 1. Deactivate SAML for the {% data variables.enterprise.prodname_emu_enterprise %}. - From your profile, click **Your enterprises**, and then click the appropriate enterprise. - - Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**, and then click **Authentication security**. - - Under "SAML single sign-on", deselect **Require SAML authentication**, and then click **Save**. - + - Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**, and then click **Authentication security**. + - Under "SAML single sign-on", deselect **Require SAML authentication**, and then click **Save**. + 1. Wait for all users in the enterprise to show as suspended. 1. While still signed in as the setup user, configure SAML and SCIM for the new IdP or tenant with a new {% data variables.product.prodname_emus %} application. - + After you configure provisioning for the new application, the {% data variables.enterprise.prodname_managed_users %} will be unsuspended, and your developers will be able to sign into their existing accounts again. - + By default, this process can take up to 40 minutes for Azure AD. To expedite the process for an individual user, click the **Provision on Demand** button in the "Provisioning" tab of the application for {% data variables.product.prodname_emus %}. ## Migrating when the normalized SCIM `userName` values will change diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index 394fbef832c3..6ca897fe0282 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -69,7 +69,7 @@ In your Azure AD tenant, add the application for {% data variables.product.produ {% endif %} -## Managing enterprise owners +## Managing enterprise owners The steps to make a person an enterprise owner depend on whether you only use SAML or also use SCIM. For more information about enterprise owners, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)." diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md index c65c85c88819..9bd951394fdb 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md @@ -151,7 +151,7 @@ After you enable SCIM on a {% data variables.product.product_name %} instance, a --header 'Content-Type: application/scim' \ --header 'Authorization: Bearer $GHES_PAT' ``` - + The command should return an empty array. {%- endif %} {%- ifversion ghae %} diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md index 15285c420aba..10126535c687 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md @@ -20,13 +20,13 @@ redirect_from: {% data reusables.saml.dotcom-saml-explanation %} {% data reusables.saml.about-saml-enterprise-accounts %} -{% data reusables.saml.switching-from-org-to-enterprise %} +{% data reusables.saml.switching-from-org-to-enterprise %} When you configure SAML SSO at the organization level, each organization must be configured with a unique SSO tenant in your IdP, which means that your members will be associated with a unique SAML identity record for each organization they have successfully authenticated with. If you configure SAML SSO for your enterprise account instead, each enterprise member will have one SAML identity that is used for all organizations owned by the enterprise account. After you configure SAML SSO for your enterprise account, the new configuration will override any existing SAML SSO configurations for organizations owned by the enterprise account. -Enterprise members will not be notified when an enterprise owner enables SAML for the enterprise account. If SAML SSO was previously enforced at the organization level, members should not see a major difference when navigating directly to organization resources. The members will continue to be prompted to authenticate via SAML. If members navigate to organization resources via their IdP dashboard, they will need to click the new tile for the enterprise-level app, instead of the old tile for the organization-level app. The members will then be able to choose the organization to navigate to. +Enterprise members will not be notified when an enterprise owner enables SAML for the enterprise account. If SAML SSO was previously enforced at the organization level, members should not see a major difference when navigating directly to organization resources. The members will continue to be prompted to authenticate via SAML. If members navigate to organization resources via their IdP dashboard, they will need to click the new tile for the enterprise-level app, instead of the old tile for the organization-level app. The members will then be able to choose the organization to navigate to. Any {% data variables.product.pat_generic %}s, SSH keys, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %} that were previously authorized for the organization will continue to be authorized for the organization. However, members will need to authorize any PATs, SSH keys, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %} that were never authorized for use with SAML SSO for the organization. diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md index 60d510f68845..246fdefced81 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md @@ -104,7 +104,7 @@ To configure the instance, you must confirm the instance's status, upload a lice ## Azure extension features -{% data variables.product.product_name %} does not support the installation of Azure extension features. The {% data variables.product.prodname_ghe_server %} image is shipped with a customized `waagent` package which only supports basic VM management functions and blocks advanced VM management functions. +{% data variables.product.product_name %} does not support the installation of Azure extension features. The {% data variables.product.prodname_ghe_server %} image is shipped with a customized `waagent` package which only supports basic VM management functions and blocks advanced VM management functions. To avoid system instability of your {% data variables.product.prodname_ghe_server %} instance, the `walinuxagent` service is intentionally run in {% data variables.product.prodname_ghe_server %} in a restricted mode, explicitly disallowing the agent from being able to install other agents. VM management features that rely on additional agents and extensions beyond that which ships with {% data variables.product.prodname_ghe_server %} image, such as the Monitoring Agent extension for Azure Insights or Azure Backups, are unsupported. diff --git a/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/exporting-server-statistics.md b/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/exporting-server-statistics.md index dd2a5f9afac0..fa93211f711d 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/exporting-server-statistics.md +++ b/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/exporting-server-statistics.md @@ -8,9 +8,9 @@ redirect_from: - /early-access/github/analyze-how-your-team-works-with-server-statistics/exploring-server-statistics --- -You can download up to the last 365 days of {% data variables.product.prodname_server_statistics %} data in a CSV or JSON file. This data, which includes aggregate metrics on repositories, issues, and pull requests, can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}. +You can download up to the last 365 days of {% data variables.product.prodname_server_statistics %} data in a CSV or JSON file. This data, which includes aggregate metrics on repositories, issues, and pull requests, can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}. -Before you can download this data, you must enable {% data variables.product.prodname_server_statistics %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)." +Before you can download this data, you must enable {% data variables.product.prodname_server_statistics %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)." To preview the metrics available to download, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics)." diff --git a/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md b/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md index 74ea45e655ae..9cfb223b40b0 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md +++ b/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md @@ -10,6 +10,6 @@ redirect_from: You can request up to 365 days of metrics in a single {% data variables.product.prodname_server_statistics %} REST API request. This data, which includes aggregate metrics on repositories, issues, and pull requests, can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}. For a list of the metrics collected, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." -Before you can use the {% data variables.product.prodname_server_statistics %} REST API, you must enable {% data variables.product.prodname_server_statistics %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)." +Before you can use the {% data variables.product.prodname_server_statistics %} REST API, you must enable {% data variables.product.prodname_server_statistics %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)." For more information about using the REST API to request server statistics, see "[AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics)" in the {% data variables.product.prodname_ghe_cloud %} REST API documentation. diff --git a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding.md b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding.md index 638a571f9ce8..d53022c61fee 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding.md +++ b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding.md @@ -32,8 +32,8 @@ When you enable log forwarding, you must upload a CA certificate to encrypt comm 1. Select **Enable log forwarding**. 1. In the **Server address** field, type the address of the server to which you want to forward logs. You can specify multiple addresses in a comma-separated list. 1. In the Protocol drop-down menu, select the protocol to use to communicate with the log server. The protocol will apply to all specified log destinations. -1. Optionally, select **Enable TLS**. We recommend enabling TLS according to your local security policies, especially if there are untrusted networks between the appliance and any remote log servers. -2. To encrypt communication between syslog endpoints, click **Choose File** and choose a CA certificate for the remote syslog server. You should upload a CA bundle containing a concatenation of the certificates of the CAs involved in signing the certificate of the remote log server. The entire certificate chain will be validated, and must terminate in a root certificate. +1. Optionally, select **Enable TLS**. We recommend enabling TLS according to your local security policies, especially if there are untrusted networks between the appliance and any remote log servers. +2. To encrypt communication between syslog endpoints, click **Choose File** and choose a CA certificate for the remote syslog server. You should upload a CA bundle containing a concatenation of the certificates of the CAs involved in signing the certificate of the remote log server. The entire certificate chain will be validated, and must terminate in a root certificate. {% elsif ghae %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md index b09a68ac83b7..740d9a771406 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md @@ -573,7 +573,7 @@ Before you'll see `git` category actions, you must enable Git events in the audi | `management_console.slack_app_generate` | An app for the Slack integration was generated. For more information, see "[AUTOTITLE](/get-started/exploring-integrations/github-extensions-and-integrations#team-communication-tools)." | | `management_console.slack_app_update` | The app-level token for the Slack integration was updated. For more information, see "[AUTOTITLE](/get-started/exploring-integrations/github-extensions-and-integrations#team-communication-tools)." | | `management_console.smtp_test` | An SMTP configuration was tested while enabling email notifications for the instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications#testing-email-delivery)." | -| `management_console.ssh_command` | A command was run using the administrative shell (SSH). For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." +| `management_console.ssh_command` | A command was run using the administrative shell (SSH). For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." | `management_console.storage_actions_test` | A storage configuration for {% data variables.product.prodname_actions %} was tested. For more information, see "[AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server)." | | `management_console.storage_migrations_test` | A storage configuration for {% data variables.product.prodname_importer_proper_name %} was tested. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud)." | | `management_console.storage_packages_test` | A storage configuration for {% data variables.product.prodname_registry %} was tested. For more information, see "[AUTOTITLE](/admin/packages)." | diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md index 80dc7e08f96e..f5c662af02a7 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md @@ -51,11 +51,11 @@ Before you can enable Git events in the audit log, you must configure a retentio 1. Under "Git event opt-in", select or deselect **Enable git events in the audit-log**. {% note %} - + **Note:** The retention policy must be set to something other than infinite for this option to display. {% endnote %} - + ![Screenshot of the audit log. The checkbox to enable Git events in the audit log is highlighted with an orange outline.](/assets/images/help/enterprises/enable-git-events-checkbox.png) 2. Click **Save**. diff --git a/content/admin/overview/about-github-ae.md b/content/admin/overview/about-github-ae.md index e2381ded18f1..e3928d598ee4 100644 --- a/content/admin/overview/about-github-ae.md +++ b/content/admin/overview/about-github-ae.md @@ -13,11 +13,11 @@ topics: {% data reusables.github-ae.github-ae-enables-you %} {% data variables.product.prodname_ghe_managed %} is fully managed, reliable, and scalable, allowing you to accelerate delivery while improving your risk and compliance posture. -{% data variables.product.prodname_ghe_managed %} offers one developer platform from idea to production. You can increase development velocity with the tools that teams know and love, while you maintain industry and regulatory compliance with security and access controls, workflow automation, and policy enforcement. +{% data variables.product.prodname_ghe_managed %} offers one developer platform from idea to production. You can increase development velocity with the tools that teams know and love, while you maintain industry and regulatory compliance with security and access controls, workflow automation, and policy enforcement. ## A highly available and planet-scale cloud -{% data variables.product.prodname_ghe_managed %} is a fully managed service, hosted in a high availability architecture. {% data variables.product.prodname_ghe_managed %} is hosted globally in a cloud that can scale to support your full development lifecycle without limits. {% data variables.product.prodname_dotcom %} fully manages backups, failover, and disaster recovery, so you never need to worry about your service or data. +{% data variables.product.prodname_ghe_managed %} is a fully managed service, hosted in a high availability architecture. {% data variables.product.prodname_ghe_managed %} is hosted globally in a cloud that can scale to support your full development lifecycle without limits. {% data variables.product.prodname_dotcom %} fully manages backups, failover, and disaster recovery, so you never need to worry about your service or data. ## Data residency @@ -44,12 +44,12 @@ Secure access to your enterprise on {% data variables.product.prodname_ghe_manag - FedRAMP High Authorization to Operate (ATO) - SOC 1, SOC 2 Type II, and SOC 3 - ISO/IEC certifications - - ISO/IEC 27001:2013 + - ISO/IEC 27001:2013 - ISO/IEC 27701:2019 - ISO/IEC 9001:2015 - - ISO/IEC 22301:2019 - - ISO/IEC 27018:2014 - - ISO/IEC 20000-1:2018 + - ISO/IEC 22301:2019 + - ISO/IEC 27018:2014 + - ISO/IEC 20000-1:2018 - ISO/IEC 27017:2015 ## Further reading diff --git a/content/admin/overview/about-the-github-enterprise-api.md b/content/admin/overview/about-the-github-enterprise-api.md index 4be968b939c2..500410cff3c2 100644 --- a/content/admin/overview/about-the-github-enterprise-api.md +++ b/content/admin/overview/about-the-github-enterprise-api.md @@ -24,4 +24,4 @@ With the APIs, you can automate many administrative tasks. Some examples include - Collect statistics about your enterprise. For more information, see "[AUTOTITLE](/rest/enterprise-admin#admin-stats)." - Manage your enterprise account. For more information, see "[AUTOTITLE](/graphql/guides/managing-enterprise-accounts)." -For the complete documentation for the {% data variables.product.prodname_enterprise_api %}, see [{% data variables.product.prodname_dotcom %} REST API](/rest) and [{% data variables.product.prodname_dotcom%} GraphQL API](/graphql). +For the complete documentation for the {% data variables.product.prodname_enterprise_api %}, see [{% data variables.product.prodname_dotcom %} REST API](/rest) and [{% data variables.product.prodname_dotcom%} GraphQL API](/graphql). diff --git a/content/admin/overview/creating-an-enterprise-account.md b/content/admin/overview/creating-an-enterprise-account.md index 53a5be1b55b2..ab2836af9b6b 100644 --- a/content/admin/overview/creating-an-enterprise-account.md +++ b/content/admin/overview/creating-an-enterprise-account.md @@ -18,7 +18,7 @@ shortTitle: Create enterprise account If you currently use {% data variables.product.prodname_ghe_cloud %} with a single organization and by invoice, you can create an enterprise account through your billing page. If you need Enterprise Managed Users, {% data variables.product.prodname_ghe_server %}, or invoicing support, please contact {% data variables.contact.contact_enterprise_sales %}. -You can also create an enterprise account by setting up a free trial of {% data variables.product.prodname_ghe_cloud %}. Trials are limited to 50 seats. If you have an existing organization with more than 50 seats that you want to invite into the trial, please contact {% data variables.contact.contact_enterprise_sales %}. For more information, see "[AUTOTITLE](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud)". +You can also create an enterprise account by setting up a free trial of {% data variables.product.prodname_ghe_cloud %}. Trials are limited to 50 seats. If you have an existing organization with more than 50 seats that you want to invite into the trial, please contact {% data variables.contact.contact_enterprise_sales %}. For more information, see "[AUTOTITLE](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud)". When you create an enterprise account that owns your existing organization on {% data variables.product.product_name %}, the organization's resources remain accessible to members at the same URLs. After you add your organization to the enterprise account, the following changes will apply to the organization. diff --git a/content/admin/overview/system-overview.md b/content/admin/overview/system-overview.md index de4fc22b4152..185ffdd934d0 100644 --- a/content/admin/overview/system-overview.md +++ b/content/admin/overview/system-overview.md @@ -82,7 +82,7 @@ For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-ent {% data variables.product.product_name %} is provided as an appliance, and many of the operating system packages are modified compared to the usual Debian distribution. We do not support modifying the underlying operating system for this reason (including operating system upgrades), which is aligned with the [{% data variables.product.prodname_ghe_server %} license and support agreement](https://enterprise.github.com/license), under section 11.3 Exclusions. -Currently, the base operating system for {% data variables.product.product_name %} is Debian 10 (Buster), which receives support under the Debian Long Term Support program. +Currently, the base operating system for {% data variables.product.product_name %} is Debian 10 (Buster), which receives support under the Debian Long Term Support program. Regular patch updates are released on the {% data variables.product.product_name %} [releases](https://enterprise.github.com/releases) page, and the [release notes](/admin/release-notes) page provides more information. These patches typically contain upstream vendor and project security patches after they've been tested and quality approved by our engineering team. There can be a slight time delay from when the upstream update is released to when it's tested and bundled in an upcoming {% data variables.product.product_name %} patch release. diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies.md b/content/admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies.md index 05896ebc1277..0f850a137fa2 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies.md @@ -11,7 +11,7 @@ topics: - Policies --- -To help you enforce business rules and regulatory compliance, policies provide a single point of management for all the organizations owned by an enterprise account. +To help you enforce business rules and regulatory compliance, policies provide a single point of management for all the organizations owned by an enterprise account. {% data reusables.enterprise.about-policies %} diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md index 2ffe650c87ca..8dae8ef31e65 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md @@ -67,7 +67,7 @@ You can choose to disable {% data variables.product.prodname_actions %} for all By default anyone with admin access to a repository can add a self-hosted runner for the repository. The enterprise settings allow you to disable the use of repository-level self-hosted runners across all repositories in your enterprise. If you allow repository-level self-hosted runners for your enterprise, organization owners can choose to allow or prevent creation of repository-level self-hosted runners for some or all repositories in their organization. For more information see, "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)." -{% data reusables.actions.disable-selfhosted-runners-note %} +{% data reusables.actions.disable-selfhosted-runners-note %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} @@ -75,9 +75,9 @@ By default anyone with admin access to a repository can add a self-hosted runner 1. In the "Runners" section, select **Disable for all organizations**.{% ifversion ghec %} {% note %} - + **Note**: Owners of an {% data variables.enterprise.prodname_emu_enterprise %} can also choose to select **Disable in all Enterprise Managed User (EMU) repositories** to restrict runner creation for repositories that are owned by managed user accounts. - + {% endnote %} {% endif %} diff --git a/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md b/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md index 06f0502d6a30..e7a98d02735c 100644 --- a/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md +++ b/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md @@ -56,7 +56,7 @@ Enterprise owners who create an organization owned by the enterprise account aut ## Inviting an organization to join your enterprise account -Enterprise owners can invite existing organizations to join their enterprise account. +Enterprise owners can invite existing organizations to join their enterprise account. If the organization you want to invite is already owned by another enterprise account, you must be an owner of both enterprise accounts. If you're not, you can ask an owner of the enterprise account that currently owns the organization to transfer the organization to your enterprise account instead. For more information, see "[Transferring an organization between enterprise accounts](#transferring-an-organization-between-enterprise-accounts)." diff --git a/content/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md b/content/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md index 1d74c0cb258c..495a3b2eac8f 100644 --- a/content/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md +++ b/content/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md @@ -23,7 +23,7 @@ Both {% data variables.product.prodname_oauth_app %}s and {% data variables.prod {% data variables.product.prodname_oauth_app %}s can only act on behalf of a user while {% data variables.product.prodname_github_app %}s can either act on behalf of a user or independently of a user. -{% data variables.product.prodname_github_app %}s use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. +{% data variables.product.prodname_github_app %}s use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." diff --git a/content/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md index b15371a2e582..78b43a036c60 100644 --- a/content/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md @@ -32,7 +32,7 @@ The rate limit for {% data variables.product.prodname_github_app %}s using an in There is one case where an {% data variables.product.prodname_oauth_app %} is preferred over a {% data variables.product.prodname_github_app %}. If your app needs to access enterprise-level resources such as the enterprise object itself, you should use an {% data variables.product.prodname_oauth_app %} because a {% data variables.product.prodname_github_app %} cannot yet be given permissions against an enterprise. {% data variables.product.prodname_github_app %}s can still access enterprise-owned organization and repository resources. -For more information about {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." +For more information about {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." For more information about migrating an existing {% data variables.product.prodname_oauth_app %} to a {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/guides/migrating-oauth-apps-to-github-apps)." diff --git a/content/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md b/content/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md index e707eedb594c..360c59ebc001 100644 --- a/content/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md +++ b/content/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md @@ -80,7 +80,7 @@ Disadvantages: ## The app code must be aware of feature differences -New REST API endpoints, GraphQL objects, and webhooks are released to {% data variables.product.prodname_ghe_server %} at a later date than {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_ghe_cloud %}. Additionally, there are multiple versions of {% data variables.product.prodname_ghe_server %}, and older versions may have different REST API endpoints, GraphQL objects, and webhooks. +New REST API endpoints, GraphQL objects, and webhooks are released to {% data variables.product.prodname_ghe_server %} at a later date than {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_ghe_cloud %}. Additionally, there are multiple versions of {% data variables.product.prodname_ghe_server %}, and older versions may have different REST API endpoints, GraphQL objects, and webhooks. Therefore, the app code needs to be aware of these differences. API responses and webhook payloads include a `x-github-enterprise-version` header for {% data variables.product.prodname_ghe_server %} payloads to help you determine what version you are handling. diff --git a/content/apps/using-github-apps/reviewing-and-modifying-installed-github-apps.md b/content/apps/using-github-apps/reviewing-and-modifying-installed-github-apps.md index ff9328e73e00..f0a02f156519 100644 --- a/content/apps/using-github-apps/reviewing-and-modifying-installed-github-apps.md +++ b/content/apps/using-github-apps/reviewing-and-modifying-installed-github-apps.md @@ -28,7 +28,7 @@ In addition to reviewing {% data variables.product.prodname_github_app %}s that 1. Next to the {% data variables.product.prodname_github_app %} you want to review or modify, click **Configure**. - For a {% data variables.product.prodname_github_app %} installed on your personal account: - 1. In the upper-right corner of any page, click your profile photo, then click **Settings**. + 1. In the upper-right corner of any page, click your profile photo, then click **Settings**. 1. Under "Integrations," click **Applications**. 1. Click **Installed GitHub Apps**. A list of the {% data variables.product.prodname_github_app %}s installed on your personal account will be displayed. 1. Next to the {% data variables.product.prodname_github_app %} you want to review or modify, click **Configure**. diff --git a/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md b/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md index 0d99cb21a2d3..71b722616a29 100644 --- a/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md +++ b/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md @@ -20,7 +20,7 @@ SAML SSO allows an enterprise owner to centrally control and secure access to {% {% data reusables.saml.you-must-periodically-authenticate %} -If you can't access {% data variables.product.product_name %}, contact your local enterprise owner or administrator for {% data variables.product.product_name %}. You may be able to locate contact information for your enterprise by clicking **Support** at the bottom of any page on {% data variables.product.product_name %}. {% data variables.product.company_short %} and {% data variables.contact.github_support %} do not have access to your IdP, and cannot troubleshoot authentication problems. +If you can't access {% data variables.product.product_name %}, contact your local enterprise owner or administrator for {% data variables.product.product_name %}. You may be able to locate contact information for your enterprise by clicking **Support** at the bottom of any page on {% data variables.product.product_name %}. {% data variables.product.company_short %} and {% data variables.contact.github_support %} do not have access to your IdP, and cannot troubleshoot authentication problems. {% endif %} @@ -42,11 +42,11 @@ If you have recently authenticated with your organization's SAML IdP in your bro ## Linked SAML identities -When you authenticate with your IdP account and return to {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_dotcom %} will record a link in the organization or enterprise between your {% data variables.product.prodname_dotcom %} personal account and the SAML identity you signed into. This linked identity is used to validate your membership in that organization, and depending on your organization or enterprise setup, is also used to determine which organizations and teams you're a member of as well. Each {% data variables.product.prodname_dotcom %} account can be linked to exactly one SAML identity per organization. Likewise, each SAML identity can be linked to exactly one {% data variables.product.prodname_dotcom %} account in an organization. +When you authenticate with your IdP account and return to {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_dotcom %} will record a link in the organization or enterprise between your {% data variables.product.prodname_dotcom %} personal account and the SAML identity you signed into. This linked identity is used to validate your membership in that organization, and depending on your organization or enterprise setup, is also used to determine which organizations and teams you're a member of as well. Each {% data variables.product.prodname_dotcom %} account can be linked to exactly one SAML identity per organization. Likewise, each SAML identity can be linked to exactly one {% data variables.product.prodname_dotcom %} account in an organization. If you sign in with a SAML identity that is already linked to another {% data variables.product.prodname_dotcom %} account, you will receive an error message indicating that you cannot sign in with that SAML identity. This situation can occur if you are attempting to use a new {% data variables.product.prodname_dotcom %} account to work inside of your organization. If you didn't intend to use that SAML identity with that {% data variables.product.prodname_dotcom %} account, then you'll need to sign out of that SAML identity and then repeat the SAML login. If you do want to use that SAML identity with your {% data variables.product.prodname_dotcom %} account, you'll need to ask your admin to unlink your SAML identity from your old account, so that you can link it to your new account. Depending on the setup of your organization or enterprise, your admin may also need to reassign your identity within your SAML provider. For more information, see "[AUTOTITLE](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)." -If the SAML identity you sign in with does not match the SAML identity that is currently linked to your {% data variables.product.prodname_dotcom %} account, you'll receive a warning that you are about to relink your account. Because your SAML identity is used to govern access and team membership, continuing with the new SAML identity can cause you to lose access to teams and organizations inside of {% data variables.product.prodname_dotcom %}. Only continue if you know that you're supposed to use that new SAML identity for authentication in the future. +If the SAML identity you sign in with does not match the SAML identity that is currently linked to your {% data variables.product.prodname_dotcom %} account, you'll receive a warning that you are about to relink your account. Because your SAML identity is used to govern access and team membership, continuing with the new SAML identity can cause you to lose access to teams and organizations inside of {% data variables.product.prodname_dotcom %}. Only continue if you know that you're supposed to use that new SAML identity for authentication in the future. ## Authorizing {% data variables.product.pat_generic %}s and SSH keys with SAML SSO @@ -60,7 +60,7 @@ To use a new or existing {% data variables.product.pat_generic %} or SSH key wit You must have an active SAML session each time you authorize an {% data variables.product.prodname_oauth_app %} or {% data variables.product.prodname_github_app %} to access an organization that uses or enforces SAML SSO. You can create an active SAML session by navigating to `https://github.com/orgs/ORGANIZATION-NAME/sso` in your browser. -After an enterprise or organization owner enables or enforces SAML SSO for an organization, and after you authenticate via SAML for the first time, you must reauthorize any {% data variables.product.prodname_oauth_apps %} or {% data variables.product.prodname_github_apps %} that you previously authorized to access the organization. +After an enterprise or organization owner enables or enforces SAML SSO for an organization, and after you authenticate via SAML for the first time, you must reauthorize any {% data variables.product.prodname_oauth_apps %} or {% data variables.product.prodname_github_apps %} that you previously authorized to access the organization. To see the {% data variables.product.prodname_oauth_apps %} you've authorized, visit your [{% data variables.product.prodname_oauth_apps %} page](https://github.com/settings/applications). To see the {% data variables.product.prodname_github_apps %} you've authorized, visit your [{% data variables.product.prodname_github_apps %} page](https://github.com/settings/apps/authorizations). diff --git a/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md b/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md index 48f7e8f36949..110dcfde6fd6 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md @@ -14,7 +14,7 @@ topics: - Identity - Access management --- -To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each file which hides your browser details and related information from other users. The URL starts `https://.githubusercontent.com/`, with different subdomains depending on how you uploaded the image. +To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each file which hides your browser details and related information from other users. The URL starts `https://.githubusercontent.com/`, with different subdomains depending on how you uploaded the image. Videos also get anonymized URLs with the same format as image URLs, but are not processed through Camo. This is because {% data variables.product.prodname_dotcom %} does not support externally hosted videos, so the anonymized URL is a link to the uploaded video hosted by {% data variables.product.prodname_dotcom %}. diff --git a/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md b/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md index 96e305270a77..71300a7b8ec7 100644 --- a/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md +++ b/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md @@ -28,7 +28,7 @@ To keep your account secure, we recommend you follow these best practices: {% data reusables.repositories.blocked-passwords %} -You can only use your password to log on to {% data variables.product.product_name %} using your browser. When you authenticate to {% data variables.product.product_name %} with other means, such as the command line or API, you should use other credentials. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)." +You can only use your password to log on to {% data variables.product.product_name %} using your browser. When you authenticate to {% data variables.product.product_name %} with other means, such as the command line or API, you should use other credentials. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)." {% ifversion fpt or ghec %}{% data reusables.user-settings.password-authentication-deprecation %}{% endif %} diff --git a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index ffe213f0659c..613430b0983d 100644 --- a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -24,9 +24,9 @@ You can remove the file from the latest commit with `git rm`. For information on {% warning %} -**Warning**: This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. However, those commits may still be accessible in any clones or forks of your repository, directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}, and through any pull requests that reference them. You cannot remove sensitive data from other users' clones of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. +**Warning**: This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. However, those commits may still be accessible in any clones or forks of your repository, directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}, and through any pull requests that reference them. You cannot remove sensitive data from other users' clones of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. -Once you have pushed a commit to {% data variables.product.product_name %}, you should consider any sensitive data in the commit compromised. If you have committed a password, you should change it. If you have committed a key, generate a new one. Removing the compromised data doesn't resolve its initial exposure, especially in existing clones or forks of your repository. +Once you have pushed a commit to {% data variables.product.product_name %}, you should consider any sensitive data in the commit compromised. If you have committed a password, you should change it. If you have committed a key, generate a new one. Removing the compromised data doesn't resolve its initial exposure, especially in existing clones or forks of your repository. If the commit that introduced the sensitive data exists in any forks of your repository, it will continue to be accessible unless the fork owner also removes the sensitive data from their fork or deletes the fork entirely. You will need to coordinate with the owners of any forks of your repository, asking them to take the appropriate actions.{% ifversion fpt or ghec %} Please note that {% data variables.product.company_short %} cannot provide contact information for these owners. {% endif %} @@ -46,7 +46,7 @@ You can purge a file from your repository's history using either the `git filter ### Using the BFG -The [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) is a tool that's built and maintained by the open source community. It provides a faster, simpler alternative to `git filter-repo` for removing unwanted data. +The [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) is a tool that's built and maintained by the open source community. It provides a faster, simpler alternative to `git filter-repo` for removing unwanted data. For example, to remove your file with sensitive data and leave your latest commit untouched, run: diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md index 030a1fbaf8cf..457e5bcf1e55 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md @@ -34,7 +34,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an {% data reusables.command_line.start_ssh_agent %} -6. Find and take a note of your public key fingerprint. +6. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) @@ -56,13 +56,13 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an {% endtip %} -4. Open Git Bash. +4. Open Git Bash. 5. {% data reusables.desktop.windows_git_bash_turn_on_ssh_agent %} {% data reusables.desktop.windows_git_for_windows_turn_on_ssh_agent %} -6. Find and take a note of your public key fingerprint. +6. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) @@ -88,7 +88,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an {% data reusables.command_line.start_ssh_agent %} -6. Find and take a note of your public key fingerprint. +6. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) 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 ff776d8377b8..c9f2baa6328f 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 @@ -38,7 +38,7 @@ After you authenticate to perform a sensitive action, your session is temporaril {% note %} -**Note**: If your enterprise uses {% data variables.product.prodname_emus %}, you will not receive prompts to enter sudo mode, as your account doesn't have credentials stored on {% data variables.product.product_name %}. +**Note**: If your enterprise uses {% data variables.product.prodname_emus %}, you will not receive prompts to enter sudo mode, as your account doesn't have credentials stored on {% data variables.product.product_name %}. {% endnote %} diff --git a/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md b/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md index ddd873d619c1..7e10eeced986 100644 --- a/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md +++ b/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md @@ -31,7 +31,7 @@ When you create a {% data variables.product.pat_generic %}, we recommend that yo {% ifversion fpt or ghec %} ## Token revoked when pushed to a public repository or public gist -If a valid OAuth token, {% data variables.product.prodname_github_app %} token, or {% data variables.product.pat_generic %} is pushed to a public repository or public gist, the token will be automatically revoked. +If a valid OAuth token, {% data variables.product.prodname_github_app %} token, or {% data variables.product.pat_generic %} is pushed to a public repository or public gist, the token will be automatically revoked. {% endif %} diff --git a/content/authentication/keeping-your-account-and-data-secure/viewing-and-managing-your-sessions.md b/content/authentication/keeping-your-account-and-data-secure/viewing-and-managing-your-sessions.md index f133bdad0d34..f5bee74e35cf 100644 --- a/content/authentication/keeping-your-account-and-data-secure/viewing-and-managing-your-sessions.md +++ b/content/authentication/keeping-your-account-and-data-secure/viewing-and-managing-your-sessions.md @@ -20,12 +20,12 @@ You can view a list of devices that have logged into your account, and revoke an 1. To see the web session details, click **See more**. 1. To revoke a web session, click **Revoke session**. {% ifversion fpt or ghec %} -1. Optionally, to revoke a {% data variables.product.prodname_mobile %} session, go back to the Sessions overview page and click **Revoke** next to the device you want to revoke. +1. Optionally, to revoke a {% data variables.product.prodname_mobile %} session, go back to the Sessions overview page and click **Revoke** next to the device you want to revoke. {% note %} - **Note:** Revoking a mobile session signs you out of the {% data variables.product.prodname_mobile %} application on that device and removes it as a second-factor option. + **Note:** Revoking a mobile session signs you out of the {% data variables.product.prodname_mobile %} application on that device and removes it as a second-factor option. {% endnote %} - + {% endif %} diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md index 0499ce7f4113..ccdb1e409aed 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md @@ -41,12 +41,12 @@ If you chose to set up two-factor authentication using a TOTP application on you If you delete your authenticator application after configuring two-factor authentication, you'll need to provide your recovery code to get access to your account. Many TOTP apps support the secure backup of your authentication codes in the cloud and can be restored if you lose access to your device. For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials)." -### Using a security key +### Using a security key -If you've set up a security key on your account, and your browser supports security keys, you can use it to complete your sign in. +If you've set up a security key on your account, and your browser supports security keys, you can use it to complete your sign in. 1. Using your username and password, sign in to {% data variables.product.product_name %} through your browser. -1. If you use a physical security key, ensure it's connected to your device. +1. If you use a physical security key, ensure it's connected to your device. 1. To trigger the security key prompt from your operating system, select "Use security key". 1. Select the appropriate option in the prompt. Depending on your security key configuration, you may type a PIN, complete a biometric prompt, or use a physical security key. diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md index dc02397ab4b0..9af6061331ee 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md @@ -107,7 +107,7 @@ Before using this method, be sure that you can receive text messages. Carrier ra {% data reusables.user-settings.security %} {% data reusables.two_fa.enable-two-factor-authentication %} 1. At the bottom of the page, next to "SMS authentication", click **Select**. -1. Complete the CAPTCHA challenge, which helps protect against spam and abuse. +1. Complete the CAPTCHA challenge, which helps protect against spam and abuse. 1. Under "Setup SMS authentication", select your country code and type your mobile phone number, including the area code. When your information is correct, click **Send authentication code**. 1. You'll receive a text message with a security code. On {% data variables.product.product_name %}, type the code into the field under "Verify the code sent to your phone" and click **Continue**. - If you need to edit the phone number you entered, you'll need to complete another CAPTCHA challenge. @@ -125,7 +125,7 @@ On most devices and browsers, you can use a physical security key over USB or NF Registering a security key for your account is available after enabling 2FA with a TOTP application{% ifversion fpt or ghec %} or a text message{% endif %}. If you lose your security key, you'll still be able to use your phone's code to sign in. 1. You must have already configured 2FA via a TOTP mobile app{% ifversion fpt or ghec %} or via SMS{% endif %}. -1. Ensure that you have a WebAuthn compatible security key inserted into your device, or that your device has a built-in authenticator such as Windows Hello, Face ID, or Touch ID. Most computers, phones, and tablets support this as an easier-to-use alternative to physical security keys. +1. Ensure that you have a WebAuthn compatible security key inserted into your device, or that your device has a built-in authenticator such as Windows Hello, Face ID, or Touch ID. Most computers, phones, and tablets support this as an easier-to-use alternative to physical security keys. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security %} 1. Next to "Security keys", click **Add**. diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md index 1f9084b36026..90a96676fa9b 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md @@ -21,7 +21,7 @@ shortTitle: Disable 2FA We strongly recommend using two-factor authentication to secure your account. If you need to disable 2FA, we recommend re-enabling it as soon as possible. {% ifversion mandatory-2fa-dotcom-contributors %} -If you are part of the group that {% data variables.product.prodname_dotcom %} is requiring to enroll in 2FA in 2023, you cannot disable 2FA. A banner will display in your authentication settings to remind you that you are not allowed to disable 2FA. For more information about our 2023 2FA enrollment rollout for contributors to {% data variables.product.prodname_dotcom_the_website %}, see [this blog post](https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13). +If you are part of the group that {% data variables.product.prodname_dotcom %} is requiring to enroll in 2FA in 2023, you cannot disable 2FA. A banner will display in your authentication settings to remind you that you are not allowed to disable 2FA. For more information about our 2023 2FA enrollment rollout for contributors to {% data variables.product.prodname_dotcom_the_website %}, see [this blog post](https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13). {% endif %} {% warning %} diff --git a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md index 5af93440bfd1..aa387390e5ff 100644 --- a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md +++ b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md @@ -57,7 +57,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} {% mac %} {% data reusables.command_line.open_the_multi_os_terminal %} -2. Verify that you have a private key generated and loaded into SSH. +2. Verify that you have a private key generated and loaded into SSH. ```shell # start the ssh-agent in the background $ eval "$(ssh-agent -s)" @@ -75,7 +75,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} 1. {% data reusables.desktop.windows_git_bash_turn_on_ssh_agent %} {% data reusables.desktop.windows_git_for_windows_turn_on_ssh_agent %} -2. Verify that you have a private key generated and loaded into SSH. +2. Verify that you have a private key generated and loaded into SSH. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) @@ -86,7 +86,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} {% linux %} {% data reusables.command_line.open_the_multi_os_terminal %} -2. Verify that you have a private key generated and loaded into SSH. +2. Verify that you have a private key generated and loaded into SSH. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) @@ -146,7 +146,7 @@ You must provide your public key to {% data variables.product.product_name %} to $ eval "$(ssh-agent -s)" > Agent pid 59566 ``` -3. Find and take a note of your public key fingerprint. +3. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) @@ -166,7 +166,7 @@ You must provide your public key to {% data variables.product.product_name %} to $ ssh-agent -s > Agent pid 59566 ``` -3. Find and take a note of your public key fingerprint. +3. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) diff --git a/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md b/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md index a7a90dd879e1..341f3521118e 100644 --- a/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md +++ b/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md @@ -64,7 +64,7 @@ Enterprise owners and billing managers can manage the spending limit for {% data {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} 1. On the "Billing" page, click the **Spending limit** tab. - + ![Screenshot of the "Billing" page. A tab labeled "Spending limit" is highlighted with an orange outline.](/assets/images/help/settings/spending-limit-tab-enterprise.png) {% data reusables.dotcom_billing.monthly-spending-limit %} diff --git a/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md b/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md index c8d20b4a6ed2..15e058bc4fa5 100644 --- a/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md +++ b/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md @@ -56,7 +56,7 @@ You can determine how many licenses you'll need for {% data variables.product.pr {% endif %} {% ifversion ghec %} -If you use {% data variables.product.prodname_ghe_cloud %} with an enterprise account and pay with a credit card, you can purchase a {% data variables.product.prodname_GH_advanced_security %} license or start a free trial from your enterprise account settings. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security)" and "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security)." +If you use {% data variables.product.prodname_ghe_cloud %} with an enterprise account and pay with a credit card, you can purchase a {% data variables.product.prodname_GH_advanced_security %} license or start a free trial from your enterprise account settings. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security)" and "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security)." You can not purchase {% data variables.product.prodname_GH_advanced_security %} or start a {% data variables.product.prodname_GH_advanced_security %} trial if you are currently on a {% data variables.product.prodname_ghe_cloud %} trial. diff --git a/content/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md b/content/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md index 03d21091bb94..203fc07f029d 100644 --- a/content/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md +++ b/content/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md @@ -12,7 +12,7 @@ topics: shortTitle: Manage Advanced Security licensing --- ## About licensing for GitHub Advanced Security -Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of accounts that can use these features. Each active committer to at least one repository with the feature enabled uses one {% ifversion ghas-billing-UI-update %}license{% else %}seat{% endif %}. A committer is considered active if one of their commits has been pushed to the repository within the last 90 days, regardless of when it was originally authored. For more information about committer numbers, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)." For information about purchasing a license, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security)." +Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of accounts that can use these features. Each active committer to at least one repository with the feature enabled uses one {% ifversion ghas-billing-UI-update %}license{% else %}seat{% endif %}. A committer is considered active if one of their commits has been pushed to the repository within the last 90 days, regardless of when it was originally authored. For more information about committer numbers, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)." For information about purchasing a license, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security)." ## Managing the number of GitHub Advanced Security committers {% data reusables.enterprise-accounts.access-enterprise %} @@ -31,7 +31,7 @@ Each license for {% data variables.product.prodname_GH_advanced_security %} spec {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} -1. To the right of "GitHub Advanced Security", click **Manage**, then click **Cancel Subscription**. +1. To the right of "GitHub 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) -2. To confirm your cancellation, click **I understand, cancel Advanced Security**. +2. To confirm your cancellation, click **I understand, cancel Advanced Security**. diff --git a/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md b/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md index 074cdb2dde0d..c517a1b41b6f 100644 --- a/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md +++ b/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md @@ -21,7 +21,7 @@ shortTitle: Set up an Advanced Security trial {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} -1. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Start free trial**. +1. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Start free trial**. 2. Click **Start trial**. ## Finishing your trial diff --git a/content/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security.md b/content/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security.md index 672bfacc5ab5..199c12f4311c 100644 --- a/content/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security.md +++ b/content/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security.md @@ -11,11 +11,11 @@ topics: - Enterprise shortTitle: Sign up for Advanced Security --- -## Purchasing {% data variables.product.prodname_GH_advanced_security %} +## Purchasing {% data variables.product.prodname_GH_advanced_security %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} -1. To the right of "GitHub Advanced Security", click **Buy Advanced Security**. +1. To the right of "GitHub Advanced Security", click **Buy Advanced Security**. ![Screenshot of the {% data variables.product.prodname_GH_advanced_security %} section of the enterprise licensing screen. The "Buy Advanced Security" button is highlighted with an orange outline.](/assets/images/help/enterprises/ghas-buy-advanced-security-button.png) 1. {% data reusables.advanced-security.purchase-ghas %} diff --git a/content/billing/managing-billing-for-github-advanced-security/viewing-committer-information-for-github-advanced-security.md b/content/billing/managing-billing-for-github-advanced-security/viewing-committer-information-for-github-advanced-security.md index f40edd1be062..87231c246841 100644 --- a/content/billing/managing-billing-for-github-advanced-security/viewing-committer-information-for-github-advanced-security.md +++ b/content/billing/managing-billing-for-github-advanced-security/viewing-committer-information-for-github-advanced-security.md @@ -14,15 +14,15 @@ shortTitle: View Advanced Security committers ## About the "Advanced Security Committers" dashboard -You can estimate the number of licenses your enterprise might need for {% data variables.product.prodname_GH_advanced_security %} with the "Advanced Security Committers" section of the site admin dashboard. +You can estimate the number of licenses your enterprise might need for {% data variables.product.prodname_GH_advanced_security %} with the "Advanced Security Committers" section of the site admin dashboard. If you currently use {% data variables.product.prodname_GH_advanced_security %}, this tool helps you understand how many committers are currently using licenses. It also helps you estimate how many additional licenses would be used if you enable {% data variables.product.prodname_GH_advanced_security %} for more organizations and repositories. -If you're considering using {% data variables.product.prodname_GH_advanced_security %}, you can use this tool to estimate potential costs to enable {% data variables.product.prodname_GH_advanced_security %}. +If you're considering using {% data variables.product.prodname_GH_advanced_security %}, you can use this tool to estimate potential costs to enable {% data variables.product.prodname_GH_advanced_security %}. For more information about billing for {% data variables.product.prodname_advanced_security %}, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)." -## Viewing committer information +## Viewing committer information 1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}. 1. In the left sidebar, click **Advanced Security Committers**. diff --git a/content/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md b/content/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md index f59b1c9a6e45..d31be9fac361 100644 --- a/content/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md +++ b/content/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md @@ -177,7 +177,7 @@ If you delete a prebuild configuration, all the associated prebuilds are deleted {% note %} -**Notes**: +**Notes**: - Prebuilds may be updated several times during a billing month. Newer versions of a prebuild may be larger or smaller than the previous versions. This will affect the storage charges. For details of how storage is calculated during a billing month, see "[About billing for storage usage](#about-billing-for-storage-usage)" earlier in this article. - As with deleting codespaces, deleting prebuilds does not reduce your used storage amount for the current billing month as this is a cumulative figure. diff --git a/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md b/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md index 381291d0f67e..7243e75f5b17 100644 --- a/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md +++ b/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md @@ -54,7 +54,7 @@ Organizations owners and billing managers can manage the spending limit for {% d **Note:** If {% data variables.product.prodname_github_codespaces %} is enabled for your organization, scroll to "Actions & Packages", then choose to limit spending or allow unlimited spending. {% endnote %} - + {% data reusables.dotcom_billing.update-spending-limit %} {% ifversion ghec %} diff --git a/content/billing/managing-billing-for-your-github-account/about-per-user-pricing.md b/content/billing/managing-billing-for-your-github-account/about-per-user-pricing.md index 4bbab93c7fbd..1924977d5430 100644 --- a/content/billing/managing-billing-for-your-github-account/about-per-user-pricing.md +++ b/content/billing/managing-billing-for-your-github-account/about-per-user-pricing.md @@ -49,7 +49,7 @@ In addition to licensed seats, your bill may include other charges, such as {% d {% note %} -**Notes:** +**Notes:** - {% data variables.product.company_short %} counts each outside collaborator once for billing purposes, even if the user account has access to multiple repositories owned by your organization. - {% data reusables.organizations.org-invite-scim %} @@ -81,7 +81,7 @@ If your enterprise does not use {% data variables.product.prodname_emus %}, you {% note %} -**Notes:** +**Notes:** - {% data variables.product.company_short %} counts each member or outside collaborator once for billing purposes, even if the user account has membership in multiple organizations in an enterprise or access to multiple repositories owned by your organization. - {% data reusables.organizations.org-invite-scim %} diff --git a/content/billing/managing-your-github-billing-settings/adding-information-to-your-receipts.md b/content/billing/managing-your-github-billing-settings/adding-information-to-your-receipts.md index 9b75611e92fa..e6d8821c926a 100644 --- a/content/billing/managing-your-github-billing-settings/adding-information-to-your-receipts.md +++ b/content/billing/managing-your-github-billing-settings/adding-information-to-your-receipts.md @@ -50,7 +50,7 @@ Your receipts include your {% data variables.product.prodname_dotcom %} subscrip {% data reusables.organizations.billing-settings %} 1. At the top of the page, click **Payment information**. - + ![Screenshot of the "Billing Summary" section of the settings page. A link, labeled "Payment information," is highlighted with an orange outline.](/assets/images/help/settings/payment-info-link.png) 1. Under "Payment information", next to "Additional information click **Add information**. diff --git a/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md b/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md index 72be52d972e8..5946c338e9e0 100644 --- a/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md +++ b/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md @@ -78,7 +78,7 @@ Only enterprise members with the owner or billing manager role can access or cha {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} -1. Click **Billing emails**. +1. Click **Billing emails**. 1. Under "Email recipients", to the right of the billing email address, click **Edit**. ![Screenshot of the "Email recipients" list. Next to an email address, a button, labeled "Edit", is highlighted with an orange outline.](/assets/images/help/billing/billing-change-email.png) 1. Type a valid email address, then click **Update**. @@ -104,7 +104,7 @@ Only enterprise members with the owner or billing manager role can access or cha {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} -1. Click **Billing emails**. +1. Click **Billing emails**. 1. Under "Email recipients", find the email address you want to remove. 1. To the right of the email address, select "Edit", then click **Remove**. ![Screenshot of the "Email recipients" section. Next to an email address, under the "Edit" dropdown, "Remove" is highlighted with an orange outline.](/assets/images/help/billing/billing-remove-email-recipient.png) diff --git a/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md b/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md index 9d5cb4c608b5..9e6e780151a1 100644 --- a/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md +++ b/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md @@ -47,7 +47,7 @@ If no email addresses found in these attributes match the primary email address ## Fields in the consumed license files -The {% data variables.product.prodname_dotcom_the_website %} license usage report and {% data variables.product.prodname_ghe_server %} exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise. +The {% data variables.product.prodname_dotcom_the_website %} license usage report and {% data variables.product.prodname_ghe_server %} exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise. ### {% data variables.product.prodname_dotcom_the_website %} license usage report (CSV file) @@ -83,7 +83,7 @@ Your {% data variables.product.prodname_ghe_server %} license usage is a JSON fi | ----- | ----------- | Features | The {% data variables.product.prodname_github_connect %} features that are enabled on your {% data variables.product.prodname_ghe_server %} instance, and the date and time of enablement. | Host name | The hostname of your {% data variables.product.prodname_ghe_server %} instance. -| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`. +| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`. | License | A hash of your {% data variables.product.prodname_ghe_server %} license. | Public key | The public key portion of your {% data variables.product.prodname_ghe_server %} license. | Server ID | UUID generated for your {% data variables.product.prodname_ghe_server %} instance. diff --git a/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md b/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md index 31aba033f401..703c6712b171 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md @@ -29,7 +29,7 @@ Enabling GHAS across a large organization can be broken down into six core phase 2. [**Preparing to enable at scale**](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale): Prepare developers, collect data about your repositories, and ensure you're ready for the next phase. -3. [**Pilot programs**](/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs): Optionally, pilot an initial rollout to a few high-impact projects and teams. This will allow an initial group within your company to get familiar with GHAS before you roll out to the remainder of your company. +3. [**Pilot programs**](/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs): Optionally, pilot an initial rollout to a few high-impact projects and teams. This will allow an initial group within your company to get familiar with GHAS before you roll out to the remainder of your company. 4. [**Create internal documentation**](/code-security/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation): Create and communicate internal documentation for the consumers of GHAS. Without proper documentation provided to developers, security engineers, and others who will be using GHAS, the value will get lost in the rollout. diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md index 40b032e3d959..1c985507da5d 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md @@ -17,10 +17,10 @@ This article is part of a series on adopting {% data variables.product.prodname_ {% endnote %} ## Preparing to enable {% data variables.product.prodname_code_scanning %} - + {% data reusables.code-scanning.about-code-scanning %} For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)." -Rolling {% data variables.product.prodname_code_scanning %} out across hundreds of repositories can be difficult, especially when done inefficiently. Following these steps will ensure your rollout is both efficient and successful. As part of your preparation, you will work with your teams, use automation to collect data about your repositories, and enable {% data variables.product.prodname_code_scanning %}. +Rolling {% data variables.product.prodname_code_scanning %} out across hundreds of repositories can be difficult, especially when done inefficiently. Following these steps will ensure your rollout is both efficient and successful. As part of your preparation, you will work with your teams, use automation to collect data about your repositories, and enable {% data variables.product.prodname_code_scanning %}. ### Preparing teams for {% data variables.product.prodname_code_scanning %} @@ -148,7 +148,7 @@ If a project communicates with an external service, it might use a token or priv {% endnote %} {% endif %} -{% data variables.product.prodname_secret_scanning_caps %} detects a large number of default patterns but can also be configured to detect custom patterns, such as secret formats unique to your infrastructure or used by integrators that {% data variables.product.product_name %}'s {% data variables.product.prodname_secret_scanning %} does not currently detect. For more information about supported secrets for partner patterns, see "[AUTOTITLE](/code-security/secret-scanning/secret-scanning-patterns)." +{% data variables.product.prodname_secret_scanning_caps %} detects a large number of default patterns but can also be configured to detect custom patterns, such as secret formats unique to your infrastructure or used by integrators that {% data variables.product.product_name %}'s {% data variables.product.prodname_secret_scanning %} does not currently detect. For more information about supported secrets for partner patterns, see "[AUTOTITLE](/code-security/secret-scanning/secret-scanning-patterns)." As you audit your repositories and speak to security and developer teams, build a list of the secret types that you will later use to configure custom patterns for {% data variables.product.prodname_secret_scanning %}. For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository.md index ab5be1a52c3d..0d7d46f41ef7 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository.md @@ -128,15 +128,15 @@ The advanced setup for {% data variables.product.prodname_code_scanning %} is he 1. If the repository has already at least one workflow configured and running, click **New workflow** to display starter workflows. If there are currently no workflows configured for the repository, go to the next step. ![Screenshot of the Actions tab for a repository. The "New workflow" button is outlined in dark orange.](/assets/images/help/security/actions-new-workflow-button.png) - + 1. In the "Choose a workflow" or "Get started with {% data variables.product.prodname_actions %}" view, scroll down to the "Security" category and click **Configure** under the workflow you want to configure. You may need to click **View all** to find the security workflow you want to configure. ![Screenshot of the Security category of starter workflows. The Configure button and "View all" link are highlighted with an orange outline.](/assets/images/help/security/actions-workflows-security-section.png) - + 1. Follow any instructions in the workflow to customize it to your needs. For more general assistance about workflows, click **Documentation** on the right pane of the workflow page. ![Screenshot showing a starter workflow file open for editing. The "Documentation" button is highlighted with an orange outline.](/assets/images/help/security/actions-workflows-documentation.png) - + For more information, see "[AUTOTITLE](/actions/using-workflows/using-starter-workflows#using-starter-workflows)" and "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning)." {% endif %} diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md index a52d6166fbe0..a405802bb171 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md @@ -181,7 +181,7 @@ For more tips and tricks about why `autobuild` won't build your code, see "[AUTO If you added manual build steps for compiled languages and {% data variables.product.prodname_code_scanning %} is still not working on your repository, contact {% data variables.contact.contact_support %}. -{% ifversion codeql-swift-beta %} +{% ifversion codeql-swift-beta %} ### Considerations for building Swift {% data reusables.code-scanning.beta-swift-support %} diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md index 8aa2855ddfdf..1a66bf432903 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md @@ -24,7 +24,7 @@ topics: You can also create a new issue to track an alert: - From a {% data variables.product.prodname_code_scanning %} alert, which automatically adds the code scanning alert to a task list in the new issue. For more information, see "[Creating a tracking issue from a {% data variables.product.prodname_code_scanning %} alert](#creating-a-tracking-issue-from-a-code-scanning-alert)" below. -- Via the API as you normally would, and then provide the code scanning link within the body of the issue. You must use the task list syntax to create the tracked relationship: +- Via the API as you normally would, and then provide the code scanning link within the body of the issue. You must use the task list syntax to create the tracked relationship: - `- [ ] ` - For example, if you add `- [ ] https://github.com/octocat-org/octocat-repo/security/code-scanning/17` to an issue, the issue will track the code scanning alert that has an ID number of 17 in the **Security** tab of the `octocat-repo` repository in the `octocat-org` organization. @@ -36,11 +36,11 @@ You can use more than one issue to track the same {% data variables.product.prod ![Screenshot of the {% data variables.product.prodname_code_scanning %} alerts view. The first entry includes the issue icon followed by the number 2. The third entry includes the issue icon followed by the number 1. Both are outlined in dark orange.](/assets/images/help/repository/code-scanning-alert-list-tracked-issues.png) -- A "tracked in" section will also show in the corresponding alert page. +- A "tracked in" section will also show in the corresponding alert page. ![Screenshot of a {% data variables.product.prodname_code_scanning %} alert. Under the alert title, "Tracked by #1, #2" is outlined in dark orange.](/assets/images/help/repository/code-scanning-alert-tracked-in-pill.png) -- On the tracking issue, {% data variables.product.prodname_dotcom %} displays a security badge icon in the task list and on the hovercard. +- On the tracking issue, {% data variables.product.prodname_dotcom %} displays a security badge icon in the task list and on the hovercard. {% note %} @@ -61,14 +61,14 @@ The status of the tracked alert won't change if you change the checkbox state of {% data reusables.repositories.sidebar-code-scanning-alerts %} {% data reusables.code-scanning.explore-alert %} 1. Optionally, to find the alert to track, you can use the free-text search or the drop-down menus to filter and locate the alert. For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#filtering-code-scanning-alerts)." -1. Towards the top of the page, on the right side, click **Create issue**. +1. Towards the top of the page, on the right side, click **Create issue**. ![Screenshot of a {% data variables.product.prodname_code_scanning %} alert. The "Create issue" button is outlined in dark orange.](/assets/images/help/repository/code-scanning-create-issue-for-alert.png) {% data variables.product.prodname_dotcom %} automatically creates an issue to track the alert and adds the alert as a task list item. {% data variables.product.prodname_dotcom %} prepopulates the issue: - The title contains the name of the {% data variables.product.prodname_code_scanning %} alert. - - The body contains the task list item with the full URL to the {% data variables.product.prodname_code_scanning %} alert. + - The body contains the task list item with the full URL to the {% data variables.product.prodname_code_scanning %} alert. 2. Optionally, edit the title and the body of the issue. {% warning %} diff --git a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index 88e93fa0f82c..01430c23b15c 100644 --- a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -205,7 +205,7 @@ Before you can upload results to {% data variables.product.product_name %}, you - Saving the secret in the environment variable `GITHUB_TOKEN` and running the CLI without including the `--github-auth-stdin` option. - For testing purposes you can pass the `--github-auth-stdin` command-line option and supply a temporary token via standard input. -When you have decided on the most secure and reliable method for your CI server, run `codeql github upload-results` on each SARIF results file and include `--github-auth-stdin` unless the token is available in the environment variable `GITHUB_TOKEN`. +When you have decided on the most secure and reliable method for your CI server, run `codeql github upload-results` on each SARIF results file and include `--github-auth-stdin` unless the token is available in the environment variable `GITHUB_TOKEN`. ```shell # {% data variables.product.prodname_github_app %} or {% data variables.product.pat_generic %} available from a secret store diff --git a/content/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs.md b/content/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs.md index 33b00b67ca27..5587080c2e51 100644 --- a/content/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs.md +++ b/content/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs.md @@ -75,7 +75,7 @@ The following properties are supported in `qlpack.yml` files. #### `name` -- Required by all packs. +- Required by all packs. - Defines the scope of the pack, where the {% data variables.product.prodname_codeql %} pack is published, and the name of the pack defined using alphanumeric characters and hyphens. It must be unique as {% data variables.product.prodname_codeql %} cannot differentiate between {% data variables.product.prodname_codeql %} packs with identical names. Use the pack name to specify queries to run using `database analyze` and to define dependencies between {% data variables.product.prodname_codeql %} packs (see examples below). For example: ```yaml name: octo-org/security-queries @@ -155,7 +155,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `license` -- Optional. +- Optional. - Defines metadata that will be displayed on the packaging search page in the packages section of the account that the {% data variables.product.prodname_codeql %} pack is published to. For a list of allowed licenses, see [SPDX License List](https://spdx.org/licenses/) in the SPDX Specification. For example: ```yaml license: MIT @@ -169,7 +169,7 @@ The following properties are supported in `qlpack.yml` files. ``` #### `libraryPathDependencies` -- Optional, deprecated. Use the `dependencies` property instead. +- Optional, deprecated. Use the `dependencies` property instead. - Previously used to define the names of any {% data variables.product.prodname_codeql %} packs that this {% data variables.product.prodname_codeql %} pack depends on, as an array. This gives the pack access to any libraries, database schema, and query suites defined in the dependency. For example: ```yaml libraryPathDependencies: codeql/javascript-all diff --git a/content/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs.md b/content/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs.md index 13b88731d032..0e2575fcf2ea 100644 --- a/content/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs.md +++ b/content/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs.md @@ -84,7 +84,7 @@ This command downloads all dependencies to the shared cache on the local disk. {% note %} -**Notes:** +**Notes:** - Running the `codeql pack add` and `codeql pack install` commands will generate or update the `codeql-pack.lock.yml` file. This file should be checked-in to version control. The `codeql-pack.lock.yml` file contains the precise version numbers used by the pack. For more information, see "[About codeql-pack.lock.yml files](/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#about-codeql-pack-lock)." diff --git a/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases.md b/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases.md index bc84c037ddc1..eb378a743de7 100644 --- a/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases.md +++ b/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases.md @@ -55,7 +55,7 @@ You must specify: | Java{% ifversion codeql-kotlin-beta %}/Kotlin{% endif %} | `java` | JavaScript/TypeScript | `javascript` | Python | `python` -| Ruby | `ruby` {% ifversion codeql-swift-beta %} +| Ruby | `ruby` {% ifversion codeql-swift-beta %} | Swift | `swift` {% endif %} {% data reusables.code-scanning.beta-kotlin-or-swift-support %} @@ -213,7 +213,7 @@ The following examples are designed to give you an idea of some of the build com {% ifversion codeql-swift-beta %} - Swift project built from an Xcode project or workspace. By default, the largest Swift target is built: - + It's a good idea to ensure that the project is in a clean state and that there are no build artefacts available. ``` @@ -233,7 +233,7 @@ The following examples are designed to give you an idea of some of the build com codeql database create -l swift -c "xcodebuild build -target your-target" swift-database ``` - You can pass the `archive` and `test` options to `xcodebuild`. However, the standard `xcodebuild` command is recommended as it should be the fastest, and should be all that CodeQL requires for a successful scan. + You can pass the `archive` and `test` options to `xcodebuild`. However, the standard `xcodebuild` command is recommended as it should be the fastest, and should be all that CodeQL requires for a successful scan. - Swift project built using a custom build script: diff --git a/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md b/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md index 61ce2e93082c..468889f78a0b 100644 --- a/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md +++ b/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md @@ -25,11 +25,11 @@ shortTitle: Auto-update actions ## About {% data variables.product.prodname_dependabot_version_updates %} for actions -Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. When you enable {% data variables.product.prodname_dependabot_version_updates %} for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will help ensure that references to actions in a repository's _workflow.yml_ file{% ifversion dependabot-updates-actions-reusable-workflows %} and reusable workflows used inside workflows{% endif %} are kept up to date. +Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. When you enable {% data variables.product.prodname_dependabot_version_updates %} for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will help ensure that references to actions in a repository's _workflow.yml_ file{% ifversion dependabot-updates-actions-reusable-workflows %} and reusable workflows used inside workflows{% endif %} are kept up to date. For each action in the file, {% data variables.product.prodname_dependabot %} checks the action's reference (typically a version number or commit identifier associated with the action) against the latest version. If a more recent version of the action is available, {% data variables.product.prodname_dependabot %} will send you a pull request that updates the reference in the workflow file to the latest version. For more information about {% data variables.product.prodname_dependabot_version_updates %}, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates)." For more information about configuring workflows for {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/learn-github-actions)." -{% ifversion dependabot-updates-actions-reusable-workflows %} +{% ifversion dependabot-updates-actions-reusable-workflows %} {% data variables.product.prodname_dependabot %} also checks workflow files for uses of reusable workflows, and updates the git reference for these called reusable workflows. For more information about reusable workflows, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)." {% endif %} @@ -38,7 +38,7 @@ For each action in the file, {% data variables.product.prodname_dependabot %} ch ## Enabling {% data variables.product.prodname_dependabot_version_updates %} for actions -You can configure {% data variables.product.prodname_dependabot_version_updates %} to maintain your actions as well as the libraries and packages you depend on. +You can configure {% data variables.product.prodname_dependabot_version_updates %} to maintain your actions as well as the libraries and packages you depend on. 1. If you have already enabled {% data variables.product.prodname_dependabot_version_updates %} for other ecosystems or package managers, simply open the existing _dependabot.yml_ file. Otherwise, create a _dependabot.yml_ configuration file in the `.github` directory of your repository. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#enabling-dependabot-version-updates)." 1. Specify `"github-actions"` as a `package-ecosystem` to monitor. diff --git a/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md b/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md index 5f8dadbcc9e2..7b4cb6cdd02b 100644 --- a/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -58,7 +58,7 @@ It's worth noting that security advisories may exist for other ecosystems. The i The {% data variables.product.prodname_advisory_database %} was launched in November 2019, and initially back-filled to include advisories for security risks in the supported ecosystems, starting from 2017. When adding CVEs to the database, we prioritize curating newer CVEs, and CVEs affecting newer versions of software. -Some information on older vulnerabilities is available, especially where these CVEs are particularly widespread, however some old vulnerabilities are not included in the {% data variables.product.prodname_advisory_database %}. If there's a specific old vulnerability that you need to be included in the database, contact {% data variables.contact.contact_support %}. +Some information on older vulnerabilities is available, especially where these CVEs are particularly widespread, however some old vulnerabilities are not included in the {% data variables.product.prodname_advisory_database %}. If there's a specific old vulnerability that you need to be included in the database, contact {% data variables.contact.contact_support %}. **Check**: Does the uncaught vulnerability have a publish date earlier than 2017 in the National Vulnerability Database? diff --git a/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md b/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md index b8a37b87dde2..cb95c1db0872 100644 --- a/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md +++ b/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md @@ -53,11 +53,11 @@ Before defining a custom pattern, you must ensure that {% data variables.product {% 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**. {% note %} - + **Note**: The "Enable" button isn't available until after the dry run succeeds and you publish the pattern. - + {% endnote %} - + For more information about push protection, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." {% endif %} diff --git a/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md b/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md index 1ba7dae910ef..e99cfd45d217 100644 --- a/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md +++ b/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md @@ -106,7 +106,7 @@ Before enabling push protection for a custom pattern at enterprise level, you mu ![Screenshot of the custom pattern page with the button to enable push protection highlighted with a dark orange outline.](/assets/images/help/repository/secret-scanning-custom-pattern-enable-push-protection.png) {% endif %} -### Enabling {% data variables.product.prodname_secret_scanning %} as a push protection in an organization for a custom pattern +### Enabling {% data variables.product.prodname_secret_scanning %} as a push protection in an organization for a custom pattern Before enabling push protection for a custom pattern at organization level, you must ensure that you enable {% data variables.product.prodname_secret_scanning %} for the repositories that you want to scan in your organization. To enable {% data variables.product.prodname_secret_scanning %} on all repositories in your organization, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)." @@ -120,7 +120,7 @@ Before enabling push protection for a custom pattern at organization level, you ![Screenshot of the "Push protection" section of the custom pattern page. A button, labeled "Enable", is outlined in dark orange.](/assets/images/help/repository/secret-scanning-custom-pattern-enable-push-protection.png) -### Enabling {% data variables.product.prodname_secret_scanning %} as a push protection in a repository for a custom pattern +### Enabling {% data variables.product.prodname_secret_scanning %} as a push protection in a repository for a custom pattern Before enabling push protection for a custom pattern at repository level, you must define the custom pattern for the repository, and test it in the repository. For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository)." @@ -129,7 +129,7 @@ Before enabling push protection for a custom pattern at repository level, you mu {% data reusables.repositories.navigate-to-code-security-and-analysis %} {% data reusables.repositories.navigate-to-ghas-settings %} {% data reusables.advanced-security.secret-scanning-edit-custom-pattern %} -1. To enable push protection for your custom pattern, scroll down to "Push Protection", and click **Enable**. +1. To enable push protection for your custom pattern, scroll down to "Push Protection", and click **Enable**. ![Screenshot of the "Push protection" section of the custom pattern page. A button, labeled "Enable", is outlined in dark orange.](/assets/images/help/repository/secret-scanning-custom-pattern-enable-push-protection.png) diff --git a/content/code-security/secret-scanning/secret-scanning-patterns.md b/content/code-security/secret-scanning/secret-scanning-patterns.md index 4552575c9e8c..d00757c7d3e0 100644 --- a/content/code-security/secret-scanning/secret-scanning-patterns.md +++ b/content/code-security/secret-scanning/secret-scanning-patterns.md @@ -28,7 +28,7 @@ redirect_from: 3. **Push protection patterns.** Used to detect potential secrets in repositories with {% data variables.product.prodname_secret_scanning %} as a push protection enabled.{% endif %} {% ifversion fpt %} -Owners of public repositories, as well as organizations using {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_GH_advanced_security %}, can enable {% data variables.secret-scanning.user_alerts %} on their repositories. +Owners of public repositories, as well as organizations using {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_GH_advanced_security %}, can enable {% data variables.secret-scanning.user_alerts %} on their repositories. {% endif %} For details about all the supported patterns, see the "[Supported secrets](#supported-secrets)" section below. @@ -37,7 +37,7 @@ If you believe that {% data variables.product.prodname_secret_scanning %} should ## About partner alerts -Partner alerts are alerts that are sent to the secret providers whenever a secret leak is reported for one of their secrets. {% data variables.product.product_name %} currently scans public repositories and public npm packages for secrets issued by specific service providers and alerts the relevant service provider whenever a secret is detected in a commit. For more information about {% data variables.secret-scanning.partner_alerts %}, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-alerts-for-partners)." +Partner alerts are alerts that are sent to the secret providers whenever a secret leak is reported for one of their secrets. {% data variables.product.product_name %} currently scans public repositories and public npm packages for secrets issued by specific service providers and alerts the relevant service provider whenever a secret is detected in a commit. For more information about {% data variables.secret-scanning.partner_alerts %}, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-alerts-for-partners)." {% data reusables.secret-scanning.secret-scanning-pattern-pair-matches %} diff --git a/content/code-security/security-advisories/global-security-advisories/about-global-security-advisories.md b/content/code-security/security-advisories/global-security-advisories/about-global-security-advisories.md index 4f939280e8a7..41e351ba1801 100644 --- a/content/code-security/security-advisories/global-security-advisories/about-global-security-advisories.md +++ b/content/code-security/security-advisories/global-security-advisories/about-global-security-advisories.md @@ -20,7 +20,7 @@ topics: Global security advisories are grouped into two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories. - {% data variables.product.company_short %}-reviewed advisories are security vulnerabilities{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} that have been mapped to packages in ecosystems we support. -- Unreviewed advisories are security vulnerabilites that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. +- Unreviewed advisories are security vulnerabilites that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. For more information about the {% data variables.product.prodname_advisory_database %}, see "[AUTOTITLE](/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database)." diff --git a/content/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database.md b/content/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database.md index 7a32ad2b2b0c..af4cbe64ca73 100644 --- a/content/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database.md +++ b/content/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database.md @@ -24,7 +24,7 @@ Security advisories are published as JSON files in the Open Source Vulnerability {% data reusables.advisory-database.beta-malware-advisories %} -Each advisory in the {% data variables.product.prodname_advisory_database %} is for a vulnerability in open source projects{% ifversion GH-advisory-db-supports-malware %} or for malicious open source software{% endif %}. +Each advisory in the {% data variables.product.prodname_advisory_database %} is for a vulnerability in open source projects{% ifversion GH-advisory-db-supports-malware %} or for malicious open source software{% endif %}. {% data reusables.repositories.a-vulnerability-is %} Vulnerabilities in code are usually introduced by accident and fixed soon after they are discovered. You should update your code to use the fixed version of the dependency as soon as it is available. @@ -60,14 +60,14 @@ If you enable {% data variables.product.prodname_dependabot_alerts %} for your r ### Unreviewed advisories -Unreviewed advisories are security vulnerabilites that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. +Unreviewed advisories are security vulnerabilites that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. {% data variables.product.prodname_dependabot %} doesn't create {% data variables.product.prodname_dependabot_alerts %} for unreviewed advisories as this type of advisory isn't checked for validity or completion. ## About information in security advisories In this section, you can find more detailed information about security advisories in the {% data variables.product.prodname_advisory_database %}, such as: -- Advisory IDs and what format these identifiers use. +- Advisory IDs and what format these identifiers use. - The CVSS levels we used to assign severity levels. ### About GHSA IDs @@ -76,7 +76,7 @@ Each security advisory, regardless of its type, has a unique identifier referred The syntax of GHSA IDs follows this format: `GHSA-xxxx-xxxx-xxxx` where: -- `x` is a letter or a number from the following set: `23456789cfghjmpqrvwx`. +- `x` is a letter or a number from the following set: `23456789cfghjmpqrvwx`. - Outside the `GHSA` portion of the name: - The numbers and letters are randomly assigned. - All letters are lowercase. diff --git a/content/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database.md b/content/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database.md index 4f781991a4ec..b85f70caf943 100644 --- a/content/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database.md +++ b/content/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database.md @@ -91,13 +91,13 @@ For any {% data variables.product.company_short %}-reviewed advisory in the {% d If your site administrator has enabled {% data variables.product.prodname_github_connect %} for {% data variables.location.product_location %}, you can also browse reviewed advisories locally. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect)". -You can use your local advisory database to check whether a specific security vulnerability is included, and therefore whether you'd get alerts for vulnerable dependencies. You can also view any vulnerable repositories. +You can use your local advisory database to check whether a specific security vulnerability is included, and therefore whether you'd get alerts for vulnerable dependencies. You can also view any vulnerable repositories. 1. Navigate to `https://HOSTNAME/advisories`. 2. Optionally, to filter the list, use any of the drop-down menus. {% note %} - **Note:** Only reviewed advisories will be listed. Unreviewed advisories can be viewed in the {% data variables.product.prodname_advisory_database %} on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Accessing an advisory in the GitHub Advisory Database](#accessing-an-advisory-in-the-github-advisory-database)". + **Note:** Only reviewed advisories will be listed. Unreviewed advisories can be viewed in the {% data variables.product.prodname_advisory_database %} on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Accessing an advisory in the GitHub Advisory Database](#accessing-an-advisory-in-the-github-advisory-database)". {% endnote %} 3. Click an advisory to view details.{% ifversion GH-advisory-db-supports-malware %} By default, you will see {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. To show malware advisories, use `type:malware` in the search bar.{% endif %} diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities.md b/content/code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities.md index 4ad277e6e72b..63c53f20e9b7 100644 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities.md +++ b/content/code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities.md @@ -29,7 +29,7 @@ It's good practice to report vulnerabilities privately to maintainers. When poss - Disclosing the vulnerability before a fixed version of the code is available. - Expecting to be compensated for reporting an issue, where no public bounty program exists. -It's acceptable for vulnerability reporters to disclose a vulnerability publicly after a period of time, if they have tried to contact the maintainers and not received a response, or contacted them and been asked to wait too long to disclose it. +It's acceptable for vulnerability reporters to disclose a vulnerability publicly after a period of time, if they have tried to contact the maintainers and not received a response, or contacted them and been asked to wait too long to disclose it. We recommend vulnerability reporters clearly state the terms of their disclosure policy as part of their reporting process. Even if the vulnerability reporter does not adhere to a strict policy, it's a good idea to set clear expectations for maintainers in terms of timelines on intended vulnerability disclosures. For an example of disclosure policy, see the "[Security Lab's disclosure policy](https://securitylab.github.com/advisories#policy)" on the GitHub Security Lab website. @@ -59,8 +59,8 @@ There are two processes available on {% data variables.product.prodname_dotcom % The process for reporting and disclosing vulnerabilities for projects on {% data variables.product.prodname_dotcom_the_website %} is as follows: - If you are a vulnerability reporter (for example, a security researcher) who would like report a vulnerability, first check if there is a security policy for the related repository. For more information, see "[AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository#about-security-policies)." If there is one, follow it to understand the process before contacting the security team for that repository. - + If you are a vulnerability reporter (for example, a security researcher) who would like report a vulnerability, first check if there is a security policy for the related repository. For more information, see "[AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository#about-security-policies)." If there is one, follow it to understand the process before contacting the security team for that repository. + If there isn't a security policy in place, the most efficient way to establish a private means of communication with maintainers is to create an issue asking for a preferred security contact. It's worth noting that the issue will be immediately publicly visible, so it should not include any information about the bug. Once communication is established, you can suggest the maintainers define a security policy for future use. {% note %} diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing/best-practices-for-writing-repository-security-advisories.md b/content/code-security/security-advisories/guidance-on-reporting-and-writing/best-practices-for-writing-repository-security-advisories.md index 5f18d7271f31..753bf2fe94a6 100644 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing/best-practices-for-writing-repository-security-advisories.md +++ b/content/code-security/security-advisories/guidance-on-reporting-and-writing/best-practices-for-writing-repository-security-advisories.md @@ -30,7 +30,7 @@ If you follow the syntax for the {% data variables.product.prodname_advisory_dat - {% data variables.product.prodname_dependabot %} will have the information to accurately identify repositories that are affected and send them {% data variables.product.prodname_dependabot_alerts %} to notify them. - Community members are less likely to suggest edits to your advisory to fix missing or incorrect information. -You add or edit a repository advisory using the _Draft security advisory_ form. For more information, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory)." +You add or edit a repository advisory using the _Draft security advisory_ form. For more information, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory)." You suggest an improvement to an existing global advisory using the _Improve security advisory_ form. For more information, see "[AUTOTITLE](/code-security/security-advisories/global-security-advisories/editing-security-advisories-in-the-github-advisory-database)." diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities.md b/content/code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities.md index ea242f665dd0..4004afb485a6 100644 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities.md +++ b/content/code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities.md @@ -16,7 +16,7 @@ shortTitle: Manage vulnerability reports ## About privately reporting a security vulnerability -Private vulnerability reporting makes it easy for security researchers to report vulnerabilities directly to you using a simple form. +Private vulnerability reporting makes it easy for security researchers to report vulnerabilities directly to you using a simple form. When a security researcher reports a vulnerability privately, you are notified and can choose to either accept it, ask more questions, or reject it. If you accept the report, you're ready to collaborate on a fix for the vulnerability in private with the security researcher. @@ -32,7 +32,7 @@ For more information about configuring notification preferences, see "[AUTOTITLE 1. Click the advisory you want to review. An advisory that was reported privately has a status of `Triage`. ![Screenshot of a "Security Advisories" list.](/assets/images/help/security/advisory-list.png) - + 2. Carefully review the report, then choose how to proceed. - To collaborate on a patch in private, click **Start a temporary private fork** to create a place for further discussions with the contributor. This does not change the status of the proposed advisory from `Triage`. - To accept the reported vulnerability, click **Accept and open as draft** to accept the vulnerability report as a draft advisory on {% data variables.product.prodname_dotcom %}. If you choose this option: diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability.md b/content/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability.md index 0536f4d0e660..5ddc117b1d08 100644 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability.md +++ b/content/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability.md @@ -27,9 +27,9 @@ shortTitle: Privately reporting Security researchers often feel responsible for alerting users to a vulnerability that could be exploited. If there are no clear instructions about contacting maintainers of the repository containing the vulnerability, security researchers may have no other choice but to post about the vulnerability on social media, send direct messages to the maintainer, or even create public issues. This situation can potentially lead to a public disclosure of the vulnerability details. -Private vulnerability reporting makes it easy for security researchers to report vulnerabilities directly to repository maintainer using a simple form. +Private vulnerability reporting makes it easy for security researchers to report vulnerabilities directly to repository maintainer using a simple form. -For security researchers, the benefits of using private vulnerability reporting are: +For security researchers, the benefits of using private vulnerability reporting are: - Less frustration, and less time spent trying to figure out how to contact the maintainer. - A smoother process for disclosing and discussing vulnerability details. - The opportunity to discuss vulnerability details privately with repository maintainer. diff --git a/content/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository.md b/content/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository.md index 23f02b3a453f..92c66440872c 100644 --- a/content/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository.md +++ b/content/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository.md @@ -18,7 +18,7 @@ Security researchers often feel responsible for alerting users to a vulnerabilit {% data reusables.security-advisory.private-vulnerability-reporting-overview %} -For maintainers, the benefits of using private vulnerability reporting are: +For maintainers, the benefits of using private vulnerability reporting are: {% data reusables.security-advisory.private-vulnerability-reporting-benefits %} The instructions in this article refer to enablement at repository level. For information about enabling the feature at organization level, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization)." diff --git a/content/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization.md b/content/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization.md index 49049bab5fa5..d85aacf5cc39 100644 --- a/content/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization.md +++ b/content/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization.md @@ -18,7 +18,7 @@ Security researchers often feel responsible for alerting users to a vulnerabilit {% data reusables.security-advisory.private-vulnerability-reporting-overview %} -For organization owners and security managers, the benefits of using private vulnerability reporting are: +For organization owners and security managers, the benefits of using private vulnerability reporting are: {% data reusables.security-advisory.private-vulnerability-reporting-benefits %} The instructions below refer to enablement at organization level. For information about enabling the feature for a repository, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository)." diff --git a/content/code-security/security-advisories/repository-security-advisories/evaluating-the-security-settings-of-a-repository.md b/content/code-security/security-advisories/repository-security-advisories/evaluating-the-security-settings-of-a-repository.md index 3d2c591f06fc..4398f4f6d15a 100644 --- a/content/code-security/security-advisories/repository-security-advisories/evaluating-the-security-settings-of-a-repository.md +++ b/content/code-security/security-advisories/repository-security-advisories/evaluating-the-security-settings-of-a-repository.md @@ -16,15 +16,15 @@ shortTitle: Evaluate repository security Evaluating a public repository's security settings can help security researchers understand the repository's security posture. This information can help you decide whether to engage with the repository maintainers, for example, by reporting a vulnerability in the repository. -If a repository is public, high level information about the repository's security settings is available to anyone. For example, you can see whether the repository has a security policy, and whether private vulnerability reporting is enabled. You can also view published and closed security advisories for the repository. If no security policy is associated with a repository, you can suggest one. If the repository has private vulnerability reporting enabled, you can privately report security vulnerabilities directly to repository maintainers. +If a repository is public, high level information about the repository's security settings is available to anyone. For example, you can see whether the repository has a security policy, and whether private vulnerability reporting is enabled. You can also view published and closed security advisories for the repository. If no security policy is associated with a repository, you can suggest one. If the repository has private vulnerability reporting enabled, you can privately report security vulnerabilities directly to repository maintainers. If you have admin permissions to the repository, and the repository is owned by an organization, you can see more detailed information about the repository's security settings through the security overview. For more information on the security overview, see "[AUTOTITLE](/enterprise-cloud@latest/code-security/security-overview/about-security-overview){% ifversion ghec %}."{% else %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} If a repository is private, you can only see the security settings if you have admin permissions to the repository or have been granted special security permissions covering the repository, for example, as an organization-wide security manager. -## Suggesting a security policy for a repository +## Suggesting a security policy for a repository - If you do not have admin or security permissions for a public repository, you can still suggest a security policy to the repository maintainers if one doesn't already exist. The repository maintainers can then choose to accept or reject your suggestion. If the repository maintainers accept your suggestion, the security policy will be associated with the repository. + If you do not have admin or security permissions for a public repository, you can still suggest a security policy to the repository maintainers if one doesn't already exist. The repository maintainers can then choose to accept or reject your suggestion. If the repository maintainers accept your suggestion, the security policy will be associated with the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} diff --git a/content/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory.md b/content/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory.md index 38a43bdc0ea6..8d11f679e27e 100644 --- a/content/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory.md +++ b/content/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory.md @@ -61,7 +61,7 @@ When you publish a draft advisory from a public repository, everyone is able to {% endnote %} -After you publish a security advisory, the URL for the security advisory will remain the same as before you published the security advisory. Anyone with read access to the repository can see the security advisory. Collaborators on the security advisory can continue to view past conversations, including the full comment stream, in the security advisory unless someone with admin permissions removes the collaborator from the security advisory. +After you publish a security advisory, the URL for the security advisory will remain the same as before you published the security advisory. Anyone with read access to the repository can see the security advisory. Collaborators on the security advisory can continue to view past conversations, including the full comment stream, in the security advisory unless someone with admin permissions removes the collaborator from the security advisory. If you need to update or correct information in a security advisory that you've published, you can edit the security advisory. For more information, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/editing-a-repository-security-advisory)." diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md b/content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md index 019201946359..bec32541dbfb 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md +++ b/content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md @@ -24,7 +24,7 @@ For information about features in {% data variables.product.prodname_dotcom %} t ## About these guides -This series of guides explains how to think about securing your end-to-end supply chain: personal account, code, and build processes. Each guide explains the risk to that area, and introduces the {% data variables.product.product_name %} features that can help you address that risk. +This series of guides explains how to think about securing your end-to-end supply chain: personal account, code, and build processes. Each guide explains the risk to that area, and introduces the {% data variables.product.product_name %} features that can help you address that risk. Everyone's needs are different, so each guide starts with the highest impact change, and continues from there with additional improvements you should consider. You should feel free to skip around and focus on improvements you think will have the biggest benefit. The goal isn't to do everything at once but to continuously improve security in your systems over time. diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md index 2b1b7239cccf..7423bf5eda39 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md +++ b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md @@ -54,7 +54,7 @@ As a first step, you want to make a complete inventory of your dependencies. The ### Automatic detection of vulnerabilities in pull requests The {% data variables.dependency-review.action_name %} enforces a dependency review on your pull requests, making it easy for you to see if a pull request will introduce a vulnerable version of a dependency to your repository. When a vulnerability is detected, the {% data variables.dependency-review.action_name %} can block the pull request from merging. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement)."{% endif %} - + ### Assessment of exposure to risk from a vulnerable dependency When you discover you are using a vulnerable dependency, for example, a library or a framework, you must assess your project's level of exposure and determine what action to take. Vulnerabilities are usually reported with a severity score to show how severe their impact could be. The severity score is a useful guide but cannot tell you the full impact of the vulnerability on your code. diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md index 024001632ef0..0ed3c0e76b2e 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md @@ -61,7 +61,7 @@ The action uses the Dependency Review REST API to get the diff of dependency cha {% endif %} {% ifversion dependency-review-action-configuration %} -You can configure the {% data variables.dependency-review.action_name %} to better suit your needs. For example, you can specify the severity level that will make the action fail{% ifversion dependency-review-action-licenses %}, or set an allow or deny list for licenses to scan{% endif %}. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review#configuring-the-dependency-review-github-action)." +You can configure the {% data variables.dependency-review.action_name %} to better suit your needs. For example, you can specify the severity level that will make the action fail{% ifversion dependency-review-action-licenses %}, or set an allow or deny list for licenses to scan{% endif %}. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review#configuring-the-dependency-review-github-action)." {% endif %} {% endif %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md index d1f52feab13f..a2f58551b6af 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md @@ -29,7 +29,7 @@ If your company provides software to the US federal government per [Executive Or {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} 1. In the left sidebar, click **Dependency graph**. -1. On the top right side of the **Dependencies** tab, click **Export SBOM** to generate an SBOM file for download from your browser. +1. On the top right side of the **Dependencies** tab, click **Export SBOM** to generate an SBOM file for download from your browser. ## Exporting a software bill of material for your repository using the REST API diff --git a/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md b/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md index 15d4a22e8ea5..32d27753ab8e 100644 --- a/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md +++ b/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md @@ -31,7 +31,7 @@ You can optimize recovery time by configuring a `devcontainer.json` in the proje ## Option 2: Wait for recovery -In this case, no action on your part is required. Know that we are working diligently to restore service availability. +In this case, no action on your part is required. Know that we are working diligently to restore service availability. You can check the current service status on the [Status Dashboard](https://www.githubstatus.com/). diff --git a/content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md b/content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md index 0bd3ec04bdbc..8834f2522a72 100644 --- a/content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md +++ b/content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md @@ -66,7 +66,7 @@ If the shell you install isn't detected automatically, you can add a new termina ## Setting the default shell in {% data variables.product.prodname_vscode_shortname %} -You can set a default terminal profile to choose the default shell used for all new terminal windows you open in {% data variables.product.prodname_vscode_shortname %}. The default terminal profile is dependent on your operating system, so you can set a default profile for Linux, if you're using the {% data variables.product.prodname_vscode_shortname %} web client, or for your local operating system, if you're using the desktop application. +You can set a default terminal profile to choose the default shell used for all new terminal windows you open in {% data variables.product.prodname_vscode_shortname %}. The default terminal profile is dependent on your operating system, so you can set a default profile for Linux, if you're using the {% data variables.product.prodname_vscode_shortname %} web client, or for your local operating system, if you're using the desktop application. {% note %} @@ -116,7 +116,7 @@ sudo chsh "$(id -un)" --shell "/usr/bin/csh" **Note**: If you create a new codespace (for example by using `gh codespace create`), you must wait sufficient time to ensure the script has finished running before you connect to the codespace over SSH. If the script hasn't finished running, you will connect to a default `bash` session. -{% endnote %} +{% endnote %} When you have connected to the codespace, for most shells, you can use the command `readlink /proc/$$/exe` to check the correct shell is running. @@ -132,7 +132,7 @@ Generally, you should use a dotfiles repository to configure shells with your pr The `fish` shell includes a web-based configuration interface. You can use the `fish_config` command to start a local web server and launch this interface, then do things like change the terminal prompt or view your environment variables. -You can use the web-based interface for `fish` in a codespace. However, +You can use the web-based interface for `fish` in a codespace. However, the color settings in {% data variables.product.prodname_vscode_shortname %}'s integrated terminal depend on your chosen {% data variables.product.prodname_vscode_shortname %} theme, and you cannot override these settings by setting a new theme in the `fish_config` interface. When `fish` starts the local server, the default link that {% data variables.product.prodname_github_codespaces %} provides to the forwarded port does not work. For example, if you click **Open in Browser** on the popup message, you will be taken to an error page. diff --git a/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md b/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md index 13a2ca25318e..becc5cbec530 100644 --- a/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md +++ b/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md @@ -41,10 +41,12 @@ If you want to work on a codespace in a JetBrains IDE you must install the JetBr - If you choose **JetBrains Gateway**, the Gateway application will automatically open when you next create or open a codespace. - The first time you open a codespace this way you must give permission to open the application. + * If you choose **JetBrains Gateway**, the Gateway application will automatically open when you next create or open a codespace. + + The first time you open a codespace this way you must give permission to open the application. The Gateway application will open and the codespace will then be automatically selected. You can then choose a JetBrains IDE, if you have not previously done so, and click **Connect** to open the codespace in the JetBrains client. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide)." - + To connect to a codespace from the Gateway application, you must have an SSH server running on the codespace. {% indented_data_reference reusables.codespaces.ssh-server-installed spaces=5 %} - If you choose **JupyterLab**, the JupyterLab application must be installed in the codespaces you open. {% data reusables.codespaces.jupyterlab-in-default-image %} diff --git a/content/codespaces/developing-in-codespaces/connecting-to-a-private-network.md b/content/codespaces/developing-in-codespaces/connecting-to-a-private-network.md index 56ef5c00324b..cf8db654c0d1 100644 --- a/content/codespaces/developing-in-codespaces/connecting-to-a-private-network.md +++ b/content/codespaces/developing-in-codespaces/connecting-to-a-private-network.md @@ -19,13 +19,13 @@ By default, your codespaces have access to all resources on the public internet, There are currently two methods of accessing resources on a private network within {% data variables.product.prodname_github_codespaces %}. - Using a {% data variables.product.prodname_cli %} extension to configure your local machine as a gateway to remote resources. -- Using a VPN. +- Using a VPN. ### Using the GitHub CLI extension to access remote resources {% note %} -**Note**: The {% data variables.product.prodname_cli %} extension is currently in beta and subject to change. +**Note**: The {% data variables.product.prodname_cli %} extension is currently in beta and subject to change. {% endnote %} diff --git a/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md index 1996f60bd86d..630b63595f5d 100644 --- a/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ b/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md @@ -60,7 +60,7 @@ If you make a commit from the command line, you will see a prompt asking if you {% note %} -**Notes:** +**Notes:** - If you delete your fork repository, then any codespaces linked to the fork are deleted, even if you originally created them from the upstream repository. - If you make a commit from the command line and refuse the new fork by entering `n`, you should push your changes from the command line rather than from {% data variables.product.prodname_vscode_shortname %}'s Source Control view. If you use the Source Control view, {% data variables.product.prodname_vscode_shortname %} will still try to create a fork for you on push. diff --git a/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md index 98664637851b..a4f0bf923707 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md @@ -37,7 +37,7 @@ To allow people to create codespaces for which your organization will be billed, - [Set a spending limit](/billing/managing-billing-for-github-codespaces/managing-the-spending-limit-for-github-codespaces) - [Choose who can create codespaces that are billed to your organization](#choose-who-can-create-codespaces-that-are-billed-to-your-organization) -When you have set a spending limit, you can access settings for {% data variables.product.prodname_github_codespaces %} in your organization's settings and in repositories owned by your organization. For example, you can set up prebuilds for a repository, or you can set a policy to restrict the base image or machine type that can be used in your organization's codespaces. These policies apply to codespaces that your organization pays for, but not to codespaces created from your repositories that are billed to a user's personal account. +When you have set a spending limit, you can access settings for {% data variables.product.prodname_github_codespaces %} in your organization's settings and in repositories owned by your organization. For example, you can set up prebuilds for a repository, or you can set a policy to restrict the base image or machine type that can be used in your organization's codespaces. These policies apply to codespaces that your organization pays for, but not to codespaces created from your repositories that are billed to a user's personal account. You can also use the REST API to manage codespaces owned by your organization, for example to stop or delete a codespace. For more information, see "[AUTOTITLE](/rest/codespaces/organizations)" in the REST API documentation. diff --git a/content/codespaces/managing-codespaces-for-your-organization/listing-the-codespaces-in-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/listing-the-codespaces-in-your-organization.md index f159fc0fd0df..f214fe76beb3 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/listing-the-codespaces-in-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/listing-the-codespaces-in-your-organization.md @@ -29,8 +29,8 @@ To list all of the current codespaces for a specified organization, use the foll gh codespace list --org ORGANIZATION ``` -This command returns a list that includes the following information for each codespace: - - The name and display name +This command returns a list that includes the following information for each codespace: + - The name and display name - The user who created the codespace - The repository and branch - The current state of the codespace diff --git a/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces.md b/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces.md index b20a51901f32..7b7e30407d63 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces.md +++ b/content/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces.md @@ -39,7 +39,7 @@ Secrets are limited to 48 KB in size. ### Recommended secrets for a repository -Your project may require specific user secrets. For example, to run the application in a codespace, the user may need to supply a personal API key. If this is the case, you can specify recommended secrets in the dev container configuration. The user will then be prompted to supply values for these secrets, if they haven't already created these personal secrets, when they use the advanced options page to create a codespace. If the user supplies a secret value for use in the codespace, this secret is added to their personal settings for {% data variables.product.prodname_codespaces %}. They will not have to enter a value for this secret when they create a codespace for this repository in future. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/specifying-recommended-secrets-for-a-repository)." +Your project may require specific user secrets. For example, to run the application in a codespace, the user may need to supply a personal API key. If this is the case, you can specify recommended secrets in the dev container configuration. The user will then be prompted to supply values for these secrets, if they haven't already created these personal secrets, when they use the advanced options page to create a codespace. If the user supplies a secret value for use in the codespace, this secret is added to their personal settings for {% data variables.product.prodname_codespaces %}. They will not have to enter a value for this secret when they create a codespace for this repository in future. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/specifying-recommended-secrets-for-a-repository)." ## Adding secrets for a repository diff --git a/content/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization.md index 82d46c323a9f..67d5c3401c93 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization.md @@ -25,10 +25,10 @@ To learn about pricing for {% data variables.product.prodname_github_codespaces ## Spending limits You can set a spending limit for {% data variables.product.prodname_github_codespaces %} for your organization. This limit is applied to the total compute and storage cost for {% data variables.product.prodname_github_codespaces %}. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/managing-the-spending-limit-for-github-codespaces)." - -- **Compute usage:** This is the total time during which all {% data variables.product.prodname_github_codespaces %} instances ("codespaces") were active in a billing month. -- **Storage usage:** For {% data variables.product.prodname_github_codespaces %} billing purposes, this includes all files used by all codespaces and prebuilds in your account. This includes resources such as cloned repositories, configuration files, and extensions, among others. +- **Compute usage:** This is the total time during which all {% data variables.product.prodname_github_codespaces %} instances ("codespaces") were active in a billing month. + +- **Storage usage:** For {% data variables.product.prodname_github_codespaces %} billing purposes, this includes all files used by all codespaces and prebuilds in your account. This includes resources such as cloned repositories, configuration files, and extensions, among others. You can check the compute and storage usage for {% data variables.product.prodname_github_codespaces %} for the current billing month. For information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/viewing-your-github-codespaces-usage)." @@ -58,7 +58,7 @@ Repository owners who set up prebuilds for their repository can reduce the stora ## Deleting unused codespaces -Your users can delete their own codespaces in https://github.com/codespaces and from within {% data variables.product.prodname_vscode %}. To reduce the size of a codespace, users can manually delete files using the terminal or from within {% data variables.product.prodname_vscode_shortname %}. +Your users can delete their own codespaces in https://github.com/codespaces and from within {% data variables.product.prodname_vscode %}. To reduce the size of a codespace, users can manually delete files using the terminal or from within {% data variables.product.prodname_vscode_shortname %}. As an organization owner, you can delete any codespace in your organization. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/deleting-a-codespace#deleting-codespaces-in-your-organization)." diff --git a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-number-of-organization-billed-codespaces-a-user-can-create.md b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-number-of-organization-billed-codespaces-a-user-can-create.md index 9056acca8e41..1fdd3c43e581 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-number-of-organization-billed-codespaces-a-user-can-create.md +++ b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-number-of-organization-billed-codespaces-a-user-can-create.md @@ -14,11 +14,11 @@ product: '{% data reusables.gated-features.codespaces-org %}' ## Overview -By default, if organization members, or collaborators, are permitted to create codespaces that are billable to your organization, they can create multiple such codespaces. The number of organization-billed codespaces someone can create is governed by a limit to the total number of codespaces that they can create across all repositories they can access. This limit is set by {% data variables.product.company_short %}. +By default, if organization members, or collaborators, are permitted to create codespaces that are billable to your organization, they can create multiple such codespaces. The number of organization-billed codespaces someone can create is governed by a limit to the total number of codespaces that they can create across all repositories they can access. This limit is set by {% data variables.product.company_short %}. As an organization owner, you can restrict the number of codespaces that each user can create, where the costs of the codespace are billable to the organization. This can help to reduce the overall cost of {% data variables.product.prodname_github_codespaces %} to the organization, as there is a charge for codespace storage. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#about-billing-for-storage-usage)." -To restrict the maximum number of organization-billed codespaces that users can create, you create a policy in the {% data variables.product.prodname_codespaces %} settings for your organization. For example, if you set the maximum to 2, users who already have 2 active or stopped codespaces that are billed to your organization will have to delete one of these before they can create a new codespace that's billed to the organization. +To restrict the maximum number of organization-billed codespaces that users can create, you create a policy in the {% data variables.product.prodname_codespaces %} settings for your organization. For example, if you set the maximum to 2, users who already have 2 active or stopped codespaces that are billed to your organization will have to delete one of these before they can create a new codespace that's billed to the organization. This setting does not restrict users from creating codespaces that are not billed to your organization. For example, they can create additional codespaces for public repositories, using their personal {% data variables.product.prodname_codespaces %} usage allowance. However, users who are permitted to create organization-billed codespaces, but have reached the limit for such codespaces, cannot choose to create a codespace for an organization-owned repository using their personal included allowance. diff --git a/content/codespaces/overview.md b/content/codespaces/overview.md index 31275d486192..de5553918794 100644 --- a/content/codespaces/overview.md +++ b/content/codespaces/overview.md @@ -21,7 +21,7 @@ topics: A codespace is a development environment that's hosted in the cloud. You can customize your project for {% data variables.product.prodname_github_codespaces %} by committing [configuration files](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers) to your repository (often known as Configuration-as-Code), which creates a repeatable codespace configuration for all users of your project. -Each codespace you create is hosted by {% data variables.product.prodname_dotcom %} in a Docker container, running on a virtual machine. You can choose from a selection of virtual machine types, from 2 cores, 8 GB RAM, and 32 GB storage, up to 32 cores, 64 GB RAM, and 128 GB storage. +Each codespace you create is hosted by {% data variables.product.prodname_dotcom %} in a Docker container, running on a virtual machine. You can choose from a selection of virtual machine types, from 2 cores, 8 GB RAM, and 32 GB storage, up to 32 cores, 64 GB RAM, and 128 GB storage. By default, codespaces are created from an Ubuntu Linux image that includes a selection of popular languages and tools, but you can use an image based on a Linux distribution of your choice and configure it for your particular requirements. Regardless of your local operating system, your codespace will run in a Linux environment. Windows and MacOS are not supported operating systems for the remote container. diff --git a/content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md b/content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md index a9486090aacb..b325464395f4 100644 --- a/content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md +++ b/content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md @@ -33,19 +33,19 @@ If your project requires write access to resources, or if the external resources You will need to create a new personal account and then use this account to create a {% data variables.product.pat_v1 %} with the appropriate scopes. -1. Create a new personal account on {% data variables.product.prodname_dotcom %}. - +1. Create a new personal account on {% data variables.product.prodname_dotcom %}. + {% warning %} - + **Warning**: Although you can generate the {% data variables.product.pat_v1 %} using your existing personal account, we strongly recommend creating a new account with access only to the target repositories required for your scenario. This is because the access token's `repository` permission grants access to all of the repositories that the account has access to. For more information, see "[AUTOTITLE](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)" and "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#considering-cross-repository-access)." - + {% endwarning %} 1. Give the new account read access to the required repositories. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository)." 1. While signed into the new account, create a {% data variables.product.pat_v1 %} with the `repo` scope. Optionally, if the prebuild will need to download packages from the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %}, also select the `read:packages` scope. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - ![Screenshot of the "Select scopes" configuration options for a {% data variables.product.pat_v1 %}, with the "repo" and "read:packages" scopes selected.](/assets/images/help/codespaces/prebuilds-select-scopes.png) - - If the prebuild will use a package from the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %}, you will need to either grant the new account access to the package or configure the package to inherit the access permissions of the repository you are prebuilding. For more information, see "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." + ![Screenshot of the "Select scopes" configuration options for a {% data variables.product.pat_v1 %}, with the "repo" and "read:packages" scopes selected.](/assets/images/help/codespaces/prebuilds-select-scopes.png) + + If the prebuild will use a package from the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %}, you will need to either grant the new account access to the package or configure the package to inherit the access permissions of the repository you are prebuilding. For more information, see "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% ifversion ghec %} 1. Click **Configure SSO** and authorize the token for use with SAML single sign-on (SSO), so that it can access repositories that are owned by organizations with SSO enabled. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)." @@ -53,7 +53,7 @@ You will need to create a new personal account and then use this account to crea {% endif %} 1. Copy the token string. You will assign this to a {% data variables.product.prodname_codespaces %} repository secret. -1. Sign back into the account that has admin access to the repository. +1. Sign back into the account that has admin access to the repository. 1. In the repository for which you want to create {% data variables.product.prodname_github_codespaces %} prebuilds, create a new {% data variables.product.prodname_codespaces %} repository secret called `CODESPACES_PREBUILD_TOKEN`, giving it the value of the token you created and copied. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-a-repository)." The {% data variables.product.pat_generic %} will be used for all subsequent prebuilds created for your repository. Unlike other {% data variables.product.prodname_codespaces %} repository secrets, the `CODESPACES_PREBUILD_TOKEN` secret is only used for prebuilding and will not be available to use in codespaces created from your repository. diff --git a/content/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/specifying-recommended-secrets-for-a-repository.md b/content/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/specifying-recommended-secrets-for-a-repository.md index 5750c18f8127..66de172eeef7 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/specifying-recommended-secrets-for-a-repository.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/specifying-recommended-secrets-for-a-repository.md @@ -38,7 +38,7 @@ Each recommended secret is displayed in one of three ways: ### When to specify recommended secrets for a project -You should use recommended secrets for secrets that the user who creates the codespace, rather than the owner of the repository or organization, must provide. For example, if you have a public project, and users must provide a personal API key to run the application in your project, you can specify a recommended secret so that users will be prompted to provide the key as the value of the secret when they use the advanced options page to create a codespace. +You should use recommended secrets for secrets that the user who creates the codespace, rather than the owner of the repository or organization, must provide. For example, if you have a public project, and users must provide a personal API key to run the application in your project, you can specify a recommended secret so that users will be prompted to provide the key as the value of the secret when they use the advanced options page to create a codespace. Alternatively, for secrets that the owner of the repository or organization can provide, such as API keys shared across a team, you can set secrets at the level of the repository or organization. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces)." @@ -58,7 +58,7 @@ Alternatively, for secrets that the owner of the repository or organization can ``` 1. Add a property within `secrets` for each secret you want to recommend. For example, change `NAME_OF_SECRET_1` and `NAME_OF_SECRET_2`, in the previous code example, to the names of the secrets that people should create in their personal settings for {% data variables.product.prodname_codespaces %}. -1. Optionally, supply a description for each secret and a URL for more information about this secret. +1. Optionally, supply a description for each secret and a URL for more information about this secret. You can omit `description` and `documentationUrl`, as shown by `NAME_OF_SECRET_2` in the previous code example. diff --git a/content/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository.md b/content/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository.md index 3e48aa7957f8..b5ef7fca2474 100644 --- a/content/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository.md +++ b/content/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository.md @@ -49,16 +49,16 @@ You can then add the token as an environment variable in a codespace, or as an e To use the token to authenticate in your codespace, you have the following options. -- When you create the environment variable or encrypted secret, you can use the name `GH_TOKEN`. The `GH_TOKEN` variable is used by default in {% data variables.product.prodname_cli %} operations, so you can clone the repository using the command `gh repo clone OWNER/REPO`. +- When you create the environment variable or encrypted secret, you can use the name `GH_TOKEN`. The `GH_TOKEN` variable is used by default in {% data variables.product.prodname_cli %} operations, so you can clone the repository using the command `gh repo clone OWNER/REPO`. - However, if you then try to push to the repository using `git push`, Git's credential helper will try to use the existing `GITHUB_TOKEN` to authenticate, and authentication will fail. You can override the helper, but this may introduce friction when you try to interact with the original repository from which you created the codespace. + However, if you then try to push to the repository using `git push`, Git's credential helper will try to use the existing `GITHUB_TOKEN` to authenticate, and authentication will fail. You can override the helper, but this may introduce friction when you try to interact with the original repository from which you created the codespace. - You can clone the repository with a URL that includes the access token. Replace `YOUR-VARIABLE` with the name of the environment variable or encrypted secret you created. ```shell git clone https://PAT:$YOUR-VARIABLE@github.com/OWNER/REPO` ``` - This will store the access token for the specific repository, so you will be able to push to and pull from the repository without overriding the existing credential helper. + This will store the access token for the specific repository, so you will be able to push to and pull from the repository without overriding the existing credential helper. {% note %} diff --git a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index ed73ba1106af..29964558a655 100644 --- a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -15,7 +15,7 @@ shortTitle: Creation and deletion ### No access to create a codespace {% data variables.product.prodname_github_codespaces %} is not available for all repositories. If the options for creating a codespace are not displayed, {% data variables.product.prodname_github_codespaces %} may not be available for that repository. -If you have remaining monthly included usage of {% data variables.product.prodname_github_codespaces %} on your personal account, or you have set up a payment method and a spending limit, you can create a codespace for any public repository. +If you have remaining monthly included usage of {% data variables.product.prodname_github_codespaces %} on your personal account, or you have set up a payment method and a spending limit, you can create a codespace for any public repository. You can also create a codespace for any private repository to which you have at least read access, provided this private repository is owned by a personal account. If a repository is private {% ifversion ghec %}or internal {% endif %}and is owned by an organization, you may or may not be able to create a codespace for that repository, depending on the settings of the organization or its parent enterprise. diff --git a/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md index 51e3d123752b..b5821560d150 100644 --- a/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md @@ -22,7 +22,7 @@ error: gpg failed to sign the data fatal: failed to write commit object ``` -You may encounter this error if: +You may encounter this error if: - You have disabled GPG verification, and are trying to make a regular, unsigned commit in an existing codespace. - You have enabled GPG verification, but have overridden the Git configuration required for {% data variables.product.prodname_github_codespaces %} to sign your commits, for example by linking {% data variables.product.prodname_github_codespaces %} with a dotfiles repository that contains Git configuration files. @@ -43,7 +43,7 @@ To check that the value has been correctly removed from your configuration, you ## Errors caused by conflicting configuration -To automatically sign your commits, {% data variables.product.prodname_github_codespaces %} sets certain Git configuration values in your codespace. If you override the values set by {% data variables.product.prodname_github_codespaces %}, you may be unable to sign your commits. +To automatically sign your commits, {% data variables.product.prodname_github_codespaces %} sets certain Git configuration values in your codespace. If you override the values set by {% data variables.product.prodname_github_codespaces %}, you may be unable to sign your commits. You may be inadvertently overriding these values if you have linked {% data variables.product.prodname_github_codespaces %} with a dotfiles repository that contains Git configuration files. For more information about using dotfiles with {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." @@ -91,10 +91,10 @@ For example, if the global `.gitconfig` file on your local machine contains a `g $ git config --global --unset gpg.program ``` 3. Push the change to your dotfiles repository on {% data variables.product.prodname_dotcom %}. -4. Optionally, to keep your local configuration, set the value again in a Git configuration file that you do not push to your dotfiles repository. +4. Optionally, to keep your local configuration, set the value again in a Git configuration file that you do not push to your dotfiles repository. For example, you can use the `--system` flag to set the configuration in the system-level file at `PATH/etc/gitconfig`, where `PATH` is the directory in which Git is installed on your system. - + ```Shell $ git config --system gpg.program gpg2 ``` diff --git a/content/codespaces/troubleshooting/troubleshooting-included-usage.md b/content/codespaces/troubleshooting/troubleshooting-included-usage.md index 7ca69c3b2434..93d2af053d60 100644 --- a/content/codespaces/troubleshooting/troubleshooting-included-usage.md +++ b/content/codespaces/troubleshooting/troubleshooting-included-usage.md @@ -51,7 +51,7 @@ You can check the cumulative {% data variables.product.prodname_github_codespace ![Screenshot of the "{% data variables.product.prodname_codespaces %}" section of the billing page showing figures for "Usage hours" and "Storage."](/assets/images/help/codespaces/view-personal-usage-collapsed.png) -You can expand the "Usage hours" and "Storage" section for more information - for example, to see how much of the consumed storage was used by prebuilds. +You can expand the "Usage hours" and "Storage" section for more information - for example, to see how much of the consumed storage was used by prebuilds. For more specific information - for example, if you want to know which repositories have prebuilds that are consuming storage - you can generate a usage report. The usage report is a CSV file that's emailed to you. For more information on how to generate a usage report, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/viewing-your-github-codespaces-usage)." diff --git a/content/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md index 1bb659002a2f..5e95cc6eb1ca 100644 --- a/content/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md @@ -21,7 +21,7 @@ If your codespace fails to pick up configuration settings from dotfiles, you sho 1. Enable dotfiles by selecting **Automatically install dotfiles** in [your personal {% data variables.product.prodname_github_codespaces %} settings](https://github.com/settings/codespaces). - ![Screenshot of the "Dotfiles" section of the codespace settings, with the "Automatically install dotfiles" option cleared.](/assets/images/help/codespaces/install-custom-dotfiles.png) + ![Screenshot of the "Dotfiles" section of the codespace settings, with the "Automatically install dotfiles" option cleared.](/assets/images/help/codespaces/install-custom-dotfiles.png) 1. Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned. - If your dotfiles were cloned, try manually re-running your install script to verify that it is executable. diff --git a/content/communities/documenting-your-project-with-wikis/about-wikis.md b/content/communities/documenting-your-project-with-wikis/about-wikis.md index 92121a38600d..b533a0108680 100644 --- a/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -17,7 +17,7 @@ topics: Every repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." -With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. +With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. {% data reusables.getting-started.math-and-diagrams %} diff --git a/content/copilot/getting-started-with-github-copilot.md b/content/copilot/getting-started-with-github-copilot.md index d5a991afaccf..791ec2ffc269 100644 --- a/content/copilot/getting-started-with-github-copilot.md +++ b/content/copilot/getting-started-with-github-copilot.md @@ -57,15 +57,15 @@ To use {% data variables.product.prodname_copilot %} in a JetBrains IDE, you mus 1. In your JetBrains IDE, under the **File** menu for Windows or under the name of your IDE for Mac (for example, **PyCharm** or **IntelliJ**), click **Settings** for Windows or **Preferences** for Mac. 1. In the left-side menu of the **Settings/Preferences** dialog box, click **Plugins**. 1. At the top of the **Settings/Preferences** dialog box, click **Marketplace**. In the search bar, search for **{% data variables.product.prodname_copilot %}**, then click **Install**. - + ![Screenshot of the "Preferences" window. A tab labeled "Marketplace" is highlighted with an orange outline. In a list of search results, the installed "GitHub Copilot" plugin is marked by a selected checkbox.](/assets/images/help/copilot/jetbrains-marketplace.png) 1. After {% data variables.product.prodname_copilot %} is installed, click **Restart IDE**. 1. After your JetBrains IDE has restarted, click the **Tools** menu. Click **{% data variables.product.prodname_copilot %}**, then click **Login to {% data variables.product.prodname_dotcom %}**. - + ![Screenshot of the expanded "Tools" menu and "{% data variables.product.prodname_copilot %}" sub-menu. The "Login to {% data variables.product.prodname_dotcom %}" option is highlighted in blue.](/assets/images/help/copilot/jetbrains-tools-menu.png) 1. In the "Sign in to {% data variables.product.prodname_dotcom %}" dialog box, to copy the device code and open the device activation window, click **Copy and Open**. - + ![Screenshot of the "Sign in to {% data variables.product.prodname_dotcom %}" dialog. A device code is displayed above a button labeled "Copy and Open".](/assets/images/help/copilot/device-code-copy-and-open.png) 1. A device activation window will open in your browser. Paste the device code, then click **Continue**. 1. {% data variables.product.prodname_dotcom %} will request the necessary permissions for {% data variables.product.prodname_copilot %}. To approve these permissions, click **Authorize {% data variables.product.prodname_copilot %} Plugin**. @@ -133,13 +133,13 @@ To use {% data variables.product.prodname_copilot %} in a JetBrains IDE, you mus You can enable or disable {% data variables.product.prodname_copilot %} for all languages, or for individual languages. The {% data variables.product.prodname_copilot %} status icon in the bottom panel of your JetBrains IDE window indicates whether {% data variables.product.prodname_copilot %} is enabled or disabled. When enabled, the icon is highlighted. When disabled, the icon is grayed out. 1. To enable or disable {% data variables.product.prodname_copilot %}, click the status icon in the bottom panel of the JetBrains window. - + ![Screenshot of the IntelliJ IDEA toolbar. The {% data variables.product.prodname_copilot %} logo is highlighted with an orange outline.](/assets/images/help/copilot/status-icon-jetbrains.png) 1. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable it globally, or for the language of the file you are currently editing. - To disable suggestions from {% data variables.product.prodname_copilot %} globally, click **Disable Completions**. - To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click **Disable Completions for _LANGUAGE_**. - + ![Screenshot of option to disable {% data variables.product.prodname_copilot %} globally or for the current language.](/assets/images/help/copilot/disable-copilot-global-or-langugage-jetbrains.png) ## Further reading @@ -173,10 +173,10 @@ If you use {% data variables.product.prodname_vs %}, you can view and incorporat To use {% data variables.product.prodname_copilot %}, you must first install the {% data variables.product.prodname_vs %} extension. 1. In the Visual Studio menu bar, click **Extensions**, then click **Manage Extensions**. - + ![Screenshot of the menu bar in Visual Studio. The "Extensions" menu is open, and the "Manage Extensions" option is highlighted with an orange outline.](/assets/images/help/copilot/visual-studio-toolbar.png) 1. In the "Manage Extensions" window, click **Visual Studio Marketplace**, search for the {% data variables.product.prodname_copilot %} extension, then click **Download**. - + ![Screenshot of a list of search results. Next to the {% data variables.product.prodname_copilot %} extension, the "Download" button is highlighted with an orange outline.](/assets/images/help/copilot/install-copilot-extension-visual-studio.png) 1. Close the "Manage Extensions" window, then exit and relaunch {% data variables.product.prodname_vs %}. 1. Optionally, to check that {% data variables.product.prodname_copilot %} is installed and enabled, go back to **Manage Extensions**, click **Installed** to view your currently installed extensions, then click **{% data variables.product.prodname_copilot %}** to see status information. diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md index b5e345f96d01..63d069f7bc27 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md @@ -85,5 +85,5 @@ To add comments to a pull request, leave a review, or merge the pull request, yo 1. In the {% data variables.product.prodname_desktop %} menu bar, click **Branch**. 1. Select **View Pull Request on {% data variables.product.prodname_dotcom %}**. - + ![Screenshot of the menu bar on a Mac. The "Branch" dropdown menu is expanded, and the cursor hovers over "View Pull Request on {% data variables.product.prodname_dotcom %}".](/assets/images/help/desktop/view-pr-on-github.png) diff --git a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md index 66845a2a3ddc..6c017caa71fd 100644 --- a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md @@ -14,7 +14,7 @@ versions: ## Updating {% data variables.product.prodname_desktop %} 1. In the menu bar, select **{% data variables.product.prodname_desktop %}**, then click **About {% data variables.product.prodname_desktop %}**. - + ![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) 2. In the modal window, click **Check for Updates**. @@ -39,11 +39,11 @@ If you encounter a crash when attempting to launch {% data variables.product.pro {% windows %} 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) - + 2. 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) 3. If an update is available, quit and relaunch {% data variables.product.prodname_desktop %} to install the update. diff --git a/content/discussions/managing-discussions-for-your-community/creating-discussion-category-forms.md b/content/discussions/managing-discussions-for-your-community/creating-discussion-category-forms.md index 1e71f40f1fda..e5f25c432e0b 100644 --- a/content/discussions/managing-discussions-for-your-community/creating-discussion-category-forms.md +++ b/content/discussions/managing-discussions-for-your-community/creating-discussion-category-forms.md @@ -8,11 +8,11 @@ versions: ## About discussion category forms -You can encourage community members to include specific, structured information in their discussions by using discussion forms in your repository. With discussion category forms, you can create discussion templates that have customizable web form fields. Discussion forms are written in YAML using the {% data variables.product.prodname_dotcom %} form schema. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema)." +You can encourage community members to include specific, structured information in their discussions by using discussion forms in your repository. With discussion category forms, you can create discussion templates that have customizable web form fields. Discussion forms are written in YAML using the {% data variables.product.prodname_dotcom %} form schema. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema)." {% data reusables.actions.learn-more-about-yaml %} -To use a discussion category form in your repository, you must create a new file and add it to the `/.github/DISCUSSION_TEMPLATE/` folder in your repository. +To use a discussion category form in your repository, you must create a new file and add it to the `/.github/DISCUSSION_TEMPLATE/` folder in your repository. You can also create discussion category forms for your organization. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." @@ -24,9 +24,9 @@ Here is the rendered version of the issue form. ## Creating discussion category forms -People with write access to a repository can create a discussion category form. +People with write access to a repository can create a discussion category form. -1. Navigate to the repository where you want to create a discussion category form. +1. Navigate to the repository where you want to create a discussion category form. 2. In your repository, create a file called `/.github/DISCUSSION_TEMPLATE/FORM-NAME.yml`, replacing `FORM-NAME` with the name for your discussion category form. {% data reusables.discussions.discussion-category-forms-name %} For more information about creating new files on GitHub, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." 3. In the body of the new file, type the contents of your discussion category form. For more information, see "[AUTOTITLE](/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms)." 4. Commit your file to the default branch of your repository. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." diff --git a/content/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms.md b/content/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms.md index 6c5992213dae..4e648866a148 100644 --- a/content/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms.md +++ b/content/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms.md @@ -8,7 +8,7 @@ versions: ## About YAML syntax for discussion category forms -You can create custom discussion category forms by adding a YAML form definition file to the `/.github/DISCUSSION_TEMPLATE/` folder in your repository. {% data reusables.actions.learn-more-about-yaml %} +You can create custom discussion category forms by adding a YAML form definition file to the `/.github/DISCUSSION_TEMPLATE/` folder in your repository. {% data reusables.actions.learn-more-about-yaml %} {% data reusables.discussions.discussion-category-forms-name %} diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md index bd3025ea2847..e505c6fed784 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md @@ -30,7 +30,7 @@ To read about how GitHub is used by educators, see [GitHub Education stories](ht - You must offer {% data variables.product.prodname_dotcom %} to all of your technical and academic departments and your school’s logo will be shared on the GitHub Education website as a {% data variables.product.prodname_campus_program %} Partner. -- New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact [GitHub Education Support](https://support.github.com/contact/education). For more information about administrating your enterprise, see the [enterprise administrators documentation](/admin). New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact GitHub Education Support. +- New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact [GitHub Education Support](https://support.github.com/contact/education). For more information about administrating your enterprise, see the [enterprise administrators documentation](/admin). New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact GitHub Education Support. To read more about {% data variables.product.prodname_dotcom %}'s privacy practices, see "[AUTOTITLE](/site-policy/privacy-policies/github-privacy-statement)." diff --git a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md index e31a7eb5b876..b29052f0a6b8 100644 --- a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md @@ -12,7 +12,7 @@ versions: {% data variables.product.prodname_classroom %} is a teaching tool that lets teachers and school administrators create and manage digital classrooms and assignments. You can create assignments for individual students or groups of students, set due dates, and track assignments on your teacher dashboard. Additionally, {% data variables.product.prodname_classroom %} has many features that simplify tasks like providing feedback, grading assignments, and integrating your existing teaching tools. -## {% data variables.product.prodname_classroom %} features +## {% data variables.product.prodname_classroom %} features {% data variables.product.prodname_classroom %} offers a variety of features to simplify both teaching and learning. diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md index d2001a110827..b8a43c2c34f1 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md @@ -21,7 +21,7 @@ Your existing GitHub Classroom repls will remain private forever and you can sub While you can no longer create private repls from within Classroom, you can continue to create private repls in Replit until September 30th. -We know cloud IDE integrations are important to your classroom and are working hard to bring you more options. +We know cloud IDE integrations are important to your classroom and are working hard to bring you more options. ## Further reading diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md index 006aa6c72ebe..fc709a771ef6 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md @@ -29,7 +29,7 @@ With {% data variables.product.prodname_classroom %}, you can create individual {% endnote %} -## Types of assignments +## Types of assignments You can create both individual assignments and group assignments with {% data variables.product.prodname_classroom %}. diff --git a/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md b/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md index 19dab3459110..4b73bd71ecc5 100644 --- a/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md +++ b/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md @@ -41,7 +41,7 @@ If you encounter a bug in an open source project, check if the bug has already b There are a variety of ways that you can contribute to open source projects. ### Reproducing a reported bug -You can contribute to an open source project by validating an issue or adding additional context to an existing issue. +You can contribute to an open source project by validating an issue or adding additional context to an existing issue. ### Testing a pull request You can contribute to an open source project by merging a pull request into your local copy of the project and testing the changes. Add the outcome of your testing in a comment on the pull request. diff --git a/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md b/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md index 9548fc4d3379..4eac94132787 100644 --- a/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md +++ b/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md @@ -62,7 +62,7 @@ Curate repositories that you've starred with public lists. You can create public If you add a private repository to a list, then the private repository will only appear in your list for people with `read` access to the repository. -You can add a repository to an existing or new list wherever you see a repository's **Star** or **Starred** dropdown menu, whether on a repository page or in a list of starred repositories. +You can add a repository to an existing or new list wherever you see a repository's **Star** or **Starred** dropdown menu, whether on a repository page or in a list of starred repositories. ![Screenshot of a repository page. The "Star" dropdown menu is expanded, with a list options highlighted with a dark orange outline.](/assets/images/help/stars/stars-dropdown-on-repo.png) @@ -104,7 +104,7 @@ You can add a repository to an existing or new list wherever you see a repositor ## Searching starred repositories and topics -You can use the search bar on your {% data variables.explore.your_stars_page %} to quickly find repositories and topics you've starred. +You can use the search bar on your {% data variables.explore.your_stars_page %} to quickly find repositories and topics you've starred. {% data reusables.stars.stars-page-navigation %} 1. Use the search bar to find your starred repositories or topics by their name. diff --git a/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md b/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md index f3c09c86b9f4..7f3316f1f6a5 100644 --- a/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md +++ b/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md @@ -77,7 +77,7 @@ Once you've authenticated successfully, your credentials are stored in the Windo {% warning %} -**Warning:** If you cached incorrect or outdated credentials in Credential Manager for Windows, Git will fail to access {% data variables.product.product_name %}. To reset your cached credentials so that Git prompts you to enter your credentials, access the Credential Manager in the Windows Control Panel under User Accounts > Credential Manager. Look for the {% data variables.product.product_name %} entry and delete it. +**Warning:** If you cached incorrect or outdated credentials in Credential Manager for Windows, Git will fail to access {% data variables.product.product_name %}. To reset your cached credentials so that Git prompts you to enter your credentials, access the Credential Manager in the Windows Control Panel under User Accounts > Credential Manager. Look for the {% data variables.product.product_name %} entry and delete it. {% endwarning %} diff --git a/content/get-started/getting-started-with-git/why-is-git-always-asking-for-my-password.md b/content/get-started/getting-started-with-git/why-is-git-always-asking-for-my-password.md index b7eb2bc31745..303e44202a78 100644 --- a/content/get-started/getting-started-with-git/why-is-git-always-asking-for-my-password.md +++ b/content/get-started/getting-started-with-git/why-is-git-always-asking-for-my-password.md @@ -13,7 +13,7 @@ versions: ghec: '*' shortTitle: Git passwords --- -Using an HTTPS remote URL has some advantages compared with using SSH. It's easier to set up than SSH, and usually works through strict firewalls and proxies. However, it also prompts you to enter your {% data variables.product.product_name %} credentials every time you pull or push a repository. +Using an HTTPS remote URL has some advantages compared with using SSH. It's easier to set up than SSH, and usually works through strict firewalls and proxies. However, it also prompts you to enter your {% data variables.product.product_name %} credentials every time you pull or push a repository. {% data reusables.user-settings.password-authentication-deprecation %} diff --git a/content/get-started/learning-about-github/access-permissions-on-github.md b/content/get-started/learning-about-github/access-permissions-on-github.md index 0d06d8d13231..3945c28580fa 100644 --- a/content/get-started/learning-about-github/access-permissions-on-github.md +++ b/content/get-started/learning-about-github/access-permissions-on-github.md @@ -21,7 +21,7 @@ shortTitle: Access permissions ## About access permissions on {% data variables.product.prodname_dotcom %} -{% data reusables.organizations.about-roles %} +{% data reusables.organizations.about-roles %} Roles work differently for different types of accounts. For more information about accounts, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)." @@ -40,7 +40,7 @@ Organization members can have _owner_{% ifversion fpt or ghec %}, _billing manag ## Enterprise accounts {% ifversion fpt %} -{% data reusables.gated-features.enterprise-accounts %} +{% data reusables.gated-features.enterprise-accounts %} For more information about permissions for enterprise accounts, see [the {% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/get-started/learning-about-github/access-permissions-on-github). {% else %} diff --git a/content/get-started/onboarding/getting-started-with-github-team.md b/content/get-started/onboarding/getting-started-with-github-team.md index 80053a065374..1bbc782450d0 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -71,7 +71,7 @@ You can help to make your organization more secure by recommending or requiring ### 3. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### 4. Publishing and managing {% data variables.product.prodname_registry %} +### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community diff --git a/content/get-started/quickstart/create-a-repo.md b/content/get-started/quickstart/create-a-repo.md index e1c1dc4c87aa..99ae9522272c 100644 --- a/content/get-started/quickstart/create-a-repo.md +++ b/content/get-started/quickstart/create-a-repo.md @@ -79,13 +79,13 @@ When you created your new repository, you initialized it with a _README_ file. _ Let's commit a change to the README file. 1. In your repository's list of files, select **README.md**. - + ![Screenshot of a list of files in a repository. A file name, "README.md", is highlighted with an orange outline.](/assets/images/help/repository/create-commit-open-readme.png) {% data reusables.repositories.edit-file-button %} 1. In the text box, type some information about yourself. {% data reusables.files.preview_change %} 1. Review the changes you made to the file. If you select **Show diff**, you will see the new content in green. - + ![Screenshot of the "Preview" view for a file. A checkbox labeled "Show diff" is selected, and an addition to the file is indicated by a green line marker. Both are outlined in orange.](/assets/images/help/repository/create-commit-review.png) {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} diff --git a/content/get-started/quickstart/fork-a-repo.md b/content/get-started/quickstart/fork-a-repo.md index 3fad2a45004e..da44647bc98e 100644 --- a/content/get-started/quickstart/fork-a-repo.md +++ b/content/get-started/quickstart/fork-a-repo.md @@ -57,7 +57,7 @@ You might fork a project to propose changes to the upstream repository. In this 1. On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.location.product_location %}{% endif %}, navigate to the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. 1. In the top-right corner of the page, click **Fork**. - + ![Screenshot of the main page of repository. A button, labeled with a fork icon and "Fork 59.3k," is outlined in dark orange.](/assets/images/help/repository/fork_button.png) {%- ifversion fpt or ghec or ghes > 3.5 or ghae > 3.5 %} 1. Under "Owner," select the dropdown menu and click an owner for the forked repository. diff --git a/content/get-started/quickstart/git-cheatsheet.md b/content/get-started/quickstart/git-cheatsheet.md index 41336c14cf0e..77a638780422 100644 --- a/content/get-started/quickstart/git-cheatsheet.md +++ b/content/get-started/quickstart/git-cheatsheet.md @@ -11,6 +11,6 @@ versions: ghec: '*' intro: This Git cheat sheet is a time saver when you forget a command or don't want to use help in the CLI. --- -Learning all available Git commands at once can be a daunting task. You can use "[Git Cheat Sheets](https://training.github.com/)" for a quick reference to frequently used commands. The "Using Git" cheat sheet is available in several languages. +Learning all available Git commands at once can be a daunting task. You can use "[Git Cheat Sheets](https://training.github.com/)" for a quick reference to frequently used commands. The "Using Git" cheat sheet is available in several languages. In addition, take a look at our [Git and GitHub learning resources](/get-started/quickstart/git-and-github-learning-resources) page that links to guides, videos and more. diff --git a/content/get-started/quickstart/hello-world.md b/content/get-started/quickstart/hello-world.md index ae31c362ea34..906bb9d31466 100644 --- a/content/get-started/quickstart/hello-world.md +++ b/content/get-started/quickstart/hello-world.md @@ -74,7 +74,7 @@ Here at {% data variables.product.product_name %}, our developers, writers, and 3. Type a branch name, `readme-edits`, into the text box. 4. Click **Create branch: readme-edits from main**. - + ![Screenshot of the branch dropdown for a repository. "Create branch: readme-edits from 'main'" is outlined in dark orange.](/assets/images/help/repository/new-branch.png) Now you have two branches, `main` and `readme-edits`. Right now, they look exactly the same. Next you'll add changes to the new branch. @@ -90,7 +90,7 @@ You can make and save changes to the files in your repository. On {% data variab {% ifversion code-search-code-view %} 1. Click **Commit changes...**. 1. In the "Propose changes" box, write a commit message that describes your changes. -1. Click **Propose changes**. +1. Click **Propose changes**. {% else %} 1. In the "Commit changes" box, write a commit message that describes your changes. 1. Click **Commit changes**. diff --git a/content/get-started/quickstart/set-up-git.md b/content/get-started/quickstart/set-up-git.md index a6fb27ac3296..1281627e66a3 100644 --- a/content/get-started/quickstart/set-up-git.md +++ b/content/get-started/quickstart/set-up-git.md @@ -42,12 +42,12 @@ If you do not need to work with files locally, {% data variables.product.product 1. [Download and install the latest version of Git](https://git-scm.com/downloads). {% note %} - + **Note**: If you are using a Chrome OS device, additional setup is required: - + 1. Install a terminal emulator such as Termux from the Google Play Store on your Chrome OS device. - 1. From the terminal emulator that you installed, install Git. For example, in Termux, enter `apt install git` and then type `y` when prompted. - + 1. From the terminal emulator that you installed, install Git. For example, in Termux, enter `apt install git` and then type `y` when prompted. + {% endnote %} 1. [Set your username in Git](/get-started/getting-started-with-git/setting-your-username-in-git). @@ -73,7 +73,7 @@ If you clone with SSH, you must generate SSH keys on each computer you use to pu ## Next steps -You now have Git and {% data variables.product.prodname_dotcom %} all set up. You may now choose to create a repository where you can put your projects. Saving your code in a repository allows you to back up your code and share it around the world. +You now have Git and {% data variables.product.prodname_dotcom %} all set up. You may now choose to create a repository where you can put your projects. Saving your code in a repository allows you to back up your code and share it around the world. - {% data reusables.getting-started.create-a-repository %}. diff --git a/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md b/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md index cd960d73f51d..fb30a58c9ad6 100644 --- a/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md +++ b/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md @@ -49,13 +49,13 @@ If you create a new clone of the repository, you won't lose any of your Git hist > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (89/89) > Ref 'refs/heads/BRANCH-NAME' was rewritten ``` - + The repository should now only contain the files that were in your subfolder(s). 6. [Create a new repository](/repositories/creating-and-managing-repositories/creating-a-new-repository) on {% data variables.product.product_name %}. 7. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}'s Quick Setup page, click {% octicon "copy" aria-label="Copy to clipboard" %} to copy the remote repository URL. - + ![Screenshot of the "Quick Setup" header in a repository. Next to the remote URL, an icon of two overlapping squares is highlighted with an orange outline.](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) {% tip %} diff --git a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/saving-gists-with-stars.md b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/saving-gists-with-stars.md index fd9e5e79bca7..59df777a16ba 100644 --- a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/saving-gists-with-stars.md +++ b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/saving-gists-with-stars.md @@ -9,7 +9,7 @@ versions: --- ## Starring a gist -You can star a gist to add it to the "Starred" page. Starring makes it easy to find a gist again later. +You can star a gist to add it to the "Starred" page. Starring makes it easy to find a gist again later. 1. Navigate to {% data variables.gists.discover_url %} and select the gist you want to star. 1. To star the gist, click {% octicon "star" aria-hidden="true" %} **Star** in the top-right corner of the page. diff --git a/content/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md b/content/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md index 2af73caea2fb..8a4784f37036 100644 --- a/content/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md +++ b/content/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md @@ -13,7 +13,7 @@ versions: --- {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.saved_replies %} -1. Under "Add a saved reply", add a title for your saved reply. +1. Under "Add a saved reply", add a title for your saved reply. 2. In the "Write" field, add the content you'd like to use for the saved reply. For information on using Markdown, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." ![Screenshot of a {% data variables.product.prodname_dotcom %} saved reply titled "Squirrel ship" showing Markdown in the "Write" box. The text reads, "This looks great. :shipit: it!"](/assets/images/help/writing/saved-replies-settings-adding.png) 1. To review your reply, click **Preview**. diff --git a/content/graphql/guides/migrating-graphql-global-node-ids.md b/content/graphql/guides/migrating-graphql-global-node-ids.md index 6cb05b56ddcd..7ad0df822a2c 100644 --- a/content/graphql/guides/migrating-graphql-global-node-ids.md +++ b/content/graphql/guides/migrating-graphql-global-node-ids.md @@ -11,7 +11,7 @@ shortTitle: Migrating global node IDs ## Background -The {% data variables.product.product_name %} GraphQL API currently supports two types of global node ID formats. The legacy format will be deprecated and replaced with a new format. This guide shows you how to migrate to the new format, if necessary. +The {% data variables.product.product_name %} GraphQL API currently supports two types of global node ID formats. The legacy format will be deprecated and replaced with a new format. This guide shows you how to migrate to the new format, if necessary. By migrating to the new format, you ensure that the response times of your requests remain consistent and small. You also ensure that your application continues to work once the legacy IDs are fully deprecated. @@ -25,7 +25,7 @@ Additionally, if you currently decode the legacy IDs to extract type information ## Migrating to the new global IDs -To facilitate migration to the new ID format, you can use the `X-Github-Next-Global-ID` header in your GraphQL API requests. The value of the `X-Github-Next-Global-ID` header can be `1` or `0`. Setting the value to `1` will force the response payload to always use the new ID format for any object that you requested the `id` field for. Setting the value to `0` will revert to default behavior, which is to show the legacy ID or new ID depending on the object creation date. +To facilitate migration to the new ID format, you can use the `X-Github-Next-Global-ID` header in your GraphQL API requests. The value of the `X-Github-Next-Global-ID` header can be `1` or `0`. Setting the value to `1` will force the response payload to always use the new ID format for any object that you requested the `id` field for. Setting the value to `0` will revert to default behavior, which is to show the legacy ID or new ID depending on the object creation date. Here is an example request using a `curl` command: @@ -41,7 +41,7 @@ Even though the legacy ID `MDQ6VXNlcjM0MDczMDM=` was used in the query, the resp ``` {"data":{"node":{"id":"U_kgDOADP9xw"}}} ``` -With the `X-Github-Next-Global-ID` header, you can find the new ID format for legacy IDs that you reference in your application. You can then update those references with the ID received in the response. You should update all references to legacy IDs and use the new ID format for any subsequent requests to the API. +With the `X-Github-Next-Global-ID` header, you can find the new ID format for legacy IDs that you reference in your application. You can then update those references with the ID received in the response. You should update all references to legacy IDs and use the new ID format for any subsequent requests to the API. To perform bulk operations, you can use aliases to submit multiple node queries in one API call. For more information, see "[the GraphQL docs](https://graphql.org/learn/queries/#aliases)." You can also get the new ID for a collection of items. For example, if you wanted to get the new ID for the last 10 repositories in your organization, you could use a query like this: diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md index 3cd46bbabe21..c5511f23f1a8 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md @@ -54,7 +54,7 @@ You can use templates to quickly set up a new {% data variables.projects.project | Template | Description | | --- | --- | | Basic kanban | Track your tasks with To do, In progress, and Done columns | -| Automated kanban | Cards automatically move between To do, In progress, and Done columns | +| Automated kanban | Cards automatically move between To do, In progress, and Done columns | | Automated kanban with review | Cards automatically move between To do, In progress, and Done columns, with additional triggers for pull request review status | | Bug triage | Triage and prioritize bugs with To do, High priority, Low priority, and Closed columns | diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md index 307362641c0c..c18f26bbc085 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md @@ -23,7 +23,7 @@ allowTitleToDifferFromFilename: true 1. Navigate to the {% data variables.projects.projects_v1_board %} you want to edit. {% data reusables.project-management.click-menu %} -{% data reusables.project-management.click-edit-sidebar-menu-project-board %} +{% data reusables.project-management.click-edit-sidebar-menu-project-board %} 4. Modify the {% data variables.projects.projects_v1_board %} name and description as needed, then click **Save project**. ## Further reading diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md index ddf945fe412d..d010300fd31d 100644 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md +++ b/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md @@ -49,7 +49,7 @@ The auto-add workflow is limited per plan. ![Screenshot showing the workflow menu bar. The "Edit" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/workflow-start-editing.png) -1. Under "Filters", select the repository you want to add items from. +1. Under "Filters", select the repository you want to add items from. 1. Next to the repository selection, type the filter criteria you want items to match before they are automatically added to your project. 1. To enable the new workflow, click **Save and turn on workflow**. diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md index ede786bcd4ee..34db9b579e31 100644 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md +++ b/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md @@ -37,7 +37,7 @@ Projects also have a limit on the number of archived items they can contain. You 1. In the "Filters" field, type the filter criteria you want to use to automatically archive items. You can only use the `is`, `reason`, and `updated` filters.{% ifversion projects-v2-workflows-ui-refresh %} 1. To save your changes and enable the workflow, click **Save and turn on workflow**.{% else %} 1. If the workflow is disabled, click the toggle next to **Off** to enable the workflow.{% endif %} - + ## Further reading - "[AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)" diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index cc43fa11ea02..e9607078ed8e 100644 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -112,7 +112,7 @@ gh api graphql -f query=' ``` {% endcli %} -### Finding the node ID of a user project +### Finding the node ID of a user project To update your project through the API, you will need to know the node ID of the project. @@ -273,9 +273,9 @@ The response will look similar to the following example: } ``` -Each field has an ID and name. Single select fields are returned as a `ProjectV2SingleSelectField` object and have an `options` field where you can find the ID of each option for the single select. Iteration fields are returned as a `ProjectV2IterationField` object and have a `configuration` field which includes an `iterations` field containing the ID and information about each iteration. +Each field has an ID and name. Single select fields are returned as a `ProjectV2SingleSelectField` object and have an `options` field where you can find the ID of each option for the single select. Iteration fields are returned as a `ProjectV2IterationField` object and have a `configuration` field which includes an `iterations` field containing the ID and information about each iteration. -If you just need the name and ID of a field, and do not need information about iterations or a single select field's options, you can make use of the `ProjectV2FieldCommon` object. +If you just need the name and ID of a field, and do not need information about iterations or a single select field's options, you can make use of the `ProjectV2FieldCommon` object. {% curl %} ```shell @@ -341,7 +341,7 @@ The response when using the `ProjectV2FieldCommon` object will look similar to t } ``` -### Finding information about items in a project +### Finding information about items in a project You can query the API to find information about items in your project. @@ -425,7 +425,7 @@ gh api graphql -f query=' A project may contain items that a user does not have permission to view. In this case, the item type will be returned as `REDACTED`. -## Updating projects +## Updating projects Use mutations to update projects. For more information, see "[AUTOTITLE](/graphql/guides/forming-calls-with-graphql#about-mutations)." @@ -517,7 +517,7 @@ The response will contain the node ID of the newly created draft issue. } ``` -### Updating a project's settings +### Updating a project's settings The following example will update your project's settings. Replace `PROJECT_ID` with the node ID of your project. Set `public` to `true` to make your project public on {% data variables.product.product_name %}. Modify `readme` to make changes to your project's README. @@ -554,7 +554,7 @@ gh api graphql -f query=' ``` {% endcli %} -### Updating a custom text, number, or date field +### Updating a custom text, number, or date field The following example will update the value of a text field for an item. Replace `PROJECT_ID` with the node ID of your project. Replace `ITEM_ID` with the node ID of the item you want to update. Replace `FIELD_ID` with the ID of the field that you want to update. @@ -712,7 +712,7 @@ gh api graphql -f query=' ``` {% endcli %} -## Managing projects +## Managing projects ### Creating projects diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md index 4739c1918451..b118b84f08b1 100644 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md +++ b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md @@ -40,7 +40,7 @@ You can change the order of fields. 1. Click the field header. ![Screenshot showing three field headers. One of the headers is highlighted with an orange outline.](/assets/images/help/projects-v2/select-field-header.png) - + 2. While continuing to click, drag the field to the required location. ## Reordering rows @@ -50,7 +50,7 @@ You can change the order of rows. 1. Click the number at the start of the row. ![Screenshot showing three rows on a table layout. One of the row numbers is highlighted with an orange outline.](/assets/images/help/projects-v2/select-row-number.png) - + 2. While continuing to click, drag the row to the required location. ## Sorting by field values diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views.md index 2ffa8d1db999..ba0b5407e16b 100644 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views.md +++ b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views.md @@ -11,7 +11,7 @@ topics: ## Creating a project view -Project views allow you to quickly view specific aspects of your project. Each view is displayed on a separate tab in your project. +Project views allow you to quickly view specific aspects of your project. Each view is displayed on a separate tab in your project. For example, you can have: - A view that shows all items not yet started (filter on "Status"). @@ -36,7 +36,7 @@ You can duplicate an existing view and use it as a base to make further changes. ## Saving changes to a view -When you make changes to a view - for example, sorting, reordering, filtering, or grouping the data in a view - a dot is displayed next to the view name to indicate that there are unsaved changes. +When you make changes to a view - for example, sorting, reordering, filtering, or grouping the data in a view - a dot is displayed next to the view name to indicate that there are unsaved changes. ![Screenshot of a tab for a view labeled "Issues by priority." Next to the view's name, a dropdown icon is marked by a blue dot.](/assets/images/help/projects/unsaved-changes.png) diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md index 00d05e644af7..3b5a9629ba91 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md @@ -15,7 +15,7 @@ allowTitleToDifferFromFilename: true ## About project access -Admins of organization-level projects can manage access for the entire organization, for teams, for individual organization members, and for outside collaborators. +Admins of organization-level projects can manage access for the entire organization, for teams, for individual organization members, and for outside collaborators. Admins of user-level projects can invite individual collaborators and manage their access. @@ -44,7 +44,7 @@ The default base role is `write`, meaning that everyone in the organization can 2. Under **Base role**, select the default role. ![Screenshot showing the "Who has access" settings. The dropdown for setting the base role is highlighted with an orange outline.](/assets/images/help/projects-v2/base-role.png) - + - **No access**: Only organization owners and users granted individual access can see the project. Organization owners are also admins for the project. - **Read**: Everyone in the organization can see the project. Organization owners are also admins for the project. - **Write**: Everyone in the organization can see and edit the project. Organization owners are also admins for the project. @@ -67,7 +67,7 @@ You can only invite an individual user to collaborate on your organization-level 2. Under **Invite collaborators**, search for the team or individual user that you want to invite. ![Screenshot showing searching for a collaborator.](/assets/images/help/projects-v2/access-search.png) - + 3. Select the role for the collaborator. - **Read**: The team or individual can view the project. - **Write**: The team or individual can view and edit the project. @@ -81,7 +81,7 @@ You can only invite an individual user to collaborate on your organization-level 1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. You can use the **Type** and **Role** drop-down menus to filter the access list. - + ![Screenshot of the "Manage access" section. The octocat is listed as a collaborator.](/assets/images/help/projects-v2/access-find-member.png) 1. Edit the role for the collaborator(s). @@ -102,7 +102,7 @@ This only affects collaborators for your project, not for repositories in your p 2. Under **Invite collaborators**, search for the user that you want to invite. ![Screenshot showing searching for a collaborator.](/assets/images/help/projects-v2/access-search.png) - + 3. Select the role for the collaborator. - **Read**: The individual can view the project. - **Write**: The individual can view and edit the project. @@ -116,7 +116,7 @@ This only affects collaborators for your project, not for repositories in your p 1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. You can use the **Type** and **Role** drop-down menus to filter the access list. - + ![Screenshot of the "Manage access" section. The octocat is listed as a collaborator.](/assets/images/help/projects-v2/access-find-member.png) 1. Edit the role for the collaborator(s). diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md index a9e4e6b5be05..df9a8474272f 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md @@ -13,7 +13,7 @@ redirect_from: You can filter by your single select fields by specifying the option, for example: `fieldname:option`. You can filter for multiple values by providing a comma-separated list of options, for example: `fieldname:option,option`. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects)." -Single select fields can contain up to 50 options. +Single select fields can contain up to 50 options. ## Adding a single select field @@ -33,14 +33,14 @@ You can set descriptions and colors for each of your single select options. 1. Access your project's settings. 1. To the right of the single select field you want to edit, click {% octicon "pencil" aria-label="The pencil icon" %}. - + ![Screenshot of the single select options. The pencil icon, by one of the options, is highlighted with an orange outline.](/assets/images/help/projects-v2/edit-single-select.png) - + 1. In the modal that opens, under **Label text**, type the name of this option. -1. Optionally, under **Color**, select the color you want to use to represent this option. - +1. Optionally, under **Color**, select the color you want to use to represent this option. + ![Screenshot of the modal for editing a single select option. The blue color option is highlighted with an orange outline.](/assets/images/help/projects-v2/edit-single-select-color.png) - + 1. Optionally, under **Description**, type a description for this option. 1. Click **Save** to save your changes. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md index db93a3513461..989c3d3875b6 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md @@ -13,7 +13,7 @@ redirect_from: You can use text fields to include notes or any other freeform text in your project. -Text fields can be used in filters, for example: `field:"exact text"`. Text fields and item titles will also be used if you filter for text without specifying a field. +Text fields can be used in filters, for example: `field:"exact text"`. Text fields and item titles will also be used if you filter for text without specifying a field. Number fields can also be used in filters. You can use `>`, `>=`, `<`, `<=`, and `..` range queries to filter by a number field. For example: `field:5..15` or `field:>=20`. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects)." diff --git a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts.md b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts.md index 0f6195b8fc9a..5d8204533983 100644 --- a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts.md +++ b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts.md @@ -18,5 +18,5 @@ topics: 1. To change the type of chart, select the **Layout** dropdown and click on the chart type you want to use. 1. To change the field used for your chart's X-axis, select the **X-axis** dropdown and click the field you want to use. 1. Optionally, to group the items on your X-axis by another field, select **Group by** and click on the field you want to use, or click "None" to disable grouping. -1. Optionally, if your project contains number fields and you want the Y-axis to display the sum, average, minimum, or maximum of one of those number fields, select **Y-axis** and click an option. Then, select the dropdown that appears beneath and click on the number field you want to use. +1. Optionally, if your project contains number fields and you want the Y-axis to display the sum, average, minimum, or maximum of one of those number fields, select **Y-axis** and click an option. Then, select the dropdown that appears beneath and click on the number field you want to use. 1. To save your chart, click **Save changes**. diff --git a/content/issues/tracking-your-work-with-issues/about-tasklists.md b/content/issues/tracking-your-work-with-issues/about-tasklists.md index da1fc794cd04..7b768a5ae3dc 100644 --- a/content/issues/tracking-your-work-with-issues/about-tasklists.md +++ b/content/issues/tracking-your-work-with-issues/about-tasklists.md @@ -29,7 +29,7 @@ The issues you add to your tasklists will be automatically populated to show the **Note:** If {% data variables.product.product_name %} cannot render your tasklist, make sure it is formatted like the example below. -Tasklists do not currently support: +Tasklists do not currently support: - Duplicate issue or pull request links. - Indented tasks (i.e, nested tasklist). diff --git a/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md index b55ae576be5d..3f4017a30c3f 100644 --- a/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md +++ b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md @@ -22,7 +22,7 @@ You can view and revoke each member's linked identity, active sessions, and auth ## Viewing and revoking a linked identity -{% data reusables.saml.about-linked-identities %} +{% data reusables.saml.about-linked-identities %} When available, the entry will include SCIM data. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 6a9af77e2db0..f83474a14559 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -23,7 +23,7 @@ By default, authorized users can access your organization's resources from any I {% ifversion ghec %} {% note %} -**Notes:** +**Notes:** - Only organizations that use {% data variables.product.prodname_ghe_cloud %} can use IP allow lists. {% data reusables.enterprise.link-to-ghec-trial %} - If you configure an IP allow list for your organization you won't be able to use {% data variables.product.prodname_github_codespaces %} for repositories owned by the organization. diff --git a/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization.md index c672e522323a..c8ebf46f3058 100644 --- a/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization.md @@ -29,7 +29,7 @@ You can also require two-factor authentication for organizations in an enterpris {% note %} -**Note**: Some of the users in your organization may have been selected for mandatory two-factor authentication enrollment by {% data variables.product.prodname_dotcom_the_website %}, but it has no impact on how you enable the 2FA requirement for your organization. If you enable the 2FA requirement in your organization, all users without 2FA currently enabled will be removed from your organization, including those that are required to enable it by {% data variables.product.prodname_dotcom_the_website %}. +**Note**: Some of the users in your organization may have been selected for mandatory two-factor authentication enrollment by {% data variables.product.prodname_dotcom_the_website %}, but it has no impact on how you enable the 2FA requirement for your organization. If you enable the 2FA requirement in your organization, all users without 2FA currently enabled will be removed from your organization, including those that are required to enable it by {% data variables.product.prodname_dotcom_the_website %}. {% endnote %} diff --git a/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md b/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md index 21bacf5c0229..b763a82d94a3 100644 --- a/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md @@ -21,7 +21,7 @@ allowTitleToDifferFromFilename: true {% note %} -**Note:** {% data reusables.project-management.cascading-permissions %} For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)." +**Note:** {% data reusables.project-management.cascading-permissions %} For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)." {% endnote %} diff --git a/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md b/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md index 026450054e8d..6219ef1b4880 100644 --- a/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md @@ -20,7 +20,7 @@ shortTitle: Reinstate a member If a user is removed from your organization in one of the following ways, the user's access privileges and settings are saved for three months. -- You manually removed the user from your organization. For more information, see "[AUTOTITLE](/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization)." +- You manually removed the user from your organization. For more information, see "[AUTOTITLE](/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization)." {%- ifversion ghec %} - The user was removed via SCIM. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." {%- endif %}{% ifversion not ghae %} @@ -31,7 +31,7 @@ If a user is removed from your organization in one of the following ways, the us You can restore the user's privileges if you {% ifversion fpt or ghec %}invite{% else %}add{% endif %} them back to the organization within that time frame. {% ifversion fpt or ghec %} -If your organization has a paid per-user subscription, an unused license must be available before you can reinstate a former organization member. For more information, see "[AUTOTITLE](/articles/about-per-user-pricing)." +If your organization has a paid per-user subscription, an unused license must be available before you can reinstate a former organization member. For more information, see "[AUTOTITLE](/articles/about-per-user-pricing)." {% endif %} ## Items that are restored for reinstated members diff --git a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md index 009baa141b4e..d49c87f06fa1 100644 --- a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md +++ b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md @@ -54,7 +54,7 @@ You can choose to disable {% data variables.product.prodname_actions %} for all ## Limiting the use of self-hosted runners -{% data reusables.actions.disable-selfhosted-runners-overview %} +{% data reusables.actions.disable-selfhosted-runners-overview %} {% ifversion ghec or ghes %} @@ -70,7 +70,7 @@ If a repository already has self-hosted runners when you disable their use, thes ![Screenshot of the "Runners" list showing a self-hosted runner with the status "Disabled."](/assets/images/help/actions/actions-runners-disabled.png) -{% data reusables.actions.disable-selfhosted-runners-note %} +{% data reusables.actions.disable-selfhosted-runners-note %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations.md index 72eba7f750c4..e063379167ea 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations.md @@ -41,7 +41,7 @@ Before you authorize the {% data variables.product.prodname_oauth_app %}, you mu **Note:** {% data reusables.scim.nameid-and-username-must-match %} -{% endnote %} +{% endnote %} ## Further reading diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md index abb632ba3b6b..c10b4dc777d0 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md @@ -31,7 +31,7 @@ You can find the SAML and SCIM implementation details for your IdP in the IdP's **Note:** {% data variables.product.product_name %} supported identity providers for SCIM are Azure AD, Okta, and OneLogin. For more information about SCIM, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." -{% data reusables.scim.enterprise-account-scim %} +{% data reusables.scim.enterprise-account-scim %} {% endnote %} diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management-for-your-organization.md index e602abe5e410..9970ca393c8d 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management-for-your-organization.md @@ -17,7 +17,7 @@ redirect_from: ## Some users are not provisioned or deprovisioned by SCIM -When you encounter provisioning issues with users, we recommend that you check if the users are missing SCIM metadata. +When you encounter provisioning issues with users, we recommend that you check if the users are missing SCIM metadata. {% data reusables.scim.changes-should-come-from-idp %} @@ -33,7 +33,7 @@ When the IdP sends a provisioning call to the {% data variables.product.prodname #### Auditing organization members on {% data variables.product.prodname_dotcom %} -As an organization owner, to confirm that SCIM metadata exists for a single organization member, visit this URL, replacing `` and ``: +As an organization owner, to confirm that SCIM metadata exists for a single organization member, visit this URL, replacing `` and ``: > `https://github.com/orgs//people//sso` @@ -41,7 +41,7 @@ If the user's external identity includes SCIM metadata, the organization owner s #### Auditing organization members through the {% data variables.product.prodname_dotcom %} API -As an organization owner, you can also query the SCIM REST API or GraphQL to list all SCIM provisioned identities in an organization. +As an organization owner, you can also query the SCIM REST API or GraphQL to list all SCIM provisioned identities in an organization. #### Using the REST API @@ -53,7 +53,7 @@ For more information, see: #### Using GraphQL -This GraphQL query shows you the SAML `NameId`, the SCIM `UserName` and the {% data variables.product.prodname_dotcom %} username (`login`) for each user in the organization. To use this query, replace `ORG` with your organization name. +This GraphQL query shows you the SAML `NameId`, the SCIM `UserName` and the {% data variables.product.prodname_dotcom %} username (`login`) for each user in the organization. To use this query, replace `ORG` with your organization name. ```graphql { @@ -84,7 +84,7 @@ This GraphQL query shows you the SAML `NameId`, the SCIM `UserName` and the {% d curl -X POST -H "Authorization: Bearer YOUR_TOKEN" -H "Content-Type: application/json" -d '{ "query": "{ organization(login: \"ORG\") { samlIdentityProvider { externalIdentities(first: 100) { pageInfo { endCursor startCursor hasNextPage } edges { cursor node { samlIdentity { nameId } scimIdentity {username} user { login } } } } } } }" }' https://api.github.com/graphql ``` -For more information on using the GraphQL API, see: +For more information on using the GraphQL API, see: - "[AUTOTITLE](/graphql/guides)" - "[AUTOTITLE](/graphql/overview/explorer)" diff --git a/content/organizations/organizing-members-into-teams/about-teams.md b/content/organizations/organizing-members-into-teams/about-teams.md index 2da791d11bd2..d0f05481070a 100644 --- a/content/organizations/organizing-members-into-teams/about-teams.md +++ b/content/organizations/organizing-members-into-teams/about-teams.md @@ -45,11 +45,11 @@ You can view all the teams you belong to on your personal dashboard. For more in Each team has its own page within an organization. On a team's page, you can view team members, child teams, and the team's repositories. Organization owners and team maintainers can access team settings and update the team's description and profile picture from the team's page. -{% ifversion team-discussions %} +{% ifversion team-discussions %} Organization members can create and participate in discussions with the team. For more information, see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)." -{% else %} +{% else %} {% data reusables.organizations.team-discussions-deprecation %} -{% endif %} +{% endif %} ## Nested teams diff --git a/content/packages/quickstart.md b/content/packages/quickstart.md index 70595f6d8e22..326b0d14cb4e 100644 --- a/content/packages/quickstart.md +++ b/content/packages/quickstart.md @@ -109,7 +109,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor $ git push ``` 10. The workflow that you created will run whenever a new release is created in your repository. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. - + To test this out, navigate to the **Code** tab in your repository and create a new release. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)." ## Viewing your published package diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md index 72f81be74eef..dacf09f21ae4 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md @@ -30,7 +30,7 @@ You can set up either or both of apex and `www` subdomain configurations for you We recommend always using a `www` subdomain, even if you also use an apex domain. When you create a new site with an apex domain, we automatically attempt to secure the `www` subdomain for use when serving your site's content, but you need to make the DNS changes to use the `www` subdomain. If you configure a `www` subdomain, we automatically attempt to secure the associated apex domain. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)." -After you configure a custom domain for a user or organization site, the custom domain will replace the `.github.io` or `.github.io` portion of the URL for any project sites owned by the account that are published publicly and do not have a custom domain configured. For example, if the custom domain for your user site is `www.octocat.com`, and you have a project site with no custom domain configured that is published from a repository called `octo-project`, the {% data variables.product.prodname_pages %} site for that repository will be available at `www.octocat.com/octo-project`. +After you configure a custom domain for a user or organization site, the custom domain will replace the `.github.io` or `.github.io` portion of the URL for any project sites owned by the account that are published publicly and do not have a custom domain configured. For example, if the custom domain for your user site is `www.octocat.com`, and you have a project site with no custom domain configured that is published from a repository called `octo-project`, the {% data variables.product.prodname_pages %} site for that repository will be available at `www.octocat.com/octo-project`. {% note %} diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md index 76f834137267..0c2c26c4388f 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md @@ -31,7 +31,7 @@ When you squash and merge, {% data variables.product.prodname_dotcom %} generate When you squash and merge, {% data variables.product.prodname_dotcom %} generates a default commit message, which you can edit. The default message depends on the number of commits in the pull request, not including merge commits. Number of commits | Summary | Description | ------------------ | ------- | ----------- | +----------------- | ------- | ----------- | One commit | The title of the commit message for the single commit, followed by the pull request number | The body text of the commit message for the single commit More than one commit | The pull request title, followed by the pull request number | A list of the commit messages for all of the squashed commits, in date order {% endif %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md index 994e71568900..712142a6c297 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md @@ -51,7 +51,7 @@ If you work with forks, or if you're the owner of a repository or organization t ### About forks within an organization Forks within the same organization copy the collaborators and team settings of their upstream repositories. If a repository is owned by an organization: -- That organization controls the permissions of its forks. +- That organization controls the permissions of its forks. - Any teams from the upstream permission structure that exist and are visible in the target organization or user namespace will have their permissions copied. - Admin permissions remain with the upstream owner, except when a user forks into a different organization. - If that repository is forked to a user namespace, the organization maintains admin permissions and any teams with access maintain access. diff --git a/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md b/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md index ae8dc09f77ba..fa8a1e01d310 100644 --- a/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md +++ b/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md @@ -30,7 +30,7 @@ Here's an example of a [comparison between two branches](https://github.com/octo ## Comparing tags -Comparing release tags will show you changes to your repository since the last release. +Comparing release tags will show you changes to your repository since the last release. For more information, see "[AUTOTITLE](/repositories/releasing-projects-on-github/comparing-releases)." To compare tags, you can select a tag name from the `compare` drop-down menu at the top of the page. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets.md index 3ae1e62ff91b..16a1e593df12 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets.md @@ -22,7 +22,7 @@ For each ruleset you create, you specify which branches or tags in your reposito ## About rulesets, protected branches, and protected tags -Rulesets work alongside any branch protection rules and tag protection rules in a repository. Many of the rules you can define in rulesets are similar to protection rules, and you can start using rulesets without overriding any of your existing protection rules. +Rulesets work alongside any branch protection rules and tag protection rules in a repository. Many of the rules you can define in rulesets are similar to protection rules, and you can start using rulesets without overriding any of your existing protection rules. Rulesets have the following advantages over branch and tag protection rules. diff --git a/content/repositories/creating-and-managing-repositories/best-practices-for-repositories.md b/content/repositories/creating-and-managing-repositories/best-practices-for-repositories.md index 0d8ee11c72e3..946ba2314dc0 100644 --- a/content/repositories/creating-and-managing-repositories/best-practices-for-repositories.md +++ b/content/repositories/creating-and-managing-repositories/best-practices-for-repositories.md @@ -13,7 +13,7 @@ topics: ## Create a README file -To make it easier for people to understand and navigate your work, we recommend that you create a README file for every repository. +To make it easier for people to understand and navigate your work, we recommend that you create a README file for every repository. {% data reusables.repositories.about-READMEs %} For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." diff --git a/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md index 64e078e43e2f..706845c7fb14 100644 --- a/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md @@ -56,7 +56,7 @@ topics: {% ifversion create-new-repos-with-query-params %} ## Creating a new repository from a URL query -You can use query parameters to pre-fill form fields when creating a new repository. Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results or an issue template on {% data variables.product.prodname_dotcom %}. To specify values for the predefined query parameters, you must match the key and value pair. +You can use query parameters to pre-fill form fields when creating a new repository. Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results or an issue template on {% data variables.product.prodname_dotcom %}. To specify values for the predefined query parameters, you must match the key and value pair. Pre-filling form fields with a URL query may be useful if you often want to create repositories with the same default settings. For example, a teacher may want each student in a class to create a repository in their personal account with the same name, description and visibility. Using a URL query, the teacher can create a link that pre-fills the repository name, description and visibility fields and share it with the whole class. diff --git a/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md index 83ccbbd48988..f151ca28ef70 100644 --- a/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md +++ b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md @@ -18,7 +18,7 @@ shortTitle: Restore deleted repository {% ifversion ghes or ghae %} -Usually, deleted repositories can be restored within 90 days by an enterprise owner{% ifversion ghes %} on {% data variables.location.product_location %}{% endif %}. For more information, see "[AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." +Usually, deleted repositories can be restored within 90 days by an enterprise owner{% ifversion ghes %} on {% data variables.location.product_location %}{% endif %}. For more information, see "[AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." {% else %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md index c306db4e8ea9..8817f41e8841 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md @@ -22,7 +22,7 @@ shortTitle: Repository languages {% data variables.product.product_name %} uses the open source [Linguist library](https://github.com/github-linguist/linguist) to determine file languages for syntax highlighting and repository statistics. Language statistics will update after you push changes to your default branch. -Some files are hard to identify, and sometimes projects contain more library and vendor files than their primary code. If you're receiving incorrect results, please consult the Linguist [troubleshooting guide](https://github.com/github-linguist/linguist/blob/master/docs/troubleshooting.md) for help. Note that Linguist only works for repositories with fewer than 100,000 files. +Some files are hard to identify, and sometimes projects contain more library and vendor files than their primary code. If you're receiving incorrect results, please consult the Linguist [troubleshooting guide](https://github.com/github-linguist/linguist/blob/master/docs/troubleshooting.md) for help. Note that Linguist only works for repositories with fewer than 100,000 files. ## Markup languages diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md index 65f6020ec857..20aaaa543433 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md @@ -84,7 +84,7 @@ Forks are listed alphabetically by the organization or username of the person wh ![Screenshot of the forks page with filter and sort options shown. The dropdown menu, titled "Sort", is highlighted with an orange outline.](/assets/images/help/graphs/repository-forks-page-sort-dropdown.png) -1. Optionally, to preserve the filter values you have selected as the default filters for any time you view a forks page, click **Save Defaults**. If the currently selected filters are already the defaults, the button will be disabled and labeled as **Defaults Saved**. +1. Optionally, to preserve the filter values you have selected as the default filters for any time you view a forks page, click **Save Defaults**. If the currently selected filters are already the defaults, the button will be disabled and labeled as **Defaults Saved**. ![Screenshot of the forks page with filter and sort options shown. The "Defaults saved" button, which is disabled because the defaults are already saved, is highlighted with an orange outline."](/assets/images/help/graphs/repository-forks-page-save-defaults-button.png) diff --git a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md index b398857b324d..fc78876c15e4 100644 --- a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md +++ b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md @@ -34,7 +34,7 @@ Files that you add to a repository via a browser are limited to {% data variable {% data reusables.repositories.navigate-to-repo %} 1. Above the list of files, select the **Add file** dropdown menu and click **Upload files**. Alternatively, you can drag and drop files into your browser. - + ![Screenshot of the main page of the repository. Above the list of a files, a button, labeled "Add file," is outlined in dark orange.](/assets/images/help/repository/upload-files-button.png) 1. To select the files you want to upload, drag and drop the file or folder, or click **choose your files**. {% data reusables.files.commit-message %} diff --git a/content/repositories/working-with-files/using-files/downloading-source-code-archives.md b/content/repositories/working-with-files/using-files/downloading-source-code-archives.md index 64f48358745b..b1d7fb8d307b 100644 --- a/content/repositories/working-with-files/using-files/downloading-source-code-archives.md +++ b/content/repositories/working-with-files/using-files/downloading-source-code-archives.md @@ -22,7 +22,7 @@ You can download the source code archives in three ways. {% data reusables.repositories.navigate-to-repo %} 1. Above the list of files, click {% octicon "code" aria-hidden="true" %} **Code**. - + ![Screenshot of the list of files on the landing page of a repository. The "Code" button is highlighted with a dark orange outline.](/assets/images/help/repository/code-button.png) 1. Click {% octicon "file-zip" aria-hidden="true" %} **Download ZIP**. diff --git a/content/rest/actions/artifacts.md b/content/rest/actions/artifacts.md index e6e4e5ac417f..1e786a1b3d21 100644 --- a/content/rest/actions/artifacts.md +++ b/content/rest/actions/artifacts.md @@ -15,7 +15,7 @@ versions: autogenerated: rest --- -## About artifacts in {% data variables.product.prodname_actions %} +## About artifacts in {% data variables.product.prodname_actions %} You can use the REST API to download, delete, and retrieve information about workflow artifacts in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-artifacts %} For more information, see "[AUTOTITLE](/actions/using-workflows/storing-workflow-data-as-artifacts)." diff --git a/content/rest/apps/oauth-applications.md b/content/rest/apps/oauth-applications.md index 9d890e02e020..4e39bbea393b 100644 --- a/content/rest/apps/oauth-applications.md +++ b/content/rest/apps/oauth-applications.md @@ -19,6 +19,6 @@ autogenerated: rest You can use these endpoints to manage the OAuth tokens that {% data variables.product.prodname_oauth_apps %} or {% data variables.product.prodname_github_apps %} use to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. -Tokens for {% data variables.product.prodname_oauth_apps %} have the prefix `gho_`, while OAuth tokens for {% data variables.product.prodname_github_apps %}, used for authenticating on behalf of the user, have the prefix `ghu_`. You can use the following endpoints for both types of OAuth tokens. +Tokens for {% data variables.product.prodname_oauth_apps %} have the prefix `gho_`, while OAuth tokens for {% data variables.product.prodname_github_apps %}, used for authenticating on behalf of the user, have the prefix `ghu_`. You can use the following endpoints for both types of OAuth tokens. diff --git a/content/rest/code-scanning.md b/content/rest/code-scanning.md index 589b12b5691a..16099ad3b5ed 100644 --- a/content/rest/code-scanning.md +++ b/content/rest/code-scanning.md @@ -25,7 +25,7 @@ You can retrieve and update {% data variables.product.prodname_code_scanning %} ### Custom media type for {% data variables.product.prodname_code_scanning %} -There is one supported custom media type for {% data variables.product.prodname_code_scanning %} endpoints. +There is one supported custom media type for {% data variables.product.prodname_code_scanning %} endpoints. application/sarif+json diff --git a/content/rest/deployments/branch-policies.md b/content/rest/deployments/branch-policies.md index 450cbfc5482f..f6cda62442ce 100644 --- a/content/rest/deployments/branch-policies.md +++ b/content/rest/deployments/branch-policies.md @@ -15,7 +15,7 @@ autogenerated: rest ## About deployment branch policies -You can use the REST API to specify custom name patterns that branches must match in order to deploy to an environment. The `deployment_branch_policy.custom_branch_policies` property for the environment must be set to `true` to use these endpoints. To update the `deployment_branch_policy` for an environment, see "[AUTOTITLE](/rest/deployments/environments#create-or-update-an-environment)." +You can use the REST API to specify custom name patterns that branches must match in order to deploy to an environment. The `deployment_branch_policy.custom_branch_policies` property for the environment must be set to `true` to use these endpoints. To update the `deployment_branch_policy` for an environment, see "[AUTOTITLE](/rest/deployments/environments#create-or-update-an-environment)." For more information about restricting environment deployments to certain branches, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches)." diff --git a/content/rest/enterprise-admin/scim.md b/content/rest/enterprise-admin/scim.md index 08bfb2674e45..9a3e1e32c4f1 100644 --- a/content/rest/enterprise-admin/scim.md +++ b/content/rest/enterprise-admin/scim.md @@ -66,7 +66,7 @@ The {% data variables.product.product_name %} instance links each user who authe | `name.formatted` | String | The user's full name, including all middle names, titles, and suffixes, formatted for display. | `name.givenName` | String | The first name of the user. | | `name.familyName` | String | The last name of the user. | -| `userName` | String | The username for the user, generated by the IdP. Undergoes [normalization](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#about-username-normalization) before being used. +| `userName` | String | The username for the user, generated by the IdP. Undergoes [normalization](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#about-username-normalization) before being used. | `emails` | Array | List of the user's emails. | | `roles` | Array | List of the user's roles. | | `externalId` | String | This identifier is generated by an IdP provider. You can find the `externalId` for a user either on the IdP, or by using the [List SCIM provisioned identities](#list-scim-provisioned-identities-for-an-enterprise) endpoint and filtering on other known attributes, such as a user's username or email address on the {% data variables.product.product_name %} instance. | diff --git a/content/rest/guides/working-with-comments.md b/content/rest/guides/working-with-comments.md index fcc97851b290..25313bc7622d 100644 --- a/content/rest/guides/working-with-comments.md +++ b/content/rest/guides/working-with-comments.md @@ -17,7 +17,7 @@ topics: For any Pull Request, {% data variables.product.product_name %} provides three kinds of comment views: [comments on the Pull Request][PR comment] as a whole, [comments on a specific line][PR line comment] within the Pull Request, -and [comments on a specific commit][commit comment] within the Pull Request. +and [comments on a specific commit][commit comment] within the Pull Request. Each of these types of comments goes through a different portion of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. In this guide, we'll explore how you can access and manipulate each one. For every diff --git a/content/rest/quickstart.md b/content/rest/quickstart.md index f3d829646999..4b70ab2ede59 100644 --- a/content/rest/quickstart.md +++ b/content/rest/quickstart.md @@ -83,7 +83,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app % ```yaml {% indented_data_reference reusables.actions.actions-not-certified-by-github-comment spaces=1 %} - + on: workflow_dispatch: jobs: @@ -96,7 +96,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app % with: app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} - + - name: Use API env: GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} @@ -228,7 +228,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app % ```yaml {% indented_data_reference reusables.actions.actions-not-certified-by-github-comment spaces=1 %} - + on: workflow_dispatch: jobs: @@ -237,7 +237,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app % steps: - name: Check out repo content uses: {% data reusables.actions.action-checkout %} - + - name: Setup Node uses: {% data reusables.actions.action-setup-node %} with: @@ -355,7 +355,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app % ```yaml {% indented_data_reference reusables.actions.actions-not-certified-by-github-comment spaces=1 %} - + on: workflow_dispatch: jobs: @@ -368,7 +368,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app % with: app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} - + - name: Use API env: GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} diff --git a/content/rest/scim.md b/content/rest/scim.md index 5b39dd8ede63..3bfea17b3247 100644 --- a/content/rest/scim.md +++ b/content/rest/scim.md @@ -20,7 +20,7 @@ These endpoints are used by SCIM-enabled Identity Providers (IdPs) to automate p {% note %} -**Notes:** +**Notes:** - These endpoints are only available for individual organizations that use [{% data variables.product.prodname_ghe_cloud %}](/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts) with SAML SSO enabled. For more information about SCIM, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." For more information about authorizing a token for a SAML SSO organization, see "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)." - These endpoints cannot be used with an enterprise account or with an {% data variables.enterprise.prodname_emu_org %}. diff --git a/content/rest/teams/discussion-comments.md b/content/rest/teams/discussion-comments.md index 66a0f13ae969..dc9a05c3782f 100644 --- a/content/rest/teams/discussion-comments.md +++ b/content/rest/teams/discussion-comments.md @@ -25,7 +25,7 @@ autogenerated: rest {% ifversion team-discussions %} ## About team discussion comments -Any member of the team's [organization](/rest/orgs) can create and read comments on a public discussion. For more details, see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)." +Any member of the team's [organization](/rest/orgs) can create and read comments on a public discussion. For more details, see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)." {% data reusables.organizations.team-api %} {% endif %} diff --git a/content/rest/teams/external-groups.md b/content/rest/teams/external-groups.md index 169ebc7d4c92..6fa8a4cd2899 100644 --- a/content/rest/teams/external-groups.md +++ b/content/rest/teams/external-groups.md @@ -20,7 +20,7 @@ To use these endpoints, the authenticated user must be a team maintainer or an o {% ifversion ghec %} {% note %} -**Notes:** +**Notes:** - These endpoints are only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." - If your organization uses team synchronization, you can use the API to manage team synchronization. For more information, see "[AUTOTITLE](/rest/teams/team-sync)." diff --git a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index fd32cfbc99ca..184b23c4a24f 100644 --- a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -19,7 +19,7 @@ topics: - GitHub search --- -## About searching on {% data variables.product.prodname_dotcom %} +## About searching on {% data variables.product.prodname_dotcom %} {% data reusables.search.you-can-search-globally %} @@ -28,12 +28,12 @@ topics: {% ifversion code-search-code-view %} You can also use suggestions and completions in the search bar to quickly find what you need. -- If you click on the search bar in the top navigation of GitHub.com, you will see a list of suggestions organized by category, including recent searches and suggested repositories, teams, and projects that you have access to. +- If you click on the search bar in the top navigation of GitHub.com, you will see a list of suggestions organized by category, including recent searches and suggested repositories, teams, and projects that you have access to. - Clicking on any of the specific suggestions will take you directly to the page for that suggestion (for example, the repository or project page). If you click on a recent search, depending on the type of search, the search term will appear in the search bar or you will be taken to the search results page for the search term. - Once you start typing, you will see a list of completions and suggestions that match your query. You can click on a suggestion to jump to a specific location. As you continue to type, you will see more specific suggestions, such as code files you can jump to directly. After typing a search query, you can press **Enter** to go to the full search results view, where you can see each match and a visual interface for applying filters. For more information, see "[Searching using a visual interface](#searching-using-a-visual-interface)." -{% endif %} +{% endif %} {% note %} diff --git a/content/search-github/github-code-search/understanding-github-code-search-syntax.md b/content/search-github/github-code-search/understanding-github-code-search-syntax.md index f191a2070f2e..6e3a8fb432fd 100644 --- a/content/search-github/github-code-search/understanding-github-code-search-syntax.md +++ b/content/search-github/github-code-search/understanding-github-code-search-syntax.md @@ -15,7 +15,7 @@ The search syntax in this article only applies to searching code with {% data va Search queries consist of search terms, comprising text you want to search for, and qualifiers, which narrow down the search. -A bare term with no qualifiers will match either the content of a file or the file's path. +A bare term with no qualifiers will match either the content of a file or the file's path. For example, the following query: @@ -23,9 +23,9 @@ For example, the following query: http-push ``` -The above query will match the file `docs/http-push.txt`, even if it doesn't contain the term `http-push`. It will also match a file called `example.txt` if it contains the term `http-push`. +The above query will match the file `docs/http-push.txt`, even if it doesn't contain the term `http-push`. It will also match a file called `example.txt` if it contains the term `http-push`. -You can enter multiple terms separated by whitespace to search for documents that satisfy both terms. +You can enter multiple terms separated by whitespace to search for documents that satisfy both terms. For example, the following query: @@ -140,7 +140,7 @@ user:octocat ### Language qualifier -To narrow down to a specific languages, use the `language:` qualifier. For example: +To narrow down to a specific languages, use the `language:` qualifier. For example: ``` language:ruby OR language:cpp OR language:csharp @@ -156,7 +156,7 @@ To search within file paths, use the `path:` qualifier. This will match files co path:unit_tests ``` -The above query will match both `src/unit_tests/my_test.py` and `src/docs/unit_tests.md` since they both contain `unit_test` somewhere in their path. +The above query will match both `src/unit_tests/my_test.py` and `src/docs/unit_tests.md` since they both contain `unit_test` somewhere in their path. To match only a specific filename (and not part of the path), you could use a regular expression: @@ -206,7 +206,7 @@ To search for a filename which contains a special character like `*` or `?`, jus path:"file?" ``` -Glob expressions are disabled for quoted strings, so the above query will only match paths containing the literal string `file?`. +Glob expressions are disabled for quoted strings, so the above query will only match paths containing the literal string `file?`. ### Symbol qualifier @@ -226,7 +226,7 @@ You can also use regular expressions with the symbol qualifier. For example, the language:rust symbol:/^String::to_.*/ ``` -Note that this qualifier only searches for definitions and not references, and not all symbol types or languages are fully supported yet. Symbol extraction is supported for the following languages. +Note that this qualifier only searches for definitions and not references, and not all symbol types or languages are fully supported yet. Symbol extraction is supported for the following languages. - C# - Python @@ -249,7 +249,7 @@ By default, bare terms search both paths and file content. To restrict a search content:README.md ``` -This query would only match files containing the term `README.md`, rather than matching files named `README.md`. +This query would only match files containing the term `README.md`, rather than matching files named `README.md`. ### Is qualifier @@ -273,7 +273,7 @@ log4j NOT is:fork ## Using regular expressions -Code search supports regular expressions to search for patterns in your code. You can use regular expressions in bare search terms as well as within many qualifiers, by surrounding the regex in slashes. +Code search supports regular expressions to search for patterns in your code. You can use regular expressions in bare search terms as well as within many qualifiers, by surrounding the regex in slashes. For example, to search for the regular expression `sparse.*index`, you would use: diff --git a/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md b/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md index 7a9bd1ca2e4f..e7ac76f21ac7 100644 --- a/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md +++ b/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md @@ -32,7 +32,7 @@ We do not allow content or activity on GitHub that: - [harasses or abuses](/site-policy/acceptable-use-policies/github-bullying-and-harassment) another individual or group, including our employees, officers, and agents, or other users; -- [threatens or incites violence](/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content) toward any individual or group, especially on the basis of who they are; +- [threatens or incites violence](/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content) toward any individual or group, especially on the basis of who they are; - [gratuitously depicts or glorifies violence](/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content), including violent images; or @@ -78,7 +78,7 @@ You may use information from our Service for the following reasons, regardless o - Researchers may use public, non-personal information from the Service for research purposes, only if any publications resulting from that research are [open access](https://en.wikipedia.org/wiki/Open_access). - Archivists may use public information from the Service for archival purposes. -Scraping refers to extracting information from our Service via an automated process, such as a bot or webcrawler. Scraping does not refer to the collection of information through our API. Please see Section H of our [Terms of Service](/site-policy/github-terms/github-terms-of-service#h-api-terms) for our API Terms. +Scraping refers to extracting information from our Service via an automated process, such as a bot or webcrawler. Scraping does not refer to the collection of information through our API. Please see Section H of our [Terms of Service](/site-policy/github-terms/github-terms-of-service#h-api-terms) for our API Terms. You may not use information from the Service (whether scraped, collected through our API, or obtained otherwise) for spamming purposes, including for the purposes of sending unsolicited emails to users or selling personal information, such as to recruiters, headhunters, and job boards. @@ -102,7 +102,7 @@ You may not promote or distribute content or activity that is illegal or otherwi If you decide to post any promotional materials in your Account, you are solely responsible for complying with all applicable laws and regulations, including without limitation the U.S. Federal Trade Commission's Guidelines on Endorsements and Testimonials. We reserve the right to remove any promotional materials or advertisements that, in our sole discretion, violate any GitHub terms or policies. ## 11. User Protection -You must not engage in activity that significantly harms other users. +You must not engage in activity that significantly harms other users. We will interpret our policies and resolve disputes in favor of protecting users as a whole. diff --git a/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md b/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md index c76b51c66b87..7f66f83348f4 100644 --- a/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md +++ b/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md @@ -13,9 +13,9 @@ redirect_from: Being part of a community includes not taking advantage of other members of the community. We do not allow anyone to use our platform in direct support of unlawful attacks that cause technical harms, such as using GitHub as a means to deliver malicious executables or as attack infrastructure, for example by organizing denial of service attacks or managing command and control servers. Technical harms means overconsumption of resources, physical damage, downtime, denial of service, or data loss, with no implicit or explicit dual-use purpose prior to the abuse occurring. - Note that GitHub allows dual-use content and supports the posting of content that is used for research into vulnerabilities, malware, or exploits, as the publication and distribution of such content has educational value and provides a net benefit to the security community. We assume positive intention and use of these projects to promote and drive improvements across the ecosystem. + Note that GitHub allows dual-use content and supports the posting of content that is used for research into vulnerabilities, malware, or exploits, as the publication and distribution of such content has educational value and provides a net benefit to the security community. We assume positive intention and use of these projects to promote and drive improvements across the ecosystem. - In rare cases of very widespread abuse of dual-use content, we may restrict access to that specific instance of the content to disrupt an ongoing unlawful attack or malware campaign that is leveraging the GitHub platform as an exploit or malware CDN. In most of these instances, restriction takes the form of putting the content behind authentication, but may, as an option of last resort, involve disabling access or full removal where this is not possible (e.g. when posted as a gist). We will also contact the project owners about restrictions put in place where possible. + In rare cases of very widespread abuse of dual-use content, we may restrict access to that specific instance of the content to disrupt an ongoing unlawful attack or malware campaign that is leveraging the GitHub platform as an exploit or malware CDN. In most of these instances, restriction takes the form of putting the content behind authentication, but may, as an option of last resort, involve disabling access or full removal where this is not possible (e.g. when posted as a gist). We will also contact the project owners about restrictions put in place where possible. Restrictions are temporary where feasible, and do not serve the purpose of purging or restricting any specific dual-use content, or copies of that content, from the platform in perpetuity. While we aim to make these rare cases of restriction a collaborative process with project owners, if you do feel your content was unduly restricted, we have an [appeals process](/site-policy/acceptable-use-policies/github-appeal-and-reinstatement) in place. diff --git a/content/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users.md b/content/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users.md index 0596b8cbc9e6..02fc39feaa83 100644 --- a/content/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users.md +++ b/content/site-policy/acceptable-use-policies/github-disrupting-the-experience-of-other-users.md @@ -11,14 +11,14 @@ redirect_from: - /github/site-policy/github-community-guidelines#disrupting-the-experience-of-other-users --- -Being part of a community includes recognizing how your behavior affects others and engaging in meaningful and productive interactions with people and the platform they rely on. +Being part of a community includes recognizing how your behavior affects others and engaging in meaningful and productive interactions with people and the platform they rely on. -We do not allow behavior that significantly or continually disrupts the experience of other users. This includes: +We do not allow behavior that significantly or continually disrupts the experience of other users. This includes: -- Posting off-topic comments -- Opening empty or meaningless issues or pull requests -- Starring and/or following accounts or repositories in large volume in a short period of time -- Creating nonsensical or irrelevant code reviews +- Posting off-topic comments +- Opening empty or meaningless issues or pull requests +- Starring and/or following accounts or repositories in large volume in a short period of time +- Creating nonsensical or irrelevant code reviews - Engaging with platform features in a way that causes excessive notifications for other users - Using any other platform feature in a way that creates disruption diff --git a/content/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination.md b/content/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination.md index ed88a9debd5b..b05ddbd3bce8 100644 --- a/content/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination.md +++ b/content/site-policy/acceptable-use-policies/github-hate-speech-and-discrimination.md @@ -21,4 +21,4 @@ GitHub does not tolerate speech that attacks or promotes hate toward an individu - Attacking an individual based on their perceived gender - Dog whistling; or using coded or suggestive language and/or symbols to promote abuse or hate -While GitHub takes all instances of abuse and harassment on the platform seriously, we are especially committed to fighting hate-based abuse where it disproportionately affects communities that have historically been targeted by such abuse. We aim to make GitHub a place where all individuals feel welcome and safe. +While GitHub takes all instances of abuse and harassment on the platform seriously, we are especially committed to fighting hate-based abuse where it disproportionately affects communities that have historically been targeted by such abuse. We aim to make GitHub a place where all individuals feel welcome and safe. diff --git a/content/site-policy/acceptable-use-policies/github-misinformation-and-disinformation.md b/content/site-policy/acceptable-use-policies/github-misinformation-and-disinformation.md index 68c9a16711be..70ba0fc65690 100644 --- a/content/site-policy/acceptable-use-policies/github-misinformation-and-disinformation.md +++ b/content/site-policy/acceptable-use-policies/github-misinformation-and-disinformation.md @@ -11,7 +11,7 @@ redirect_from: - /github/site-policy/github-community-guidelines#misinformation-and-disinformation --- -You may not post content that presents a distorted view of reality, whether it is inaccurate or false (misinformation) or is intentionally deceptive (disinformation), where such content is likely to result in harm to the public or to interfere with fair and equal opportunities for all to take part in a free and open society. This may include: +You may not post content that presents a distorted view of reality, whether it is inaccurate or false (misinformation) or is intentionally deceptive (disinformation), where such content is likely to result in harm to the public or to interfere with fair and equal opportunities for all to take part in a free and open society. This may include: - Inaccurate or scientifically unsupported medical claims that endanger public health or safety - Manipulated media, whether audio or visual, likely to mislead or deceive in a way that may harm the public interest - False or misleading content likely to interfere with an individual's ability to participate in civic activities diff --git a/content/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content.md b/content/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content.md index 9ece0894149b..502b8c441159 100644 --- a/content/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content.md +++ b/content/site-policy/acceptable-use-policies/github-threats-of-violence-and-gratuitously-violent-content.md @@ -19,4 +19,4 @@ You may not use GitHub to organize, promote, encourage, threaten, or incite acts - Posting text, imagery, or audio content glorifying or containing a graphic depiction of violence toward oneself, another individual, group, or animal - Encouraging another individual to engage in self harm -We do not allow violent content to be posted indiscriminately or in a way that is difficult for other users to avoid, such as a profile avatar or an issue comment. However, we understand there may be legitimate reasons to post violent content, such as for educational or documentary purposes, creative works, or depictions of historical events. In those cases, a clear warning or disclaimer can help users make an educated decision as to whether or not they want to engage with such content. Still, GitHub may decide to limit the visibility of such content to those who choose to opt in. +We do not allow violent content to be posted indiscriminately or in a way that is difficult for other users to avoid, such as a profile avatar or an issue comment. However, we understand there may be legitimate reasons to post violent content, such as for educational or documentary purposes, creative works, or depictions of historical events. In those cases, a clear warning or disclaimer can help users make an educated decision as to whether or not they want to engage with such content. Still, GitHub may decide to limit the visibility of such content to those who choose to opt in. diff --git a/content/site-policy/content-removal-policies/dmca-takedown-policy.md b/content/site-policy/content-removal-policies/dmca-takedown-policy.md index c58b3f28d210..2c391057a2ba 100644 --- a/content/site-policy/content-removal-policies/dmca-takedown-policy.md +++ b/content/site-policy/content-removal-policies/dmca-takedown-policy.md @@ -28,7 +28,7 @@ The DMCA provides a safe harbor for service providers that host user-generated c The DMCA addresses this issue by creating a [copyright liability safe harbor](https://www.copyright.gov/title17/92chap5.html#512) for internet service providers hosting allegedly infringing user-generated content. Essentially, so long as a service provider follows the DMCA's notice-and-takedown rules, it won't be liable for copyright infringement based on user-generated content. Because of this, it is important for GitHub to maintain its DMCA safe-harbor status. -The DMCA also prohibits the [circumvention of technical measures](https://www.copyright.gov/title17/92chap12.html) that effectively control access to works protected by copyright. +The DMCA also prohibits the [circumvention of technical measures](https://www.copyright.gov/title17/92chap12.html) that effectively control access to works protected by copyright. ## DMCA Notices In a Nutshell @@ -51,7 +51,7 @@ Here are the basic steps in the process. 2. **Copyright Owner Sends A Notice.** After conducting an investigation, a copyright owner prepares and sends a [takedown notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice) to GitHub. Assuming the takedown notice is sufficiently detailed according to the statutory requirements (as explained in the [how-to guide](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice)), we will [post the notice](#d-transparency) to our [public repository](https://github.com/github/dmca) and pass the link along to the affected user. -3. **GitHub Asks User to Make Changes.** If the notice alleges that the entire contents of a repository infringe, or a package infringes, we will skip to Step 6 and disable the entire repository or package expeditiously. Otherwise, because GitHub cannot disable access to specific files within a repository, we will contact the user who created the repository and give them approximately 1 business day to delete or modify the content specified in the notice. We'll notify the copyright owner if and when we give the user a chance to make changes. Because packages are immutable, if only part of a package is infringing, GitHub would need to disable the entire package, but we permit reinstatement once the infringing portion is removed. +3. **GitHub Asks User to Make Changes.** If the notice alleges that the entire contents of a repository infringe, or a package infringes, we will skip to Step 6 and disable the entire repository or package expeditiously. Otherwise, because GitHub cannot disable access to specific files within a repository, we will contact the user who created the repository and give them approximately 1 business day to delete or modify the content specified in the notice. We'll notify the copyright owner if and when we give the user a chance to make changes. Because packages are immutable, if only part of a package is infringing, GitHub would need to disable the entire package, but we permit reinstatement once the infringing portion is removed. 4. **User Notifies GitHub of Changes.** If the user chooses to make the specified changes, they _must_ tell us so within the window of approximately 1 business day. If they don't, we will disable the repository (as described in Step 6). If the user notifies us that they made changes, we will verify that the changes have been made and then notify the copyright owner. @@ -73,11 +73,11 @@ In rare cases, you may be alleging copyright infringement in a full repository t ## C. What about Circumvention Claims? -The DMCA prohibits the [circumvention of technical measures](https://www.copyright.gov/title17/92chap12.html) that effectively control access to works protected by copyright. Given that these types of claims are often highly technical in nature, GitHub requires claimants to provide [detailed information about these claims](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice#complaints-about-anti-circumvention-technology), and we undertake a more extensive review. +The DMCA prohibits the [circumvention of technical measures](https://www.copyright.gov/title17/92chap12.html) that effectively control access to works protected by copyright. Given that these types of claims are often highly technical in nature, GitHub requires claimants to provide [detailed information about these claims](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice#complaints-about-anti-circumvention-technology), and we undertake a more extensive review. A circumvention claim must include the following details about the technical measures in place and the manner in which the accused project circumvents them. Specifically, the notice to GitHub must include detailed statements that describe: 1. What the technical measures are; -2. How they effectively control access to the copyrighted material; and +2. How they effectively control access to the copyrighted material; and 3. How the accused project is designed to circumvent their previously described technological protection measures. GitHub will review circumvention claims closely, including by both technical and legal experts. In the technical review, we will seek to validate the details about the manner in which the technical protection measures operate and the way the project allegedly circumvents them. In the legal review, we will seek to ensure that the claims do not extend beyond the boundaries of the DMCA. In cases where we are unable to determine whether a claim is valid, we will err on the side of the developer, and leave the content up. If the claimant wishes to follow up with additional detail, we would start the review process again to evaluate the revised claims. diff --git a/content/site-policy/content-removal-policies/github-private-information-removal-policy.md b/content/site-policy/content-removal-policies/github-private-information-removal-policy.md index 97fefad8c64d..928cea8af242 100644 --- a/content/site-policy/content-removal-policies/github-private-information-removal-policy.md +++ b/content/site-policy/content-removal-policies/github-private-information-removal-policy.md @@ -15,14 +15,14 @@ We offer this private information removal process as an exceptional service only ## What is Private Information? -For the purposes of this document, “private information” refers to content that (i) should have been kept confidential, _and_ (ii) whose public availability poses a specific or targeted security risk to you or your organization. +For the purposes of this document, “private information” refers to content that (i) should have been kept confidential, _and_ (ii) whose public availability poses a specific or targeted security risk to you or your organization. "Security risk" refers to a situation involving exposure to physical danger, identity theft, or increased likelihood of unauthorized access to physical or network facilities. ### Private information removal requests are appropriate for: - Access credentials, such as user names combined with passwords, access tokens, or other sensitive secrets that can grant access to your organization's server, network, or domain. - AWS tokens and other similar access credentials that grant access to a third party on your behalf. You must be able to show that the token does belong to you. -- Documentation (such as network diagrams or architecture) that poses a specific security risk for an organization. +- Documentation (such as network diagrams or architecture) that poses a specific security risk for an organization. - [Information](/site-policy/acceptable-use-policies/github-doxxing-and-invasion-of-privacy) related to, and posing a security risk to, you as an individual (such as social security numbers or other government identification numbers). ### Private information removal requests are _not_ appropriate for: @@ -31,7 +31,7 @@ For the purposes of this document, “private information” refers to content t - Entire files or repositories that do not pose a specific security risk, but you believe are otherwise objectionable. - Requests to remove content that may infringe your or your organization's copyright rights. If you have questions about how GitHub handles copyright-related matters or would like to report potentially infringing content, please review our [DMCA Takedown Policy](/site-policy/content-removal-policies/dmca-takedown-policy). The private information removal process is generally not intended for the removal of full files or repositories — only for the specific pieces of private information in those files. While there may be cases where files are filled entirely with private information, you must justify the security risk for the removal of such files, and this may increase the time required to process your request. - Trademark disputes. If you have questions about how GitHub handles trademark-related matters or would like to report content containing your organization's trade or service marks, please review our [Trademark Policy](/site-policy/content-removal-policies/github-trademark-policy). -- Privacy complaints. If you wish to access, transfer, change, or delete your personal information on GitHub, please contact us via [our Privacy contact form](https://github.com/contact/privacy). +- Privacy complaints. If you wish to access, transfer, change, or delete your personal information on GitHub, please contact us via [our Privacy contact form](https://github.com/contact/privacy). - Content governed by our [Community Guidelines](/site-policy/github-terms/github-community-guidelines), such as malware or general-purpose tools. If you have questions about our Community Guidelines or believe that content on GitHub might violate our guidelines, you can use {% data variables.contact.report_content %} to contact us. ## Things to Know @@ -40,7 +40,7 @@ For the purposes of this document, “private information” refers to content t **No Bots.** You should have a trained professional evaluate the facts of every request you send. If you're outsourcing your efforts to a third party, make sure you know how they operate, and make sure they are not using automated bots to submit complaints in bulk. These complaints often include data that does not pose any security threats, and they do not include sufficient explanations, requiring additional back-and-forth and resulting in delays, even when the complaint is valid. -**Send In The Correct Request.** As noted above, we offer this private information removal process as an exceptional service only for high-risk content. We are not able to use this process to remove other kinds of content, such as potentially infringing content, and we are not able to process any other kinds of removal requests simultaneously while processing private information removal requests. We will be able to help you more quickly if you send in your private information removal requests separately from any requests to remove potentially infringing content. If you are unsure whether your request involves only private information or also involves other legal matters, please consult legal counsel. +**Send In The Correct Request.** As noted above, we offer this private information removal process as an exceptional service only for high-risk content. We are not able to use this process to remove other kinds of content, such as potentially infringing content, and we are not able to process any other kinds of removal requests simultaneously while processing private information removal requests. We will be able to help you more quickly if you send in your private information removal requests separately from any requests to remove potentially infringing content. If you are unsure whether your request involves only private information or also involves other legal matters, please consult legal counsel. **Processing Time.** While we do process private information removal requests as quickly as possible, due to the volume of requests we process, it may take some time for your request to be reviewed. Additional requests, or multiple requests from additional points of contact, may result in delays. diff --git a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md index 9cf88d5162bb..937b6f3ac51d 100644 --- a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md +++ b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md @@ -57,7 +57,7 @@ GitHub exercises little discretion in the process other than determining whether 2. **Identify the copyrighted work you believe has been infringed.** This information is important because it helps the affected user evaluate your claim and give them the ability to compare your work to theirs. The specificity of your identification will depend on the nature of the work you believe has been infringed. If you have published your work, you might be able to just link back to a web page where it lives. If it is proprietary and not published, you might describe it and explain that it is proprietary. If you have registered it with the Copyright Office, you should include the registration number. If you are alleging that the hosted content is a direct, literal copy of your work, you can also just explain that fact. -3. **Identify the material that you allege is infringing the copyrighted work listed in item #2, above.** It is important to be as specific as possible in your identification. This identification needs to be reasonably sufficient to permit GitHub to locate the material. At a minimum, this means that you should include the URL to the material allegedly infringing your copyright. If you allege that less than a whole repository infringes, identify the specific file(s) or line numbers within a file that you allege infringe. If you allege that all of the content at a URL infringes, please be explicit about that as well. +3. **Identify the material that you allege is infringing the copyrighted work listed in item #2, above.** It is important to be as specific as possible in your identification. This identification needs to be reasonably sufficient to permit GitHub to locate the material. At a minimum, this means that you should include the URL to the material allegedly infringing your copyright. If you allege that less than a whole repository infringes, identify the specific file(s) or line numbers within a file that you allege infringe. If you allege that all of the content at a URL infringes, please be explicit about that as well. - Please note that GitHub will _not_ automatically disable [forks](/site-policy/content-removal-policies/dmca-takedown-policy#b-what-about-forks-or-whats-a-fork) when disabling a parent repository. If you have investigated and analyzed the forks of a repository and believe that they are also infringing, please explicitly identify each allegedly infringing fork. Please also confirm that you have investigated each individual case and that your sworn statements apply to each identified fork. In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks you have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. 4. **Explain what the affected user would need to do in order to remedy the infringement.** Again, specificity is important. When we pass your complaint along to the user, this will tell them what they need to do in order to avoid having the rest of their content disabled. Does the user just need to add a statement of attribution? Do they need to delete certain lines within their code, or entire files? Of course, we understand that in some cases, all of a user's content may be alleged to infringe and there's nothing they could do short of deleting it all. If that's the case, please make that clear as well. @@ -76,7 +76,7 @@ GitHub exercises little discretion in the process other than determining whether The Copyright Act also prohibits the circumvention of technological measures that effectively control access to works protected by copyright. If you believe that content hosted on GitHub violates this prohibition, please send us a report through our {% data variables.contact.contact_dmca %}. A circumvention claim must include the following details about the technical measures in place and the manner in which the accused project circumvents them. Specifically, the notice to GitHub must include detailed statements that describe: 1. What the technical measures are; -2. How they effectively control access to the copyrighted material; and +2. How they effectively control access to the copyrighted material; and 3. How the accused project is designed to circumvent their previously described technological protection measures. ## How to Submit Your Complaint diff --git a/content/site-policy/github-terms/github-community-code-of-conduct.md b/content/site-policy/github-terms/github-community-code-of-conduct.md index decdef6aa6d6..beba18d31663 100644 --- a/content/site-policy/github-terms/github-community-code-of-conduct.md +++ b/content/site-policy/github-terms/github-community-code-of-conduct.md @@ -40,7 +40,7 @@ The primary purpose of the GitHub community is to collaborate on software projec - **Be welcoming and open-minded** - New users join our community each day. Some are well-established developers, while others are just beginning. Be open to other ideas and experience levels. Make room for opinions other than your own and be welcoming to new collaborators and those just getting started. - - **Be respectful** - Working in a collaborative environment means disagreements may happen. But remember to criticize ideas, not people. Share thoughtful, constructive criticism and be courteous to those you interact with. If you’re unable to engage respectfully, consider taking a step back or using some of our moderation tools to deescalate a tense situation. + - **Be respectful** - Working in a collaborative environment means disagreements may happen. But remember to criticize ideas, not people. Share thoughtful, constructive criticism and be courteous to those you interact with. If you’re unable to engage respectfully, consider taking a step back or using some of our moderation tools to deescalate a tense situation. - **Be empathetic** - GitHub is a global community with people from a wide variety of backgrounds and perspectives, many of which may not be your own. Try to put yourself in others’ shoes and understand their feelings before you address them. Do your best to help make GitHub a community where others feel safe to make contributions, participate in discussions, and share different ideas. @@ -51,7 +51,7 @@ The primary purpose of the GitHub community is to collaborate on software projec - **Be clear and stay on topic.** GitHub Community is for collaboration, sharing ideas, and helping each other get stuff done. Off-topic comments are a distraction (sometimes welcome, but usually not) from getting work done and being productive. Staying on topic helps produce positive and productive discussions. This applies to sharing links, as well. Any links shared in GitHub Community discussions should be shared with the intent of providing relevant and appropriate information. Links should not be posted to simply drive traffic or attention to a site. Links should always be accompanied by a full explanation of the content and purpose of the link. Posting links, especially unsolicited ones, without relevant and valuable context can come across as advertising or serving even more malicious purposes. - + - **Share mindfully.** When asking others to give you feedback or collaborate on a project, only share valuable and relevant resources to provide context. Don't post links that don't add value to the discussion, and don't post unsolicited links to your own projects or sites on other user's threads. Additionally, don't share sensitive information. This includes your own email address. We don't allow the sharing of such information in GitHub Community, as it can create security and privacy risks for the poster, as well as other users. If you'd like to invite other GitHub users to collaborate on a project or work with you, share a link to the repository in which the project you are working on exists. By sharing the link to your project repo - with some information on what your project is and what kind of help or feedback you're looking for - you can invite others to collaborate with you via issues or pull requests without having to share your private information. You can also add others as outside collaborators on your project repo to give them special permissions to help you develop your project. diff --git a/content/site-policy/github-terms/github-community-guidelines.md b/content/site-policy/github-terms/github-community-guidelines.md index e68c6b793a65..b751163118e9 100644 --- a/content/site-policy/github-terms/github-community-guidelines.md +++ b/content/site-policy/github-terms/github-community-guidelines.md @@ -32,7 +32,7 @@ The primary purpose of the GitHub community is to collaborate on software projec ## What if something or someone offends you? -While some disagreements can be resolved with direct, respectful communication between community members, we understand that is not always the case. We encourage our community to [let us know](https://support.github.com/contact/report-abuse?category=report-abuse&report=other&report_type=unspecified) when they believe content or activity they’ve encountered violates our policies. However, if you run into something or someone on the site that you find objectionable, here are some ways GitHub enables you to take action: +While some disagreements can be resolved with direct, respectful communication between community members, we understand that is not always the case. We encourage our community to [let us know](https://support.github.com/contact/report-abuse?category=report-abuse&report=other&report_type=unspecified) when they believe content or activity they’ve encountered violates our policies. However, if you run into something or someone on the site that you find objectionable, here are some ways GitHub enables you to take action: - **Communicate expectations** - Maintainers can set community-specific guidelines to help users understand how to interact with their projects, for example, in a repository’s README, [CONTRIBUTING file](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors), or [dedicated code of conduct](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project). You can find additional information on building communities on the [Communities](/communities) page. diff --git a/content/site-policy/github-terms/github-corporate-terms-of-service.md b/content/site-policy/github-terms/github-corporate-terms-of-service.md index d8c42052ad0b..eced75ed1f35 100644 --- a/content/site-policy/github-terms/github-corporate-terms-of-service.md +++ b/content/site-policy/github-terms/github-corporate-terms-of-service.md @@ -159,11 +159,11 @@ Customer is responsible for managing access to its Private Repositories, includi GitHub considers Customer Content in Customer’s Private Repositories to be Customer’s Confidential Information. GitHub will protect and keep strictly confidential the Customer Content of Private Repositories in accordance with Section P. ### 3. Access -GitHub personnel may only access Customer's Private Repositories in the situations described in our [Privacy Statement](/site-policy/privacy-policies/github-privacy-statement#repository-contents). +GitHub personnel may only access Customer's Private Repositories in the situations described in our [Privacy Statement](/site-policy/privacy-policies/github-privacy-statement#repository-contents). Customer may choose to enable additional access to its Private Repositories. For example, Customer may enable various GitHub services or features that require additional rights to Customer Content in Private Repositories. These rights may vary depending on the service or feature, but GitHub will continue to treat Customer Content in Customer’s Private Repositories as Customer’s Confidential Information. If those services or features require rights in addition to those it needs to provide the Service, GitHub will provide an explanation of those rights. -Additionally, we may be [compelled by law](/site-policy/privacy-policies/github-privacy-statement#for-legal-disclosure) to disclose the contents of your private repositories. +Additionally, we may be [compelled by law](/site-policy/privacy-policies/github-privacy-statement#for-legal-disclosure) to disclose the contents of your private repositories. GitHub will provide notice regarding our access to private repository content, unless [for legal disclosure](/site-policy/privacy-policies/github-privacy-statement#for-legal-disclosure), to comply with our legal obligations, or where otherwise bound by requirements under law, for automated scanning, or if in response to a security threat or other risk to security. diff --git a/content/site-policy/github-terms/github-marketplace-developer-agreement.md b/content/site-policy/github-terms/github-marketplace-developer-agreement.md index 001ccecdebda..042bcd53874c 100644 --- a/content/site-policy/github-terms/github-marketplace-developer-agreement.md +++ b/content/site-policy/github-terms/github-marketplace-developer-agreement.md @@ -220,7 +220,7 @@ GitHub maintains personal information from individuals all over the world, some **A1-2. Definitions** - a. “Applicable Data Protection Laws” means any laws, regulations, regulatory frameworks, or other legislations relating to the processing and use of Personal Information, as applicable to the Agreement, including: - - The EU General Data Protection Regulation 2016/679 (“GDPR”), along with any implementing or corresponding equivalent national laws or regulations; + - The EU General Data Protection Regulation 2016/679 (“GDPR”), along with any implementing or corresponding equivalent national laws or regulations; - The California Consumer Privacy Act of 2018, Cal. Civ. Code §§1798.100 et seq. ("CCPA"); and - The UK Data Protection Act 2018 and implementation of GDPR contained therein. - b. “Personal Information” means any information which relates to an individual GitHub End User, customer or employee which could, alone or together with other information, personally identify him or her, whether supplied by GitHub for processing by the Developer or whether generated by the Developer in the course of performing its obligations under this Agreement. @@ -240,7 +240,7 @@ GitHub maintains personal information from individuals all over the world, some - ii. Developer must process and communicate the Protected Data to third parties only for the limited and specific purposes of providing its services to the End User as described in its agreement with the End User, unless the End User agrees to allow different uses. - c. Data Quality and Proportionality. Developer must keep the Protected Data accurate and up to date. - d. Security. Developer must take all reasonable security measures appropriate to the risks, such as against accidental or unlawful destruction, or accidental loss, alteration, unauthorized disclosure or access, presented by processing the Protected Data. -- e. Data Retention and Deletion. Upon GitHub’s reasonable request, unless prohibited by law, Developer must return or destroy all Personal Information and related data at all locations where it is stored after it is no longer needed for the limited and specified purposes for which it was collected. +- e. Data Retention and Deletion. Upon GitHub’s reasonable request, unless prohibited by law, Developer must return or destroy all Personal Information and related data at all locations where it is stored after it is no longer needed for the limited and specified purposes for which it was collected. - f. Subprocessing and Onward Transfer. Developer is liable for onward transfers of Protected Data to its subprocessors. In the event that Developer must transfer the Protected Data to a third party, or Developer installs, uses, or enables third party services to process the Protected Data on Developer’s behalf, Developer must ensure that the third party will provide at least the same level of privacy protection as is required herein. **A1-5. Use of Protected Data** diff --git a/content/site-policy/github-terms/github-marketplace-terms-of-service.md b/content/site-policy/github-terms/github-marketplace-terms-of-service.md index 28fc7799bbae..8a75de83b486 100644 --- a/content/site-policy/github-terms/github-marketplace-terms-of-service.md +++ b/content/site-policy/github-terms/github-marketplace-terms-of-service.md @@ -44,7 +44,7 @@ If you would have a question, concern, or dispute regarding your billing, please ## E. Your Data and GitHub's Privacy Policy -**Privacy.** When you select or use a Developer Product, GitHub may share certain Personal Information (as defined in the [GitHub Privacy Statement](/site-policy/privacy-policies/github-privacy-statement)) with the Product Provider (if any such Personal Information is received from you) in order to provide you with the Developer Product, regardless of your privacy settings. Depending on the requirements of the Developer Product you choose, GitHub may share as little as your account name, ID, and primary email address or as much as access to the content in your repositories, including the ability to read and modify your private data. You will be able to view the scope of the permissions the Developer Product is requesting, and accept or deny them, when you grant it authorization via OAuth. +**Privacy.** When you select or use a Developer Product, GitHub may share certain Personal Information (as defined in the [GitHub Privacy Statement](/site-policy/privacy-policies/github-privacy-statement)) with the Product Provider (if any such Personal Information is received from you) in order to provide you with the Developer Product, regardless of your privacy settings. Depending on the requirements of the Developer Product you choose, GitHub may share as little as your account name, ID, and primary email address or as much as access to the content in your repositories, including the ability to read and modify your private data. You will be able to view the scope of the permissions the Developer Product is requesting, and accept or deny them, when you grant it authorization via OAuth. If you cease using the Developer Product and revoke access through your account settings, the Product Provider will no longer be able to access your account. The Product Provider is responsible for deleting your Personal Information from its systems within its defined window. Please contact the Product Provider to ensure that your account has been properly terminated. diff --git a/content/site-policy/github-terms/github-terms-of-service.md b/content/site-policy/github-terms/github-terms-of-service.md index ea1a748fb919..4b148ec31752 100644 --- a/content/site-policy/github-terms/github-terms-of-service.md +++ b/content/site-policy/github-terms/github-terms-of-service.md @@ -143,7 +143,7 @@ GitHub personnel may only access the content of your private repositories in the You may choose to enable additional access to your private repositories. For example: - You may enable various GitHub services or features that require additional rights to Your Content in private repositories. These rights may vary depending on the service or feature, but GitHub will continue to treat your private repository Content as confidential. If those services or features require rights in addition to those we need to provide the GitHub Service, we will provide an explanation of those rights. -Additionally, we may be [compelled by law](/site-policy/privacy-policies/github-privacy-statement#for-legal-disclosure) to disclose the contents of your private repositories. +Additionally, we may be [compelled by law](/site-policy/privacy-policies/github-privacy-statement#for-legal-disclosure) to disclose the contents of your private repositories. GitHub will provide notice regarding our access to private repository content, unless [for legal disclosure](/site-policy/privacy-policies/github-privacy-statement#for-legal-disclosure), to comply with our legal obligations, or where otherwise bound by requirements under law, for automated scanning, or if in response to a security threat or other risk to security. @@ -195,7 +195,7 @@ As a user of Beta Previews, you may get access to special information that isn **Confidentiality Obligations.** You agree that any non-public Beta Preview information we give you, such as information about a private Beta Preview, will be considered GitHub’s confidential information (collectively, “Confidential Information”), regardless of whether it is marked or identified as such. You agree to only use such Confidential Information for the express purpose of testing and evaluating the Beta Preview (the “Purpose”), and not for any other purpose. You should use the same degree of care as you would with your own confidential information, but no less than reasonable precautions to prevent any unauthorized use, disclosure, publication, or dissemination of our Confidential Information. You promise not to disclose, publish, or disseminate any Confidential Information to any third party, unless we don’t otherwise prohibit or restrict such disclosure (for example, you might be part of a GitHub-organized group discussion about a private Beta Preview feature). -**Exceptions.** Confidential Information will not include information that is: (a) or becomes publicly available without breach of this Agreement through no act or inaction on your part (such as when a private Beta Preview becomes a public Beta Preview); (b) known to you before we disclose it to you; (c) independently developed by you without breach of any confidentiality obligation to us or any third party; or (d) disclosed with permission from GitHub. You will not violate the terms of this Agreement if you are required to disclose Confidential Information pursuant to operation of law, provided GitHub has been given reasonable advance written notice to object, unless prohibited by law. +**Exceptions.** Confidential Information will not include information that is: (a) or becomes publicly available without breach of this Agreement through no act or inaction on your part (such as when a private Beta Preview becomes a public Beta Preview); (b) known to you before we disclose it to you; (c) independently developed by you without breach of any confidentiality obligation to us or any third party; or (d) disclosed with permission from GitHub. You will not violate the terms of this Agreement if you are required to disclose Confidential Information pursuant to operation of law, provided GitHub has been given reasonable advance written notice to object, unless prohibited by law. ### 3. Feedback diff --git a/content/site-policy/other-site-policies/github-and-trade-controls.md b/content/site-policy/other-site-policies/github-and-trade-controls.md index eb59349dfd70..3d36ec4f6437 100644 --- a/content/site-policy/other-site-policies/github-and-trade-controls.md +++ b/content/site-policy/other-site-policies/github-and-trade-controls.md @@ -18,7 +18,7 @@ GitHub.com, GitHub Enterprise Server, and the information you upload to either p GitHub’s vision is to be the global platform for developer collaboration, no matter where developers reside. We take seriously our responsibility to examine government sanctions thoroughly to be certain that users and customers are not impacted beyond what is required by law. This includes keeping public repository services, including those for open source projects, available and accessible to support personal communications involving developers in sanctioned regions. This also means GitHub will advocate for developers in sanctioned regions to enjoy greater access to the platform and full access to the global open source community. -As a result of our advocacy and hard work with U.S. regulators, GitHub has secured a license from the U.S. Treasury Department’s Office of Foreign Assets Control (OFAC) to restore our cloud services to developers in Iran. And we will continue to work with U.S. regulators to secure similar licenses to offer collaboration services to developers in other sanctioned regions, such as Syria and Crimea. We are committed to advocating for the broadest possible developer access, as we believe offering code collaboration services for developers in sanctioned regions makes the global developer community stronger, advances human progress, and supports the enduring U.S. foreign policy of promoting free speech and the free flow of information. For information about the license we secured for developers in Iran, read [the blog post](https://github.blog/2021-01-05-advancing-developer-freedom-github-is-fully-available-in-iran). +As a result of our advocacy and hard work with U.S. regulators, GitHub has secured a license from the U.S. Treasury Department’s Office of Foreign Assets Control (OFAC) to restore our cloud services to developers in Iran. And we will continue to work with U.S. regulators to secure similar licenses to offer collaboration services to developers in other sanctioned regions, such as Syria and Crimea. We are committed to advocating for the broadest possible developer access, as we believe offering code collaboration services for developers in sanctioned regions makes the global developer community stronger, advances human progress, and supports the enduring U.S. foreign policy of promoting free speech and the free flow of information. For information about the license we secured for developers in Iran, read [the blog post](https://github.blog/2021-01-05-advancing-developer-freedom-github-is-fully-available-in-iran). Although we've provided the following information below for your convenience, it is ultimately your responsibility to ensure that your use of GitHub's products and services complies with all applicable laws and regulations, including U.S. export control laws. diff --git a/content/site-policy/other-site-policies/github-deceased-user-policy.md b/content/site-policy/other-site-policies/github-deceased-user-policy.md index 56497499b282..3fc236e3ee03 100644 --- a/content/site-policy/other-site-policies/github-deceased-user-policy.md +++ b/content/site-policy/other-site-policies/github-deceased-user-policy.md @@ -10,7 +10,7 @@ redirect_from: - /github/site-policy/github-terms-and-other-site-policies/github-deceased-user-policy --- -In the event that a GitHub user passes away, we can work with an authorized individual to determine what happens to the account's content. +In the event that a GitHub user passes away, we can work with an authorized individual to determine what happens to the account's content. If you are next of kin, a [pre-designated successor](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories), or other authorized individual (which could include a collaborator or business partner) of a deceased user and would like to make a request regarding their account, you can reach out to us at https://support.github.com/contact. Please provide the following information in your message: @@ -22,6 +22,6 @@ If you are next of kin, a [pre-designated successor](/account-and-profile/settin - If designated as account successor, the username of your GitHub account - What action you are seeking (e.g. transfer public repositories, cancel billing on account) -Once we have received your request, we may follow up with a request for additional information, such as a copy of your photo identification, copy of the death certificate, and documentation confirming you are authorized to act in relation to the deceased user’s account, to verify that we are properly authorized to process your request. +Once we have received your request, we may follow up with a request for additional information, such as a copy of your photo identification, copy of the death certificate, and documentation confirming you are authorized to act in relation to the deceased user’s account, to verify that we are properly authorized to process your request. Please note, the information you provide in your request is collected in accordance with our [Privacy Statement](/site-policy/privacy-policies/github-privacy-statement), and we will retain the information only as necessary to comply with our legal obligations and resolve disputes. diff --git a/content/site-policy/privacy-policies/github-candidate-privacy-policy.md b/content/site-policy/privacy-policies/github-candidate-privacy-policy.md index 03d74750bf44..f093a2b0e173 100644 --- a/content/site-policy/privacy-policies/github-candidate-privacy-policy.md +++ b/content/site-policy/privacy-policies/github-candidate-privacy-policy.md @@ -11,13 +11,13 @@ redirect_from: Effective Date: March 8, 2021 -This GitHub Candidate Privacy Policy explains what information we collect about you during the application or recruitment process for employment with GitHub, as well as the purposes for which we collect and use that information. +This GitHub Candidate Privacy Policy explains what information we collect about you during the application or recruitment process for employment with GitHub, as well as the purposes for which we collect and use that information. For the purposes of this policy: -“Candidate” includes applicants and candidates who are part of the GitHub application or recruitment process; and +“Candidate” includes applicants and candidates who are part of the GitHub application or recruitment process; and -"Candidate Personal Information" refers to any information we collect about one of our Candidates during the application or recruitment process which could, alone or together with other information, personally identify them or otherwise be reasonably linked or connected with them. +"Candidate Personal Information" refers to any information we collect about one of our Candidates during the application or recruitment process which could, alone or together with other information, personally identify them or otherwise be reasonably linked or connected with them. This policy does not apply to the use of GitHub services, which are covered under our [GitHub Privacy Statement](/site-policy/privacy-policies/github-privacy-statement). @@ -29,30 +29,30 @@ The Candidate Personal Information we collect, use, and maintain (or “process **National identifiers**, such as your citizenship status, residency and work permit status. -**Employment and education history**, such as your resume or CV, cover letter, details of how you heard about the position you are applying for, information about any previous employment at GitHub or affiliates of GitHub, or other information you provide to us in support of an application and/or the application and recruitment process. +**Employment and education history**, such as your resume or CV, cover letter, details of how you heard about the position you are applying for, information about any previous employment at GitHub or affiliates of GitHub, or other information you provide to us in support of an application and/or the application and recruitment process. **Professional or employment information**, including your desired salary or terms related to benefits, willingness to relocate, other job preferences, interview details, reference information and/or information received from background checks (where applicable), and information from publicly available resources (such as your LinkedIn profile or website). -**Sensitive or demographic information**, such as your gender, medical or health information, veteran status, or your racial or ethnic origin. - +**Sensitive or demographic information**, such as your gender, medical or health information, veteran status, or your racial or ethnic origin. + ## How do we use the Candidate Personal Information we collect? We use the Candidate Personal Information for the following purposes: - To assess your skills, qualifications and interests for employment opportunities with GitHub; - To verify the information provided by you or others, including checking your references; - To communicate with you about your application and the recruitment process, including informing you of other potential employment opportunities at GitHub; - - If you were referred, to inform the referrer of the status of your application; + - If you were referred, to inform the referrer of the status of your application; - If you are offered a position, to prepare your offer letter and conduct a background check (to the extent permitted by applicable law); - If you are offered a position and where requested by you, to assist you with obtaining an immigration visa or work permit; - To comply with local laws, regulations, legal processes or enforceable government requests; and - To prepare and submit reports as required under local laws and regulations; - To manage and improve our application and recruitment process (such as making the application process more efficient and improving our diversity practices). - + ## How do we share your Candidate Personal Information? - + GitHub will share your Candidate Personal Information with those who have a legitimate business need for it. Whenever we permit a third party to access your Candidate Personal Information, we will make sure the information is used in a manner consistent with this policy. Your Candidate Personal Information may be shared with our affiliates (such as Microsoft) and other third parties (such as vendors) for the following purposes: 1. In order to carry out the uses of Candidate Personal Information described above; -2. To enable third parties to provide products or services to us or on our behalf (such as to facilitate the application process or conduct background checks). +2. To enable third parties to provide products or services to us or on our behalf (such as to facilitate the application process or conduct background checks). 3. To comply with our legal obligations, regulations or contracts, or to respond to a court order, administrative or judicial process (such as subpoena, government audit or search warrant) or, in response to lawful requests by public authorities (such as national security or law enforcement); 4. As necessary to establish, exercise, or defend against potential or pending litigation; 5. Where necessary to protect GitHub, your vital interests (such as safety and security), or those of another person; or @@ -60,12 +60,12 @@ GitHub will share your Candidate Personal Information with those who have a legi ## Your rights to your Candidate Personal Information -In some locations, Candidates may have certain rights under applicable local privacy laws (such as the European General Data Protection Regulation). However, regardless of your location, we provide the same high standard of privacy protection to all of our Candidates around the world. +In some locations, Candidates may have certain rights under applicable local privacy laws (such as the European General Data Protection Regulation). However, regardless of your location, we provide the same high standard of privacy protection to all of our Candidates around the world. This includes the rights to request access or correct your information, request that your information be deleted, or object to or restrict GitHub from using it for certain purposes. -You can make a request to do so by contacting privacy@github.com. We will respond to all requests in accordance with applicable data protection laws. - +You can make a request to do so by contacting privacy@github.com. We will respond to all requests in accordance with applicable data protection laws. + ## How long do we retain your Candidate Personal Information? Candidate Personal Information will be stored for one year after your application to comply with our legal obligations. After that time, we will contact you and ask for your consent to continue to retain your personal information so that we can consider you for any future job opportunities at GitHub. @@ -74,4 +74,4 @@ If you are hired for a position at GitHub, we will retain the information provid ## Changes to this Policy -We may occasionally update this GitHub Candidate Privacy Policy. When we do make changes to this page, we will update the "last updated" date. +We may occasionally update this GitHub Candidate Privacy Policy. When we do make changes to this page, we will update the "last updated" date. diff --git a/content/site-policy/privacy-policies/github-copilot-for-business-privacy-statement.md b/content/site-policy/privacy-policies/github-copilot-for-business-privacy-statement.md index 824f432476b7..6eaaeae6112e 100644 --- a/content/site-policy/privacy-policies/github-copilot-for-business-privacy-statement.md +++ b/content/site-policy/privacy-policies/github-copilot-for-business-privacy-statement.md @@ -14,10 +14,10 @@ Use of GitHub Copilot for Business is also subject to the [GitHub Privacy Statem ## What data does Copilot for Business collect? Copilot for Business relies on file content and additional data to work. It collects data to provide the service, some of which is then saved for further analysis and product improvements. Copilot for Business collects data as described below: -## User Engagement Data +## User Engagement Data When you use Copilot for Business it will collect usage information about events generated when interacting with the IDE or editor. These events include user edit actions like completions accepted and dismissed, and error and general usage data to identify metrics like latency and features engagement. This information may include personal data, such as pseudonymous identifiers. -## Code Snippets Data +## Code Snippets Data GitHub Copilot transmits snippets of your code from your IDE to GitHub to provide Suggestions to you. Code snippets data is only transmitted in real-time to return Suggestions, and is discarded once a Suggestion is returned. Copilot for Business does not retain any Code Snippets Data. ## How is data in Copilot for Business used and shared? @@ -30,6 +30,6 @@ Such uses may include: - Conducting experiments and research related to developers and their use of developer tools and services. ## How can users of Copilot for Business control use of their data? -User engagement data (which includes pseudonymous identifiers and general usage data), is required for the use of GitHub Copilot and will continue to be collected, processed, and shared with Microsoft when you use GitHub Copilot. +User engagement data (which includes pseudonymous identifiers and general usage data), is required for the use of GitHub Copilot and will continue to be collected, processed, and shared with Microsoft when you use GitHub Copilot. For more information on how GitHub processes and uses personal data, please see the [GitHub Privacy Statement](/site-policy/privacy-policies/github-privacy-statement). diff --git a/content/site-policy/privacy-policies/github-octernships-terms-of-service.md b/content/site-policy/privacy-policies/github-octernships-terms-of-service.md index 71f0d7bb1795..8d7f0d9ff828 100644 --- a/content/site-policy/privacy-policies/github-octernships-terms-of-service.md +++ b/content/site-policy/privacy-policies/github-octernships-terms-of-service.md @@ -12,7 +12,7 @@ topics: GITHUB HAS INVITED YOU TO PARTICIPATE IN THE GITHUB OCTERNSHIPS PROGRAM (“THE PROGRAM”). BY ACCEPTING GITHUB’S INVITATION TO PARTICIPATE IN THE PROGRAM, YOU AGREE TO BE BOUND BY THE FOLLOWING GITHUB OCTERNSHIPS PROGRAM TERMS AND CONDITIONS (“TERMS AND CONDITIONS”): -When you click "I agree", “I accept”, or similar buttons, you accept all the terms and conditions of this Agreement. +When you click "I agree", “I accept”, or similar buttons, you accept all the terms and conditions of this Agreement. ## 1. Compensation or benefits The Program is offered to verified students on GitHub Global Campus in countries where the program is available. As a participant, you will not be considered an employee or intern of GitHub. You will be entitled to 1 (minimum) to 6 (maximum) months internship along with stipend of 500 USD/month by the partner organization (“Partner Organization”). GitHub and the Partner Organization are collectively referred to as the “Octernships Partners.” You will not be entitled to any compensation or benefits paid or made available by the Octernships Partner to their respective employees, including, without limitation, any vacation or illness payments, or to participate in any plans, arrangements or distributions made by the Octernship Partners pertaining to any bonus, stock option, profit sharing, insurance or similar benefits. @@ -22,7 +22,7 @@ The Program is offered to verified students on GitHub Global Campus in countries You hereby grant the Octernships Partners a non-exclusive, irrevocable, perpetual, royalty-free, worldwide license to make, have made, use, offer to sell, sell, import, copy, modify, create derivative works based upon, distribute, sublicense, display, perform and transmit any work product you create in connection with the Program or during your internship, including, without limitation, concepts, works, inventions, information, drawings, designs, programs, or software. ### 2.2 Likeness -GitHub and Octernships Partners reserve all rights, including the right to edit, publish, use, adapt, modify or dispose of any work product/description, likenesses, and photographs for advertising and promotional purposes in all media (including, but not limited to, the internet) without additional compensation, except where prohibited by law. +GitHub and Octernships Partners reserve all rights, including the right to edit, publish, use, adapt, modify or dispose of any work product/description, likenesses, and photographs for advertising and promotional purposes in all media (including, but not limited to, the internet) without additional compensation, except where prohibited by law. ## 3. Confidentiality and non-disclosure Without limiting any separate agreement between yourself and either GitHub or the Partner Organization concerning GitHub's and Partner Organization’s confidential information, including, without limitation, any GitHub or Partner Organization Nondisclosure Agreement you might enter into, you agree that you will not publish, disclose, or otherwise divulge or use (other than as expressly permitted under the terms and conditions of the Program) any Confidential Information of GitHub or Partner Organization without their prior written consent in each instance. "Confidential Information" means all information and material that is transmitted by GitHub or Partner Organization to you (or otherwise developed or obtained by you) in connection with your participation in the Program that you should reasonably have understood due to legends or other markings, the circumstances of disclosure or the nature of the information itself, to be proprietary and confidential to GitHub or Partner Organization, including, without limitation, any information or material relating to products, services, vendor lists, customer lists, prospect lists, pricing and sales information, and business strategies and plans. You will exercise at least the same amount of diligence in preserving the secrecy of the Confidential Information as you use in preserving the secrecy of your own most valuable confidential information, but in no event less than reasonable care. Confidential Information does not include information or material that you can document (a) is publicly available through no action or fault of yours; (b) was already in your possession or known to you prior to being disclosed or provided to you by GitHub or Partner Organization, provided that the source of such information or material was not obligated in any way to maintain its confidentiality; (c) was or is obtained by you from a third party, provided that such third party was not obligated in any way to maintain its confidentiality; or (d) is independently developed by you without reference to any Confidential Information. diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md index 4d942c717aa2..811aa742670b 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md @@ -16,13 +16,13 @@ shortTitle: Tax information ## W-9/W-8 tax forms -By law, {% data variables.product.prodname_dotcom %} is required by the U.S. Internal Revenue Service (IRS) to collect tax information from all U.S. and non-U.S. maintainers. These forms are held by {% data variables.product.prodname_dotcom %} and are not required to be submitted to the IRS. +By law, {% data variables.product.prodname_dotcom %} is required by the U.S. Internal Revenue Service (IRS) to collect tax information from all U.S. and non-U.S. maintainers. These forms are held by {% data variables.product.prodname_dotcom %} and are not required to be submitted to the IRS. ### W-9 (U.S.) The information from W-9 tax forms helps {% data variables.product.prodname_dotcom %} use the correct Taxpayer Identification Number (TIN) to report income paid to you to the IRS in a 1099 form. -If you are a taxpayer in the United States, you must submit a [W-9](https://www.irs.gov/forms-pubs/about-form-w-9) before you can publish your {% data variables.product.prodname_sponsors %} profile. +If you are a taxpayer in the United States, you must submit a [W-9](https://www.irs.gov/forms-pubs/about-form-w-9) before you can publish your {% data variables.product.prodname_sponsors %} profile. ### W-8 BEN/W-8 BEN-E (non-U.S.) @@ -34,7 +34,7 @@ If you have been assigned an incorrect tax form, [contact {% data variables.prod ### Tax identification numbers -The W-8 BEN and W-8 BEN-E tax forms ask for a "U.S. taxpayer identification number (SSN or ITIN)" or "Foreign tax identifying number". +The W-8 BEN and W-8 BEN-E tax forms ask for a "U.S. taxpayer identification number (SSN or ITIN)" or "Foreign tax identifying number". If you are not a U.S. citizen or other U.S. person, including a resident alien individual, then you will usually need to provide the "Foreign tax identifying number". This is a tax identification number that your country of residence has issued you. diff --git a/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md b/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md index 432b05f01ad3..ad34fa1bf705 100644 --- a/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md +++ b/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md @@ -19,7 +19,7 @@ When an organization pays by invoice, they will not be charged the 3% credit car Sign up to pay by invoice by contacting {% data variables.contact.contact_support %}. -Organizations paying by invoice will be invoiced separately for their {% data variables.product.prodname_sponsors %} payments and their other payments to {% data variables.product.company_short %}. Organizations can be invoiced for sponsorships and pay via credit card for other payments to {% data variables.product.company_short %}. +Organizations paying by invoice will be invoiced separately for their {% data variables.product.prodname_sponsors %} payments and their other payments to {% data variables.product.company_short %}. Organizations can be invoiced for sponsorships and pay via credit card for other payments to {% data variables.product.company_short %}. ## Understanding your Sponsors invoice diff --git a/content/video-transcripts/transcript-codespaces-your-instant-dev-box-in-the-cloud.md b/content/video-transcripts/transcript-codespaces-your-instant-dev-box-in-the-cloud.md index b78939b150ea..a1b280601592 100644 --- a/content/video-transcripts/transcript-codespaces-your-instant-dev-box-in-the-cloud.md +++ b/content/video-transcripts/transcript-codespaces-your-instant-dev-box-in-the-cloud.md @@ -25,7 +25,7 @@ Developer: A codespace is an instant cloud developer environment, where we can r [The codespace opens in the VS Code web editor in the browser, running with the dark theme. Directories and files from the repository are displayed in the left sidebar. In an integrated terminal, a message says, "Welcome to Codespaces," and lists included runtimes and tools.] -Developer: So when we create this codespace, you'll see we land in a machine that is already set up, and it has Python, Node, Docker, and even more, so it has tools like Java and Rust and Go and C++. +Developer: So when we create this codespace, you'll see we land in a machine that is already set up, and it has Python, Node, Docker, and even more, so it has tools like Java and Rust and Go and C++. But you'll see we landed in the default image. The great thing about Codespaces is you can fully customize your setup, not only for you, but for everyone else who comes along in this repository. So you can have a "config-as-code" setup that allows you to use your own image, or Dockerfile, or Docker Compose. diff --git a/data/reusables/actions/comparing-artifacts-caching.md b/data/reusables/actions/comparing-artifacts-caching.md index 57ff54494bc2..99946f772c23 100644 --- a/data/reusables/actions/comparing-artifacts-caching.md +++ b/data/reusables/actions/comparing-artifacts-caching.md @@ -3,4 +3,4 @@ Artifacts and caching are similar because they provide the ability to store files on {% data variables.product.prodname_dotcom %}, but each feature offers different use cases and cannot be used interchangeably. - Use caching when you want to reuse files that don't change often between jobs or workflow runs, such as build dependencies from a package management system. -- Use artifacts when you want to save files produced by a job to view after a workflow run has ended, such as built binaries or build logs. +- Use artifacts when you want to save files produced by a job to view after a workflow run has ended, such as built binaries or build logs. diff --git a/data/reusables/actions/disable-selfhosted-runners-overview.md b/data/reusables/actions/disable-selfhosted-runners-overview.md index 37bcfa16cc73..ac977c324725 100644 --- a/data/reusables/actions/disable-selfhosted-runners-overview.md +++ b/data/reusables/actions/disable-selfhosted-runners-overview.md @@ -1,4 +1,4 @@ -There is no guarantee that self-hosted runners for {% data variables.product.product_name %} will be hosted on ephemeral, clean virtual machines. As a result, they may be compromised by untrusted code in a workflow. +There is no guarantee that self-hosted runners for {% data variables.product.product_name %} will be hosted on ephemeral, clean virtual machines. As a result, they may be compromised by untrusted code in a workflow. Similarly, anyone who can fork the repository and open a pull request (generally those with read access to the repository) can compromise the self-hosted runner environment, including gaining access to secrets and the `GITHUB_TOKEN` which, depending on its settings, can grant write access to the repository. Although workflows can control access to environment secrets by using environments and required reviews, these workflows are not run in an isolated environment and are still susceptible to the same risks when run on a self-hosted runner. diff --git a/data/reusables/actions/example-docs-engineering-intro.md b/data/reusables/actions/example-docs-engineering-intro.md index c8071d5843bb..2002e31cdc90 100644 --- a/data/reusables/actions/example-docs-engineering-intro.md +++ b/data/reusables/actions/example-docs-engineering-intro.md @@ -1 +1 @@ -The following workflow was created by the {% data variables.product.prodname_dotcom %} Docs Engineering team. To review the latest version of this file in the [`github/docs`](https://github.com/github/docs) repository, see +The following workflow was created by the {% data variables.product.prodname_dotcom %} Docs Engineering team. To review the latest version of this file in the [`github/docs`](https://github.com/github/docs) repository, see diff --git a/data/reusables/actions/example-workflow-intro-ci.md b/data/reusables/actions/example-workflow-intro-ci.md index a0fad96218c9..32acc9841f9b 100644 --- a/data/reusables/actions/example-workflow-intro-ci.md +++ b/data/reusables/actions/example-workflow-intro-ci.md @@ -1 +1 @@ -This article uses an example workflow to demonstrate some of the main CI features of {% data variables.product.prodname_actions %}. +This article uses an example workflow to demonstrate some of the main CI features of {% data variables.product.prodname_actions %}. diff --git a/data/reusables/actions/general-security-hardening.md b/data/reusables/actions/general-security-hardening.md index 87254ac8e9d1..d978bee46b02 100644 --- a/data/reusables/actions/general-security-hardening.md +++ b/data/reusables/actions/general-security-hardening.md @@ -1,3 +1,3 @@ -## General security hardening for {% data variables.product.prodname_actions %} +## General security hardening for {% data variables.product.prodname_actions %} If you want to learn more about security practices for {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions)." diff --git a/data/reusables/actions/inputs-vs-github-event-inputs.md b/data/reusables/actions/inputs-vs-github-event-inputs.md index 96e7c03c0e67..4d6fc3d06fbf 100644 --- a/data/reusables/actions/inputs-vs-github-event-inputs.md +++ b/data/reusables/actions/inputs-vs-github-event-inputs.md @@ -2,7 +2,7 @@ {% note %} -**Notes**: +**Notes**: - The workflow will also receive the inputs in the `github.event.inputs` context. The information in the `inputs` context and `github.event.inputs` context is identical except that the `inputs` context preserves Boolean values as Booleans instead of converting them to strings. The `choice` type resolves to a string and is a single selectable option. - The maximum number of top-level properties for `inputs` is 10. diff --git a/data/reusables/actions/jobs/section-running-jobs-in-a-container-credentials.md b/data/reusables/actions/jobs/section-running-jobs-in-a-container-credentials.md index bbfb2613a4a1..d645231024f0 100644 --- a/data/reusables/actions/jobs/section-running-jobs-in-a-container-credentials.md +++ b/data/reusables/actions/jobs/section-running-jobs-in-a-container-credentials.md @@ -1,6 +1,6 @@ {% data reusables.actions.registry-credentials %} -#### Example: Defining credentials for a container registry +#### Example: Defining credentials for a container registry {% raw %} ```yaml diff --git a/data/reusables/actions/jobs/using-matrix-strategy.md b/data/reusables/actions/jobs/using-matrix-strategy.md index 466c27bd06a8..96a611fa1166 100644 --- a/data/reusables/actions/jobs/using-matrix-strategy.md +++ b/data/reusables/actions/jobs/using-matrix-strategy.md @@ -9,7 +9,7 @@ jobs: os: [ubuntu-latest, windows-latest] ``` -A job will run for each possible combination of the variables. In this example, the workflow will run six jobs, one for each combination of the `os` and `version` variables. +A job will run for each possible combination of the variables. In this example, the workflow will run six jobs, one for each combination of the `os` and `version` variables. By default, {% data variables.product.product_name %} will maximize the number of jobs run in parallel depending on runner availability. The order of the variables in the matrix determines the order in which the jobs are created. The first variable you define will be the first job that is created in your workflow run. For example, the above matrix will create the jobs in the following order: diff --git a/data/reusables/actions/runner-group-assign-policy-workflow.md b/data/reusables/actions/runner-group-assign-policy-workflow.md index acbcbcd28821..d7457da04c0d 100644 --- a/data/reusables/actions/runner-group-assign-policy-workflow.md +++ b/data/reusables/actions/runner-group-assign-policy-workflow.md @@ -1,6 +1,6 @@ {%- ifversion restrict-groups-to-workflows %} 1. Assign a policy for workflow access. - You can configure a runner group to be accessible to a specific list of workflows, or to all workflows. This setting can't be overridden if you are configuring an organization's runner group that was shared by an enterprise. If you specify what workflow can access the runner group, you must use the full path to the workflow, including the repository name and owner, and you must pin the workflow to a branch, tag, or full SHA. For example: `octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main`. - + You can configure a runner group to be accessible to a specific list of workflows, or to all workflows. This setting can't be overridden if you are configuring an organization's runner group that was shared by an enterprise. If you specify what workflow can access the runner group, you must use the full path to the workflow, including the repository name and owner, and you must pin the workflow to a branch, tag, or full SHA. For example: `octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main`. + Only jobs directly defined within the selected workflows will have access to the runner group.{%- endif %} diff --git a/data/reusables/actions/self-hosted-runner-management-permissions-required.md b/data/reusables/actions/self-hosted-runner-management-permissions-required.md index 9c3f42102fad..bb0d3ca716b6 100644 --- a/data/reusables/actions/self-hosted-runner-management-permissions-required.md +++ b/data/reusables/actions/self-hosted-runner-management-permissions-required.md @@ -1,6 +1,6 @@ A self-hosted runner can be located in either your repository, organization, or {% ifversion fpt or ghec %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif ghes or ghae %} enterprise settings on {% data variables.location.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added: - **User repository**: You must be the repository owner. -- **Organization**: You must be an organization owner. +- **Organization**: You must be an organization owner. - **Organization repository**: You must be an organization owner, or have admin access to the repository. {% ifversion ghec %} - **Enterprise account**: You must be an enterprise owner. diff --git a/data/reusables/actions/self-hosted-runner-ports-protocols.md b/data/reusables/actions/self-hosted-runner-ports-protocols.md index 60528300003d..fa711b3cb330 100644 --- a/data/reusables/actions/self-hosted-runner-ports-protocols.md +++ b/data/reusables/actions/self-hosted-runner-ports-protocols.md @@ -1,3 +1,3 @@ {% ifversion ghes or ghae %} -The connection between self-hosted runners and {% data variables.product.product_name %} is over {% ifversion ghes %}HTTP (port 80) or {% endif %}HTTPS (port 443). {% ifversion ghes %}To ensure connectivity over HTTPS, configure TLS for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls)."{% endif %} +The connection between self-hosted runners and {% data variables.product.product_name %} is over {% ifversion ghes %}HTTP (port 80) or {% endif %}HTTPS (port 443). {% ifversion ghes %}To ensure connectivity over HTTPS, configure TLS for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls)."{% endif %} {% endif %} diff --git a/data/reusables/actions/workflow-permissions-modifying.md b/data/reusables/actions/workflow-permissions-modifying.md index 513b74924397..22d44c41e720 100644 --- a/data/reusables/actions/workflow-permissions-modifying.md +++ b/data/reusables/actions/workflow-permissions-modifying.md @@ -1 +1 @@ -Anyone with write access to a repository can modify the permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, by editing the `permissions` key in the workflow file. For more information, see [`permissions`](/actions/using-workflows/workflow-syntax-for-github-actions#permissions). +Anyone with write access to a repository can modify the permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, by editing the `permissions` key in the workflow file. For more information, see [`permissions`](/actions/using-workflows/workflow-syntax-for-github-actions#permissions). diff --git a/data/reusables/advanced-security/secret-scanning-push-protection-enterprise.md b/data/reusables/advanced-security/secret-scanning-push-protection-enterprise.md index fb7663a34ecb..c188f5e0959b 100644 --- a/data/reusables/advanced-security/secret-scanning-push-protection-enterprise.md +++ b/data/reusables/advanced-security/secret-scanning-push-protection-enterprise.md @@ -1,5 +1,5 @@ 1. Under "{% data variables.product.prodname_secret_scanning_caps %}", under "Push protection", click **Enable all**. - + ![Screenshot of the "Push protection" section of the "Code security and analysis" page. Two buttons, labeled "Enable all" and "Disable all", are highlighted with a dark orange outline.](/assets/images/enterprise/security/secret-scanning-enable-push-protection-enterprise.png) 2. Optionally, click "Automatically enable for repositories added to {% data variables.product.prodname_secret_scanning %}."{% ifversion secret-scanning-custom-link-on-block %} diff --git a/data/reusables/apps/oauth-app-access-restrictions.md b/data/reusables/apps/oauth-app-access-restrictions.md index 8e272706c4fe..b6da84930079 100644 --- a/data/reusables/apps/oauth-app-access-restrictions.md +++ b/data/reusables/apps/oauth-app-access-restrictions.md @@ -1 +1 @@ -When {% data variables.product.prodname_oauth_app %} access restrictions are enabled, organization members and outside collaborators cannot authorize {% data variables.product.prodname_oauth_app %} access to organization resources. Organization members can request owner approval for {% data variables.product.prodname_oauth_apps %} they'd like to use, and organization owners receive a notification of pending requests. +When {% data variables.product.prodname_oauth_app %} access restrictions are enabled, organization members and outside collaborators cannot authorize {% data variables.product.prodname_oauth_app %} access to organization resources. Organization members can request owner approval for {% data variables.product.prodname_oauth_apps %} they'd like to use, and organization owners receive a notification of pending requests. diff --git a/data/reusables/audit_log/git-events-export-limited.md b/data/reusables/audit_log/git-events-export-limited.md index 6a4f30e847b9..16f4b1894032 100644 --- a/data/reusables/audit_log/git-events-export-limited.md +++ b/data/reusables/audit_log/git-events-export-limited.md @@ -1,7 +1,7 @@ {% ifversion ghec %} {% note %} -**Note:** When you export Git events, events that were initiated via the web browser or the REST or GraphQL APIs are not included. For example, when a user merges a pull request in the web browser, changes are pushed to the base branch, but the Git event for that push is not included in the export. +**Note:** When you export Git events, events that were initiated via the web browser or the REST or GraphQL APIs are not included. For example, when a user merges a pull request in the web browser, changes are pushed to the base branch, but the Git event for that push is not included in the export. -{% endnote %} +{% endnote %} {% endif %} diff --git a/data/reusables/billing/edit-payment-method.md b/data/reusables/billing/edit-payment-method.md index df61294b6fd9..b73729fb9940 100644 --- a/data/reusables/billing/edit-payment-method.md +++ b/data/reusables/billing/edit-payment-method.md @@ -1,3 +1,3 @@ 1. If your account has an existing payment method that you want to update, click **Edit**. - + ![Screenshot of the "Payment method" section. Next to "Payment method", a link, labeled "Edit", is outlined in dark orange.](/assets/images/help/billing/billing-payment-method-edit-button.png) diff --git a/data/reusables/billing/email-notifications.md b/data/reusables/billing/email-notifications.md index 317a242e59aa..33e5301b4ea3 100644 --- a/data/reusables/billing/email-notifications.md +++ b/data/reusables/billing/email-notifications.md @@ -1,3 +1,3 @@ -Email notifications are sent to account owners and billing managers when spending reaches 50%, 75%, 90% and 100% of your account's included usage and when spending reaches 50%, 75%, 90%, and 100% of your account's spending limit. +Email notifications are sent to account owners and billing managers when spending reaches 50%, 75%, 90% and 100% of your account's included usage and when spending reaches 50%, 75%, 90%, and 100% of your account's spending limit. You can disable these notifications at any time by navigating to the "Email alerts" section at the bottom of the "Spending limit" page. diff --git a/data/reusables/billing/license-statuses.md b/data/reusables/billing/license-statuses.md index 2572ebc62f7a..0ff8dedd4285 100644 --- a/data/reusables/billing/license-statuses.md +++ b/data/reusables/billing/license-statuses.md @@ -1,6 +1,6 @@ {% ifversion ghec %} If your license includes {% data variables.visual_studio.prodname_vss_ghe %}, you can identify whether a user account on {% data variables.product.prodname_dotcom_the_website %} has successfully matched with a {% data variables.product.prodname_vs %} subscriber by downloading the CSV file that contains additional license details. The license status will be one of the following. - "Matched": The user account on {% data variables.product.prodname_dotcom_the_website %} is linked with a {% data variables.product.prodname_vs %} subscriber. -- "Pending Invitation": An invitation was sent to a {% data variables.product.prodname_vs %} subscriber, but the subscriber has not accepted the invitation. +- "Pending Invitation": An invitation was sent to a {% data variables.product.prodname_vs %} subscriber, but the subscriber has not accepted the invitation. - Blank: There is no {% data variables.product.prodname_vs %} association to consider for the user account on {% data variables.product.prodname_dotcom_the_website %}. {% endif %} diff --git a/data/reusables/classroom/supported-lmses.md b/data/reusables/classroom/supported-lmses.md index 4fec1151238d..67547bcfa929 100644 --- a/data/reusables/classroom/supported-lmses.md +++ b/data/reusables/classroom/supported-lmses.md @@ -5,7 +5,7 @@ Using LTI helps keep your information safe and secure. LTI is an industry-standard protocol and GitHub Classroom's use of LTI is certified by the Instructional Management System (IMS) Global Learning Consortium. For more information, see [Learning Tools Interoperability](https://www.imsglobal.org/activity/learning-tools-interoperability) and [About IMS Global Learning Consortium](http://www.imsglobal.org/aboutims.html) on the IMS Global Learning Consortium website. -{% data variables.product.company_short %} has tested and verified registration, connection and the import of roster data from the following LMSes into {% data variables.product.prodname_classroom %}. +{% data variables.product.company_short %} has tested and verified registration, connection and the import of roster data from the following LMSes into {% data variables.product.prodname_classroom %}. - Canvas - Moodle diff --git a/data/reusables/classroom/you-can-choose-a-template-repository.md b/data/reusables/classroom/you-can-choose-a-template-repository.md index 808c258f90f9..85b2049aa627 100644 --- a/data/reusables/classroom/you-can-choose-a-template-repository.md +++ b/data/reusables/classroom/you-can-choose-a-template-repository.md @@ -2,6 +2,6 @@ You can optionally choose a template repository as starter code for the assignme {% note %} -**Note:** The template repository must belong to your organization or be a public repository on {% data variables.product.product_name %}. +**Note:** The template repository must belong to your organization or be a public repository on {% data variables.product.product_name %}. {% endnote %} diff --git a/data/reusables/code-scanning/beta-codeql-ml-queries.md b/data/reusables/code-scanning/beta-codeql-ml-queries.md index 3bc93e5770bf..57004ecc5c45 100644 --- a/data/reusables/code-scanning/beta-codeql-ml-queries.md +++ b/data/reusables/code-scanning/beta-codeql-ml-queries.md @@ -2,7 +2,7 @@ {% note %} -**Note:** Experimental alerts for {% data variables.product.prodname_code_scanning %} are created using experimental technology in the {% data variables.product.prodname_codeql %} action. This feature is currently available as a beta release for JavaScript code and is subject to change. +**Note:** Experimental alerts for {% data variables.product.prodname_code_scanning %} are created using experimental technology in the {% data variables.product.prodname_codeql %} action. This feature is currently available as a beta release for JavaScript code and is subject to change. {% endnote %} diff --git a/data/reusables/code-scanning/example-configuration-files.md b/data/reusables/code-scanning/example-configuration-files.md index 1fe9c240976a..be0c6513bd41 100644 --- a/data/reusables/code-scanning/example-configuration-files.md +++ b/data/reusables/code-scanning/example-configuration-files.md @@ -33,7 +33,7 @@ paths-ignore: {% ifversion code-scanning-exclude-queries-from-analysis %} -The following configuration file only runs queries that generate alerts of severity error. The configuration first selects all the default queries, all queries in `./my-queries`, and the default suite in `codeql/java-queries`, then excludes all the queries that generate warnings or recommendations. +The following configuration file only runs queries that generate alerts of severity error. The configuration first selects all the default queries, all queries in `./my-queries`, and the default suite in `codeql/java-queries`, then excludes all the queries that generate warnings or recommendations. ``` yaml queries: diff --git a/data/reusables/codeql-cli/codeql-site-migration-note.md b/data/reusables/codeql-cli/codeql-site-migration-note.md index 327e771dad54..5267d1f3198a 100644 --- a/data/reusables/codeql-cli/codeql-site-migration-note.md +++ b/data/reusables/codeql-cli/codeql-site-migration-note.md @@ -1,5 +1,5 @@ {% note %} -**Note:** This article was migrated from the [CodeQL documentation website](https://codeql.github.com/docs/codeql-cli/) in January 2023. +**Note:** This article was migrated from the [CodeQL documentation website](https://codeql.github.com/docs/codeql-cli/) in January 2023. {% endnote %} diff --git a/data/reusables/codespaces/changing-machine-type-in-vscode.md b/data/reusables/codespaces/changing-machine-type-in-vscode.md index 949f7a8608a2..b0a8ee5860ab 100644 --- a/data/reusables/codespaces/changing-machine-type-in-vscode.md +++ b/data/reusables/codespaces/changing-machine-type-in-vscode.md @@ -2,7 +2,7 @@ 1. Search for and select "Codespaces: Change Machine Type." ![Screenshot of "change machine" entered as a search string and "Codespaces: Change Machine Type" in the dropdown list.](/assets/images/help/codespaces/vscode-change-machine-type-option.png) - + 1. If you're not following these instructions within a codespace, click the codespace that you want to change. ![Screenshot of a dropdown list of four codespaces.](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) diff --git a/data/reusables/codespaces/codespaces-machine-types.md b/data/reusables/codespaces/codespaces-machine-types.md index 032af767dade..67774fd97319 100644 --- a/data/reusables/codespaces/codespaces-machine-types.md +++ b/data/reusables/codespaces/codespaces-machine-types.md @@ -1,3 +1,3 @@ Typically, you can run your codespace on a choice of remote machine types. These machine types offer a choice of hardware specifications ranging from 2 cores to 32 cores, although the full range of machine types may not always be available. Each machine type has a different level of resources and a different billing tier. For information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)." -By default the machine type with the lowest valid resources is used when you create a codespace. +By default the machine type with the lowest valid resources is used when you create a codespace. diff --git a/data/reusables/codespaces/publishing-template-codespaces.md b/data/reusables/codespaces/publishing-template-codespaces.md index 8b736c4e2448..ccac8f99457f 100644 --- a/data/reusables/codespaces/publishing-template-codespaces.md +++ b/data/reusables/codespaces/publishing-template-codespaces.md @@ -17,7 +17,7 @@ If you're working in a codespace, you can publish it from the {% data variables. 3. Click **Publish Branch**. ![Screenshot of the "Source control" side bar showing the "Publish Branch" button.](/assets/images/help/codespaces/vscode-publish-branch-button.png) - + 4. In the "Repository Name" dropdown, type a name for your new repository, then select **Publish to {% data variables.product.company_short %} private repository** or **Publish to {% data variables.product.company_short %} public repository**. ![Screenshot of the repository name dropdown in VS Code. Two options are shown, for publishing to a private or a public repository.](/assets/images/help/codespaces/choose-new-repository.png) diff --git a/data/reusables/codespaces/source-control-pull-request.md b/data/reusables/codespaces/source-control-pull-request.md index 70d19fb87079..f19f798278a9 100644 --- a/data/reusables/codespaces/source-control-pull-request.md +++ b/data/reusables/codespaces/source-control-pull-request.md @@ -1,9 +1,9 @@ -1. After you've committed changes to your local copy of the repository, click the pull request icon at the top of the "Source Control" side bar. +1. After you've committed changes to your local copy of the repository, click the pull request icon at the top of the "Source Control" side bar. ![Screenshot of the top of the "Source Control" side bar. The pull request icon is highlighted with a dark orange outline.](/assets/images/help/codespaces/codespaces-commit-pr-button.png) -1. Check that the local branch and repository you're merging from, and the remote branch and repository you're merging into, are correct. Then give the pull request a title and a description. +1. Check that the local branch and repository you're merging from, and the remote branch and repository you're merging into, are correct. Then give the pull request a title and a description. ![Screenshot of the "{% data variables.product.prodname_dotcom %} Pull Request" side bar with a form for creating a pull request, including "Title" and "Description" fields.](/assets/images/help/codespaces/codespaces-commit-pr.png) - + 1. Click **Create**. diff --git a/data/reusables/codespaces/source-control.md b/data/reusables/codespaces/source-control.md index f0afa1c54b7b..98efdd0c5157 100644 --- a/data/reusables/codespaces/source-control.md +++ b/data/reusables/codespaces/source-control.md @@ -10,11 +10,11 @@ When you create a codespace from a template repository or a template on the "You {% tip %} -**Tip**: If someone has recently changed a file on the remote repository, in the branch you switched to, you may not see those changes until you pull the changes into your codespace. +**Tip**: If someone has recently changed a file on the remote repository, in the branch you switched to, you may not see those changes until you pull the changes into your codespace. {% endtip %} -## Committing your changes +## Committing your changes {% data reusables.codespaces.source-control-activity-bar %} 1. To stage your changes, click {% octicon "plus" aria-label="Stage changes" %} next to the file you've changed, or next to **Changes** if you've changed multiple files and you want to stage them all. @@ -31,7 +31,7 @@ When you create a codespace from a template repository or a template on the "You ## Pulling changes from the remote repository -You can pull changes from the remote repository into your codespace at any time. +You can pull changes from the remote repository into your codespace at any time. {% data reusables.codespaces.source-control-activity-bar %} 1. At the top of the side bar, click {% octicon "kebab-horizontal" aria-label="Views and More Actions..." %}. @@ -42,9 +42,9 @@ You can pull changes from the remote repository into your codespace at any time. If the dev container configuration has been changed since you created the codespace, you can apply the changes by rebuilding the container for the codespace. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#applying-changes-to-your-configuration)." -## Setting your codespace to automatically fetch new changes +## Setting your codespace to automatically fetch new changes -You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes. +You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes. If the fetch operation detects new changes on the remote repository, you'll see the number of new commits in the status bar. You can then pull the changes into your local copy. @@ -65,7 +65,7 @@ If the fetch operation detects new changes on the remote repository, you'll see ## Raising a pull request -{% data reusables.codespaces.source-control-pull-request %} +{% data reusables.codespaces.source-control-pull-request %} ## Pushing changes to your remote repository diff --git a/data/reusables/codespaces/usage-report-download.md b/data/reusables/codespaces/usage-report-download.md index ff5e8b184db4..11a375e4d325 100644 --- a/data/reusables/codespaces/usage-report-download.md +++ b/data/reusables/codespaces/usage-report-download.md @@ -2,7 +2,7 @@ ![Screenshot of the "Billing and plans" settings. A button, labeled "Get usage report", is highlighted with an orange outline.](/assets/images/help/billing/actions-packages-report-download.png) - The data used for this report is updated daily. + The data used for this report is updated daily. To see the costs for {% data variables.product.prodname_github_codespaces %} compute usage and storage, filter the report to show only rows that mention "Codespaces" in the `Product` column. diff --git a/data/reusables/command-palette/open-palette.md b/data/reusables/command-palette/open-palette.md index 46636e2c2537..a57c1deaf57c 100644 --- a/data/reusables/command-palette/open-palette.md +++ b/data/reusables/command-palette/open-palette.md @@ -1 +1 @@ -1. Use Ctrl+K (Windows/Linux) or Command+K (Mac) to open the command palette with a scope determined by your current location in the UI. +1. Use Ctrl+K (Windows/Linux) or Command+K (Mac) to open the command palette with a scope determined by your current location in the UI. diff --git a/data/reusables/command_line/start_ssh_agent.md b/data/reusables/command_line/start_ssh_agent.md index e118fa0763ef..614d113707eb 100644 --- a/data/reusables/command_line/start_ssh_agent.md +++ b/data/reusables/command_line/start_ssh_agent.md @@ -1,4 +1,4 @@ -1. Start the ssh-agent in the background. +1. Start the ssh-agent in the background. ```shell $ eval "$(ssh-agent -s)" diff --git a/data/reusables/copilot/differences-cfi-cfb-table.md b/data/reusables/copilot/differences-cfi-cfb-table.md index acc978fe06e8..bf56262715a7 100644 --- a/data/reusables/copilot/differences-cfi-cfb-table.md +++ b/data/reusables/copilot/differences-cfi-cfb-table.md @@ -13,4 +13,4 @@ {% endrowheaders %} -For more information about VPN Proxy support via self-signed certificates, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment?tool=vscode#configuring-proxy-settings-for-github-copilot-1)". +For more information about VPN Proxy support via self-signed certificates, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment?tool=vscode#configuring-proxy-settings-for-github-copilot-1)". diff --git a/data/reusables/copilot/type-function-header.md b/data/reusables/copilot/type-function-header.md index 14f2888ddb1a..c93de4c6565d 100644 --- a/data/reusables/copilot/type-function-header.md +++ b/data/reusables/copilot/type-function-header.md @@ -3,4 +3,3 @@ ```javascript copy function calculateDaysBetweenDates(begin, end) { ``` - \ No newline at end of file diff --git a/data/reusables/dependabot/dependabot-alerts-filters.md b/data/reusables/dependabot/dependabot-alerts-filters.md index 432ed635f601..8d4aef17e9bb 100644 --- a/data/reusables/dependabot/dependabot-alerts-filters.md +++ b/data/reusables/dependabot/dependabot-alerts-filters.md @@ -1,6 +1,6 @@ -You can sort and filter {% data variables.product.prodname_dependabot_alerts %} by typing filters as `key:value` pairs into the search bar. +You can sort and filter {% data variables.product.prodname_dependabot_alerts %} by typing filters as `key:value` pairs into the search bar. -| Option | Description | Example | +| Option | Description | Example | |:---|:---|:---| | `ecosystem` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 or ghae > 3.5 %} | `has` | Displays alerts meeting the selected filter criteria | Use `has:patch` to show alerts related to advisories that have a patch{% ifversion dependabot-alerts-vulnerable-calls %}
Use `has:vulnerable-calls` to show alerts relating to calls to vulnerable functions{% endif %} |{% endif %} diff --git a/data/reusables/dependabot/private-registry-support.md b/data/reusables/dependabot/private-registry-support.md index 6f017941b70c..7eb7182f532a 100644 --- a/data/reusables/dependabot/private-registry-support.md +++ b/data/reusables/dependabot/private-registry-support.md @@ -1 +1 @@ -{% data variables.product.prodname_dependabot %} can access public registries by default, and you can configure {% data variables.product.prodname_dependabot %} to also access private registries. +{% data variables.product.prodname_dependabot %} can access public registries by default, and you can configure {% data variables.product.prodname_dependabot %} to also access private registries. diff --git a/data/reusables/dependabot/pull-request-security-vs-version-updates.md b/data/reusables/dependabot/pull-request-security-vs-version-updates.md index d6f24feff444..a1dee59915e0 100644 --- a/data/reusables/dependabot/pull-request-security-vs-version-updates.md +++ b/data/reusables/dependabot/pull-request-security-vs-version-updates.md @@ -1,4 +1,4 @@ When {% data variables.product.prodname_dependabot %} raises pull requests, these pull requests could be for _security_ or _version_ updates: -- _{% data variables.product.prodname_dependabot_security_updates %}_ are automated pull requests that help you update dependencies with known vulnerabilities. +- _{% data variables.product.prodname_dependabot_security_updates %}_ are automated pull requests that help you update dependencies with known vulnerabilities. - _{% data variables.product.prodname_dependabot_version_updates %}_ are automated pull requests that keep your dependencies updated, even when they don’t have any vulnerabilities. To check the status of version updates, navigate to the Insights tab of your repository, then Dependency Graph, and {% data variables.product.prodname_dependabot %}. diff --git a/data/reusables/dependabot/vulnerable-calls-beta.md b/data/reusables/dependabot/vulnerable-calls-beta.md index c24c892f026d..349f8cf6db58 100644 --- a/data/reusables/dependabot/vulnerable-calls-beta.md +++ b/data/reusables/dependabot/vulnerable-calls-beta.md @@ -2,7 +2,7 @@ {% note %} -**Notes:** +**Notes:** - The detection of calls to vulnerable functions by {% data variables.product.prodname_dependabot %} is in beta and subject to change. diff --git a/data/reusables/dependency-submission/about-dependency-submission.md b/data/reusables/dependency-submission/about-dependency-submission.md index 20dab1d26d10..d77aa84d561b 100644 --- a/data/reusables/dependency-submission/about-dependency-submission.md +++ b/data/reusables/dependency-submission/about-dependency-submission.md @@ -1,5 +1,5 @@ You can use the REST API to submit dependencies for a project. This enables you to add dependencies, such as those resolved when software is compiled or built, to {% data variables.product.prodname_dotcom %}'s dependency graph feature, providing a more complete picture of all of your project's dependencies. -The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a `package-lock.json` file in a JavaScript project). For more information about viewing the dependency graph, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#viewing-the-dependency-graph)." +The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a `package-lock.json` file in a JavaScript project). For more information about viewing the dependency graph, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#viewing-the-dependency-graph)." Submitted dependencies will receive {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} for any known vulnerabilities. You will only get {% data variables.product.prodname_dependabot_alerts %} for dependencies that are from one of the [supported ecosystems](https://github.com/github/advisory-database#supported-ecosystems) of the {% data variables.product.prodname_advisory_database %}. Submitted dependencies will not be surfaced in dependency review or your organization's dependency insights. diff --git a/data/reusables/desktop/authenticate-in-browser.md b/data/reusables/desktop/authenticate-in-browser.md index ad1dfd633459..a8e082487a62 100644 --- a/data/reusables/desktop/authenticate-in-browser.md +++ b/data/reusables/desktop/authenticate-in-browser.md @@ -1,3 +1,3 @@ 1. To authenticate to {% data variables.product.prodname_dotcom %}, in the browser, type your {% data variables.product.prodname_dotcom %}.com credentials and click **Sign in**. - Alternatively, if you were already signed in to {% data variables.product.prodname_dotcom %}, follow the prompts to return to {% data variables.product.prodname_desktop %} to finish authenticating. + Alternatively, if you were already signed in to {% data variables.product.prodname_dotcom %}, follow the prompts to return to {% data variables.product.prodname_desktop %} to finish authenticating. diff --git a/data/reusables/desktop/choose-a-theme.md b/data/reusables/desktop/choose-a-theme.md index 955ce79e0b1d..484a1037f666 100644 --- a/data/reusables/desktop/choose-a-theme.md +++ b/data/reusables/desktop/choose-a-theme.md @@ -1,7 +1,7 @@ 3. Click the **Appearance** pane. {% mac %} - + ![Screenshot of the "Preferences" window. In the left sidebar, the "Appearance" option is highlighted in blue and outlined in orange.](/assets/images/help/desktop/appearance-tab-themes.png) {% endmac %} diff --git a/data/reusables/desktop/fork-type-prompt.md b/data/reusables/desktop/fork-type-prompt.md index da37aba28088..2772b5894932 100644 --- a/data/reusables/desktop/fork-type-prompt.md +++ b/data/reusables/desktop/fork-type-prompt.md @@ -1,4 +1,4 @@ -1. Read the information in the "How are you planning to use this fork?" window. +1. Read the information in the "How are you planning to use this fork?" window. - If you plan to use this fork for contributing to the original upstream repository, click **To contribute to the parent project**. - If you plan to use this fork for a project not connected to the upstream, click **For my own purposes**. 1. Click **Continue**. diff --git a/data/reusables/desktop/history-tab.md b/data/reusables/desktop/history-tab.md index c4e6a88bdc7c..faf55ff09ebf 100644 --- a/data/reusables/desktop/history-tab.md +++ b/data/reusables/desktop/history-tab.md @@ -1,3 +1,3 @@ 1. In the left sidebar, click **History**. - + ![Screenshot of the "History" tab in the sidebar. Above a list of commits, the tab button, labeled "History", is highlighted with an orange outline.](/assets/images/help/desktop/history-tab-in-commit-sidebar.png) diff --git a/data/reusables/desktop/mac-repository-settings-menu.md b/data/reusables/desktop/mac-repository-settings-menu.md index 65a580369139..9d75d1f2cfbe 100644 --- a/data/reusables/desktop/mac-repository-settings-menu.md +++ b/data/reusables/desktop/mac-repository-settings-menu.md @@ -1,3 +1,3 @@ 1. In the "{% data variables.product.prodname_desktop %}" menu bar, select **Repository** and click **Repository Settings...**. - + ![Screenshot of the menu bar on a Mac. In the open "Repository" dropdown menu, a cursor hovers over "Repository Settings", highlighted in blue.](/assets/images/help/desktop/repository-settings-mac.png) diff --git a/data/reusables/desktop/open-repository-settings.md b/data/reusables/desktop/open-repository-settings.md index 85cd7940db4d..351e5d6ce87b 100644 --- a/data/reusables/desktop/open-repository-settings.md +++ b/data/reusables/desktop/open-repository-settings.md @@ -1,14 +1,14 @@ 1. In the menu bar, select **Repository**, then click **Repository settings...**. {% mac %} - + ![Screenshot of the menu bar on a Mac. In the expanded "Repository" dropdown menu, a cursor hovers over "Repository Settings", highlighted in blue.](/assets/images/help/desktop/repository-settings-mac.png) - + {% endmac %} - + {% 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) - + {% endwindows %} \ No newline at end of file diff --git a/data/reusables/desktop/push-origin.md b/data/reusables/desktop/push-origin.md index 5c312ae0eec2..f8ccc338e348 100644 --- a/data/reusables/desktop/push-origin.md +++ b/data/reusables/desktop/push-origin.md @@ -1,3 +1,3 @@ 1. To push your local changes to the remote repository, in the repository bar, click **Push origin**. - + ![Screenshot of the repository bar. A button, labeled "Push origin", is highlighted with an orange outline.](/assets/images/help/desktop/push-to-origin.png) diff --git a/data/reusables/desktop/select-fork-behavior.md b/data/reusables/desktop/select-fork-behavior.md index e2f4b3975a1d..a4a857d9bf3a 100644 --- a/data/reusables/desktop/select-fork-behavior.md +++ b/data/reusables/desktop/select-fork-behavior.md @@ -1,4 +1,4 @@ -1. In the "Repository settings" window, in the left-hand sidebar, click **Fork Behavior**. +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) diff --git a/data/reusables/desktop/windows-choose-options.md b/data/reusables/desktop/windows-choose-options.md index 461668c3d091..f9f693bd1134 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) diff --git a/data/reusables/desktop/windows-repository-settings-menu.md b/data/reusables/desktop/windows-repository-settings-menu.md index 36454db23803..be91a5de4ac8 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) diff --git a/data/reusables/discussions/discussion-category-forms-name.md b/data/reusables/discussions/discussion-category-forms-name.md index e6369e4e8d84..12915adc5861 100644 --- a/data/reusables/discussions/discussion-category-forms-name.md +++ b/data/reusables/discussions/discussion-category-forms-name.md @@ -1 +1 @@ - The name must correspond with the slug for one of your discussion categories. For example, the template for the "Announcements" category should be `.github/DISCUSSION_TEMPLATE/announcements.yml`. + The name must correspond with the slug for one of your discussion categories. For example, the template for the "Announcements" category should be `.github/DISCUSSION_TEMPLATE/announcements.yml`. diff --git a/data/reusables/education/benefits-page.md b/data/reusables/education/benefits-page.md index 64ad26ee324a..3bcb357b982b 100644 --- a/data/reusables/education/benefits-page.md +++ b/data/reusables/education/benefits-page.md @@ -1 +1 @@ -1. Go to [{% data variables.product.prodname_education %}](https://education.github.com) and, in the top navigation bar, click **Benefits**. +1. Go to [{% data variables.product.prodname_education %}](https://education.github.com) and, in the top navigation bar, click **Benefits**. diff --git a/data/reusables/education/note-on-student-codespaces-usage.md b/data/reusables/education/note-on-student-codespaces-usage.md index 114193769fd9..e9b25cca61d1 100644 --- a/data/reusables/education/note-on-student-codespaces-usage.md +++ b/data/reusables/education/note-on-student-codespaces-usage.md @@ -1 +1 @@ -If students use {% data variables.product.prodname_github_codespaces %} in their assignment repositories for {% data variables.product.prodname_classroom %}, the usage will be charged to the organization that owns the classroom, and will not affect the usage for a student's personal account. +If students use {% data variables.product.prodname_github_codespaces %} in their assignment repositories for {% data variables.product.prodname_classroom %}, the usage will be charged to the organization that owns the classroom, and will not affect the usage for a student's personal account. diff --git a/data/reusables/enterprise-accounts/emu-azure-admin-consent.md b/data/reusables/enterprise-accounts/emu-azure-admin-consent.md index 1b68756a7d2e..3faeac412e0c 100644 --- a/data/reusables/enterprise-accounts/emu-azure-admin-consent.md +++ b/data/reusables/enterprise-accounts/emu-azure-admin-consent.md @@ -1,4 +1,4 @@ -1. After {% data variables.product.product_name %} redirects you to your IdP, sign in, then follow the instructions to give consent and install the {% data variables.product.prodname_emu_idp_oidc_application %} application. After Azure AD asks for permissions for {% data variables.product.company_short %} {% data variables.product.prodname_emus %} with OIDC, enable **Consent on behalf of your organization**, then click **Accept**. +1. After {% data variables.product.product_name %} redirects you to your IdP, sign in, then follow the instructions to give consent and install the {% data variables.product.prodname_emu_idp_oidc_application %} application. After Azure AD asks for permissions for {% data variables.product.company_short %} {% data variables.product.prodname_emus %} with OIDC, enable **Consent on behalf of your organization**, then click **Accept**. {% warning %} **Warning:** You must sign in to Azure AD as a user with global admin rights in order to consent to the installation of the {% data variables.product.prodname_emu_idp_oidc_application %} application. diff --git a/data/reusables/enterprise-migration-tool/check-migration.md b/data/reusables/enterprise-migration-tool/check-migration.md index 92f8a9457b03..e9e9ff4347c1 100644 --- a/data/reusables/enterprise-migration-tool/check-migration.md +++ b/data/reusables/enterprise-migration-tool/check-migration.md @@ -22,6 +22,6 @@ query ( } ``` -| Query variable | Description | +| Query variable | Description | |----|----| | `id` | The `id` of your migration that [the `startRepositoryMigration` mutation](#step-4-start-your-repository-migration) returned. | diff --git a/data/reusables/enterprise-migration-tool/edit-csv.md b/data/reusables/enterprise-migration-tool/edit-csv.md index cf87fccaa9ff..e0512ebb502c 100644 --- a/data/reusables/enterprise-migration-tool/edit-csv.md +++ b/data/reusables/enterprise-migration-tool/edit-csv.md @@ -1,2 +1,2 @@ -- Edit the CSV file, adding the username of the organization member that corresponds to each mannequin. +- Edit the CSV file, adding the username of the organization member that corresponds to each mannequin. - Save the file. diff --git a/data/reusables/enterprise-migration-tool/migration-destination-query.md b/data/reusables/enterprise-migration-tool/migration-destination-query.md index 7e504b6fbeea..b69b48047dde 100644 --- a/data/reusables/enterprise-migration-tool/migration-destination-query.md +++ b/data/reusables/enterprise-migration-tool/migration-destination-query.md @@ -14,7 +14,7 @@ query( } ``` -| Query variable | Description | +| Query variable | Description | |----|----| | `login` | Your organization name. diff --git a/data/reusables/enterprise-migration-tool/reclaim-individual-mannequin.md b/data/reusables/enterprise-migration-tool/reclaim-individual-mannequin.md index d8318f35aa32..7b5c38759c64 100644 --- a/data/reusables/enterprise-migration-tool/reclaim-individual-mannequin.md +++ b/data/reusables/enterprise-migration-tool/reclaim-individual-mannequin.md @@ -1,3 +1,3 @@ - To reclaim an individual mannequin, replace DESTINATION with the destination organization, MANNEQUIN with the login of mannequin, and USERNAME with the username of the organization member that corresponds to the mannequin. - If there are multiple mannequins with the same login, you can replace `--mannequin-user MANNEQUIN` with `--mannequin-ID ID`, replacing ID with the ID of the mannequin. + If there are multiple mannequins with the same login, you can replace `--mannequin-user MANNEQUIN` with `--mannequin-ID ID`, replacing ID with the ID of the mannequin. diff --git a/data/reusables/enterprise-migration-tool/running-your-migrations.md b/data/reusables/enterprise-migration-tool/running-your-migrations.md index 85475065b8e0..326d8df3a9d0 100644 --- a/data/reusables/enterprise-migration-tool/running-your-migrations.md +++ b/data/reusables/enterprise-migration-tool/running-your-migrations.md @@ -6,4 +6,4 @@ Trial migrations help you determine several critical pieces of information. - Whether you can get the repository back to a state where your users can successfully start working - How long a migration will take to run, which is useful for planning migration schedules and setting stakeholder expectations -Trial runs do not require much time coordination. {% data variables.product.prodname_importer_proper_name %} never requires downtime for users of a repository being migrated. However, we recommend halting work during production migrations to ensure that new data isn't created during the migration, which would then be missing from the migrated repository. This isn't a concern for trial migrations, so trial runs can take place at any time. To reduce the time it takes to complete your trial migrations, you can schedule the batches for your trial runs back-to-back. Users of those repositories can then validate the results on their own time. +Trial runs do not require much time coordination. {% data variables.product.prodname_importer_proper_name %} never requires downtime for users of a repository being migrated. However, we recommend halting work during production migrations to ensure that new data isn't created during the migration, which would then be missing from the migrated repository. This isn't a concern for trial migrations, so trial runs can take place at any time. To reduce the time it takes to complete your trial migrations, you can schedule the batches for your trial runs back-to-back. Users of those repositories can then validate the results on their own time. diff --git a/data/reusables/enterprise-migration-tool/skip-releases.md b/data/reusables/enterprise-migration-tool/skip-releases.md index 1274d5010aba..9b4dce18e49f 100644 --- a/data/reusables/enterprise-migration-tool/skip-releases.md +++ b/data/reusables/enterprise-migration-tool/skip-releases.md @@ -2,4 +2,4 @@ **Note:** If your repository has more than 10 GB of releases data, releases cannot be migrated. Use the `--skip-releases` flag to migrate the repository without releases. -{% endnote %} +{% endnote %} diff --git a/data/reusables/enterprise-migration-tool/ssl-flag.md b/data/reusables/enterprise-migration-tool/ssl-flag.md index 4254c34bad74..68e35c8e0137 100644 --- a/data/reusables/enterprise-migration-tool/ssl-flag.md +++ b/data/reusables/enterprise-migration-tool/ssl-flag.md @@ -1 +1 @@ -If {% data variables.location.product_location_enterprise %} uses a self-signed or invalid SSL certificate, use the `--no-ssl-verify` flag. With this flag, the {% data variables.product.prodname_cli %} will skip verifying the SSL certificate when extracting data from your instance only. All other calls will verify SSL. +If {% data variables.location.product_location_enterprise %} uses a self-signed or invalid SSL certificate, use the `--no-ssl-verify` flag. With this flag, the {% data variables.product.prodname_cli %} will skip verifying the SSL certificate when extracting data from your instance only. All other calls will verify SSL. diff --git a/data/reusables/enterprise-migration-tool/timeline-tasks.md b/data/reusables/enterprise-migration-tool/timeline-tasks.md index 4404532b56ff..b6da82935999 100644 --- a/data/reusables/enterprise-migration-tool/timeline-tasks.md +++ b/data/reusables/enterprise-migration-tool/timeline-tasks.md @@ -1,4 +1,4 @@ -After you use the analyzer, you can weigh your inventory data against your desired timeline. If your organization can withstand a higher degree of change, then you might be able to migrate all your repositories at once, completing your migration efforts in a few days. However, you may have various teams that are not able to migrate at the same time. In this case, you might want to batch and stagger your migrations to fit the teams' timelines, extending your migration effort. +After you use the analyzer, you can weigh your inventory data against your desired timeline. If your organization can withstand a higher degree of change, then you might be able to migrate all your repositories at once, completing your migration efforts in a few days. However, you may have various teams that are not able to migrate at the same time. In this case, you might want to batch and stagger your migrations to fit the teams' timelines, extending your migration effort. 1. Use the [{% data variables.product.company_short %} Migration Analyzer](https://github.com/github/gh-migration-analyzer), then review your migration inventory. 1. To understand when teams can be ready to migrate, interview stakeholders. diff --git a/data/reusables/enterprise/apply-configuration.md b/data/reusables/enterprise/apply-configuration.md index 7a181be5270c..91fb45f3641b 100644 --- a/data/reusables/enterprise/apply-configuration.md +++ b/data/reusables/enterprise/apply-configuration.md @@ -1,7 +1,7 @@ 1. To apply the configuration, run the following command. {% note %} - + **Note**: During a configuration run, services on {% data variables.location.product_location %} may restart, which can cause brief downtime for users. {% endnote %} diff --git a/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md b/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md index f8a768498b61..35872826aac7 100644 --- a/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md +++ b/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md @@ -3,5 +3,5 @@ ```bash copy gpg --full-generate-key --pinentry-mode=loopback ``` - - - Use the default key type and at least `4096` bits with no expiry. + + - Use the default key type and at least `4096` bits with no expiry. diff --git a/data/reusables/enterprise_user_management/SAML-to-OIDC-migration-for-EMU.md b/data/reusables/enterprise_user_management/SAML-to-OIDC-migration-for-EMU.md index 0202df45a51c..f20fbad50491 100644 --- a/data/reusables/enterprise_user_management/SAML-to-OIDC-migration-for-EMU.md +++ b/data/reusables/enterprise_user_management/SAML-to-OIDC-migration-for-EMU.md @@ -1 +1 @@ -If you currently use SAML SSO for authentication and would prefer to use OIDC and benefit from CAP support, you can follow a migration path. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)." +If you currently use SAML SSO for authentication and would prefer to use OIDC and benefit from CAP support, you can follow a migration path. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)." diff --git a/data/reusables/files/add-file.md b/data/reusables/files/add-file.md index ebfa546ee4fb..1fc0076be2ee 100644 --- a/data/reusables/files/add-file.md +++ b/data/reusables/files/add-file.md @@ -1,6 +1,6 @@ {% ifversion code-search-code-view %} 1. Above the list of files, select the **Add file** {% octicon "triangle-down" aria-label="The downwards-facing triangle icon" %} dropdown menu, then click {% octicon "plus" aria-label="The plus sign icon" %} **Create new file**. - + Alternatively, you can click {% octicon "plus" aria-label="The plus sign icon" %} in the file tree view on the left. ![Screenshot of the main page of the repository. Above the list of a files, a button, labeled "Add file," is outlined in dark orange. In the file tree view of the repository, a button, with the plus sign icon, is also outlined in dark orange. ](/assets/images/help/repository/add-files-buttons.png) diff --git a/data/reusables/gated-features/codeql.md b/data/reusables/gated-features/codeql.md index 39de012e511b..5c920b8b35c4 100644 --- a/data/reusables/gated-features/codeql.md +++ b/data/reusables/gated-features/codeql.md @@ -1,3 +1,3 @@ GitHub {% data variables.product.prodname_codeql %} is licensed on a per-user basis upon installation. You can use {% data variables.product.prodname_codeql %} only for certain tasks under the license restrictions. For more information, see "[AUTOTITLE](/code-security/codeql-cli/using-the-codeql-cli/about-the-codeql-cli#about-the-github-codeql-license)." - + If you have a GitHub Advanced Security license, you can use {% data variables.product.prodname_codeql %} for automated analysis, continuous integration, and continuous delivery. {% data reusables.advanced-security.more-info-ghas %} diff --git a/data/reusables/gated-features/dependabot-alerts.md b/data/reusables/gated-features/dependabot-alerts.md index eb2f3ce4d22a..acaafe1910fb 100644 --- a/data/reusables/gated-features/dependabot-alerts.md +++ b/data/reusables/gated-features/dependabot-alerts.md @@ -1,10 +1,10 @@ -{%- ifversion fpt or ghec %} +{%- ifversion fpt or ghec %} {% data variables.product.prodname_dependabot_alerts %} are free to use for all repositories on {% data variables.product.prodname_dotcom_the_website %}. -{%- elsif ghes %} -{% data variables.product.prodname_dependabot_alerts %} are free to use for repositories (user-owned and organization-owned) on {% data variables.product.prodname_ghe_server %}, provided enterprise administrators enable the feature for your enterprise. +{%- elsif ghes %} +{% data variables.product.prodname_dependabot_alerts %} are free to use for repositories (user-owned and organization-owned) on {% data variables.product.prodname_ghe_server %}, provided enterprise administrators enable the feature for your enterprise. -{%- elsif ghae %} -{% data variables.product.prodname_dependabot_alerts %} are free to use for repositories (user-owned and organization-owned) on {% data variables.product.prodname_ghe_managed %}. +{%- elsif ghae %} +{% data variables.product.prodname_dependabot_alerts %} are free to use for repositories (user-owned and organization-owned) on {% data variables.product.prodname_ghe_managed %}. {% endif %} diff --git a/data/reusables/gated-features/dependabot-security-updates.md b/data/reusables/gated-features/dependabot-security-updates.md index 4ec04a08fcd9..4f8c47cf4dc5 100644 --- a/data/reusables/gated-features/dependabot-security-updates.md +++ b/data/reusables/gated-features/dependabot-security-updates.md @@ -1,7 +1,7 @@ -{%- ifversion fpt or ghec %} +{%- ifversion fpt or ghec %} {% data variables.product.prodname_dependabot_security_updates %} are free to use for all repositories on {% data variables.product.prodname_dotcom_the_website %}. -{%- else %} -{% data variables.product.prodname_dependabot_security_updates %} are free to use for repositories (user-owned and organization-owned) on {% data variables.product.prodname_ghe_server %}, provided enterprise administrators enable the feature for your enterprise. +{%- else %} +{% data variables.product.prodname_dependabot_security_updates %} are free to use for repositories (user-owned and organization-owned) on {% data variables.product.prodname_ghe_server %}, provided enterprise administrators enable the feature for your enterprise. {% endif %} diff --git a/data/reusables/gated-features/dependabot-version-updates.md b/data/reusables/gated-features/dependabot-version-updates.md index 2347cd0c93cd..bc8e28ebc36b 100644 --- a/data/reusables/gated-features/dependabot-version-updates.md +++ b/data/reusables/gated-features/dependabot-version-updates.md @@ -1,7 +1,7 @@ -{%- ifversion fpt or ghec %} +{%- ifversion fpt or ghec %} {% data variables.product.prodname_dependabot_version_updates %} are free to use for all repositories on {% data variables.product.prodname_dotcom_the_website %}. -{%- else %} -{% data variables.product.prodname_dependabot_version_updates %} are free to use for repositories (user-owned and organization-owned) on {% data variables.product.prodname_ghe_server %}, provided enterprise administrators enable the feature for your enterprise. +{%- else %} +{% data variables.product.prodname_dependabot_version_updates %} are free to use for repositories (user-owned and organization-owned) on {% data variables.product.prodname_ghe_server %}, provided enterprise administrators enable the feature for your enterprise. {% endif %} diff --git a/data/reusables/gated-features/enterprise_account_webhooks.md b/data/reusables/gated-features/enterprise_account_webhooks.md index dd2c250e1736..add5e44665a8 100644 --- a/data/reusables/gated-features/enterprise_account_webhooks.md +++ b/data/reusables/gated-features/enterprise_account_webhooks.md @@ -1,4 +1,4 @@ -{% data reusables.gated-features.enterprise-accounts %} +{% data reusables.gated-features.enterprise-accounts %} Webhooks configured on enterprise accounts or organizations that are part of an enterprise account will include an `enterprise` account object. diff --git a/data/reusables/gated-features/packages.md b/data/reusables/gated-features/packages.md index 92ebf1fdb4ea..e829c365df66 100644 --- a/data/reusables/gated-features/packages.md +++ b/data/reusables/gated-features/packages.md @@ -1,6 +1,6 @@ -{% ifversion fpt or ghec or ghes < 3.5 %} +{% ifversion fpt or ghec or ghes < 3.5 %} {% data variables.product.prodname_registry %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} 3.0 or higher, and {% data variables.product.prodname_ghe_managed %}.{% ifversion ghes %} For more information about upgrading your {% data variables.product.prodname_ghe_server %} instance, see "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)" and refer to the [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) to find the upgrade path from your current release version.{% endif %} -{% ifversion fpt or ghec %} +{% ifversion fpt or ghec %}
{% data variables.product.prodname_registry %} is not available for private repositories owned by accounts using legacy per-repository plans. Also, accounts using legacy per-repository plans cannot access registries that support granular permissions, because these accounts are billed by repository. For the list of registries that support granular permissions, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." {% data reusables.gated-features.more-info %} {% endif %} {% endif %} diff --git a/data/reusables/gpg/list-keys-with-note.md b/data/reusables/gpg/list-keys-with-note.md index cc78cf41f5f9..5a168a6f7d80 100644 --- a/data/reusables/gpg/list-keys-with-note.md +++ b/data/reusables/gpg/list-keys-with-note.md @@ -3,7 +3,7 @@ ```shell copy $ gpg --list-secret-keys --keyid-format=long ``` - + {% note %} **Note:** Some GPG installations on Linux may require you to use `gpg2 --list-keys --keyid-format LONG` to view a list of your existing keys instead. In this case you will also need to configure Git to use `gpg2` by running `git config --global gpg.program gpg2`. diff --git a/data/reusables/gpg/paste-gpg-key-id.md b/data/reusables/gpg/paste-gpg-key-id.md index d75e15cb2edc..f493ac1bd140 100644 --- a/data/reusables/gpg/paste-gpg-key-id.md +++ b/data/reusables/gpg/paste-gpg-key-id.md @@ -2,7 +2,7 @@ ```shell $ git config --global user.signingkey 3AA5C34371567BD2 ``` - + Alternatively, when setting a subkey include the `!` suffix. In this example, the GPG subkey ID is `4BB6D45482678BE3`: ```shell $ git config --global user.signingkey 4BB6D45482678BE3! diff --git a/data/reusables/gpg/set-auto-sign.md b/data/reusables/gpg/set-auto-sign.md index eeca146d4216..d8805824eac3 100644 --- a/data/reusables/gpg/set-auto-sign.md +++ b/data/reusables/gpg/set-auto-sign.md @@ -3,5 +3,5 @@ ```Shell $ git config --global commit.gpgsign true ``` - + For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-commits)." diff --git a/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md b/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md index 0688ad153794..a70546ced071 100644 --- a/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md +++ b/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md @@ -1,3 +1,3 @@ -You can edit an entry in your IP allow list. If you edit an enabled entry, changes are enforced immediately. +You can edit an entry in your IP allow list. If you edit an enabled entry, changes are enforced immediately. After you finish editing entries, you can check whether your allow list will permit a connection from a particular IP address after you enable the list. diff --git a/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md b/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md index 8cd2ac303eae..79039cec9da3 100644 --- a/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md +++ b/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md @@ -3,7 +3,7 @@ After you create an IP allow list, you can enable allowed IP addresses. When you {% ifversion ghec %} {% note %} -**Note:** +**Note:** After you enable an IP allow list for your organization you won't be able to use {% data variables.product.prodname_github_codespaces %} for repositories owned by the organization. diff --git a/data/reusables/identity-and-permissions/ip-allow-lists-enterprise.md b/data/reusables/identity-and-permissions/ip-allow-lists-enterprise.md index f6e74073b3b1..107cabfbea58 100644 --- a/data/reusables/identity-and-permissions/ip-allow-lists-enterprise.md +++ b/data/reusables/identity-and-permissions/ip-allow-lists-enterprise.md @@ -1,4 +1,4 @@ -When you enable the allow list, the IP addresses you have configured are immediately added to the allow lists of organizations in your enterprise. If you disable the allow list, the addresses are removed from the organization allow lists. +When you enable the allow list, the IP addresses you have configured are immediately added to the allow lists of organizations in your enterprise. If you disable the allow list, the addresses are removed from the organization allow lists. {% data reusables.identity-and-permissions.org-enterprise-allow-list-interaction %} For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)." diff --git a/data/reusables/identity-and-permissions/org-enterprise-allow-list-interaction.md b/data/reusables/identity-and-permissions/org-enterprise-allow-list-interaction.md index 35b2b25a802f..405c2d69cef9 100644 --- a/data/reusables/identity-and-permissions/org-enterprise-allow-list-interaction.md +++ b/data/reusables/identity-and-permissions/org-enterprise-allow-list-interaction.md @@ -1 +1 @@ -Organization owners can add additional entries to the allow list for their organizations, but they cannot manage entries that are inherited from the enterprise account's allow list, and enterprise owners cannot manage entries added to the organization's allow list. +Organization owners can add additional entries to the allow list for their organizations, but they cannot manage entries that are inherited from the enterprise account's allow list, and enterprise owners cannot manage entries added to the organization's allow list. diff --git a/data/reusables/identity-and-permissions/vigilant-mode-verification-statuses.md b/data/reusables/identity-and-permissions/vigilant-mode-verification-statuses.md index f8377c67cb3b..2aab2a63ff0d 100644 --- a/data/reusables/identity-and-permissions/vigilant-mode-verification-statuses.md +++ b/data/reusables/identity-and-permissions/vigilant-mode-verification-statuses.md @@ -1,5 +1,5 @@ | Status | Description | | -------------- | ----------- | -| **Verified** | The commit is signed, the signature was successfully verified, and the committer is the only author who has enabled vigilant mode. +| **Verified** | The commit is signed, the signature was successfully verified, and the committer is the only author who has enabled vigilant mode. | **Partially verified** | The commit is signed, and the signature was successfully verified, but the commit has an author who: a) is not the committer and b) has enabled vigilant mode. In this case, the commit signature doesn't guarantee the consent of the author, so the commit is only partially verified. | **Unverified** | Any of the following is true:
- The commit is signed but the signature could not be verified.
- The commit is not signed and the committer has enabled vigilant mode.
- The commit is not signed and an author has enabled vigilant mode.
diff --git a/data/reusables/issue-events/label-properties.md b/data/reusables/issue-events/label-properties.md index 41ce4b54e0b2..fc193a7fa215 100644 --- a/data/reusables/issue-events/label-properties.md +++ b/data/reusables/issue-events/label-properties.md @@ -1,3 +1,3 @@ `label` | `object` | The label removed from the issue `label[name]` | `string` | The name of the label. -`label[color]` | `string` | The hex color code. +`label[color]` | `string` | The hex color code. diff --git a/data/reusables/issue-events/review-request-properties.md b/data/reusables/issue-events/review-request-properties.md index 22a66d767320..05247273ba0e 100644 --- a/data/reusables/issue-events/review-request-properties.md +++ b/data/reusables/issue-events/review-request-properties.md @@ -1,2 +1,2 @@ -`requested_reviewer` | `object` | The person requested to review the pull request. +`requested_reviewer` | `object` | The person requested to review the pull request. `review_requester` | `object` | The person who requested a review. diff --git a/data/reusables/notifications-v2/email-notification-caveats.md b/data/reusables/notifications-v2/email-notification-caveats.md index e05d5e23908a..0b414499d227 100644 --- a/data/reusables/notifications-v2/email-notification-caveats.md +++ b/data/reusables/notifications-v2/email-notification-caveats.md @@ -1,4 +1,4 @@ -You'll only receive notification emails if you've chosen to receive email notifications in your notification settings. +You'll only receive notification emails if you've chosen to receive email notifications in your notification settings. {% ifversion fpt or ghec %} {% data reusables.user-settings.verify-org-approved-email-domain %} diff --git a/data/reusables/organizations/about-organizations.md b/data/reusables/organizations/about-organizations.md index 41fe3eebc8ed..0dbdfd0de405 100644 --- a/data/reusables/organizations/about-organizations.md +++ b/data/reusables/organizations/about-organizations.md @@ -1,3 +1,3 @@ -Your team can collaborate on {% data variables.product.product_name %} by using an organization account, which serves as a container for your shared work and gives the work a unique name and brand. +Your team can collaborate on {% data variables.product.product_name %} by using an organization account, which serves as a container for your shared work and gives the work a unique name and brand. Each person that uses {% data variables.product.prodname_dotcom %} always signs into a personal account, and multiple personal accounts can collaborate on shared projects by joining the same organization account. A subset of these personal accounts can be given the role of organization owner, which allows those people to granularly manage access to the organization's resources using sophisticated security and administrative features. diff --git a/data/reusables/organizations/team-discussions-migration.md b/data/reusables/organizations/team-discussions-migration.md index e1de24ddbab1..aaec4b5c7dfc 100644 --- a/data/reusables/organizations/team-discussions-migration.md +++ b/data/reusables/organizations/team-discussions-migration.md @@ -1,7 +1,7 @@ {% note %} -**Note**: Team discussions will be deprecated in {% data variables.product.prodname_ghe_server %} 3.12 in favor of {% data variables.product.prodname_discussions %}. You can transfer your existing team discussions to a repository's discussions by using a migration tool that allows team admins to migrate both public and private team discussions. Click the "Transfer" button in the banner at the top of your team discussions page, then choose the repository in your organization that you want to migrate the discussions to. +**Note**: Team discussions will be deprecated in {% data variables.product.prodname_ghe_server %} 3.12 in favor of {% data variables.product.prodname_discussions %}. You can transfer your existing team discussions to a repository's discussions by using a migration tool that allows team admins to migrate both public and private team discussions. Click the "Transfer" button in the banner at the top of your team discussions page, then choose the repository in your organization that you want to migrate the discussions to. For more information about {% data variables.product.prodname_discussions %}, see "[AUTOTITLE](/discussions)." diff --git a/data/reusables/package_registry/about-graphql-support.md b/data/reusables/package_registry/about-graphql-support.md index c308640b3e30..6bf5d23d942c 100644 --- a/data/reusables/package_registry/about-graphql-support.md +++ b/data/reusables/package_registry/about-graphql-support.md @@ -1,3 +1,3 @@ -{% ifversion packages-registries-v2 %}For certain registries, you{% else %}You{% endif %} can use GraphQL to delete a version of a private package. +{% ifversion packages-registries-v2 %}For certain registries, you{% else %}You{% endif %} can use GraphQL to delete a version of a private package. {% data reusables.package_registry.no-graphql-to-delete-packages %} diff --git a/data/reusables/package_registry/authenticate-to-container-registry-steps.md b/data/reusables/package_registry/authenticate-to-container-registry-steps.md index 3c45ccd98f5c..1228b843f862 100644 --- a/data/reusables/package_registry/authenticate-to-container-registry-steps.md +++ b/data/reusables/package_registry/authenticate-to-container-registry-steps.md @@ -3,7 +3,7 @@ 1. Create a new {% data variables.product.pat_v1 %} with the appropriate scopes for the tasks you want to accomplish. If your organization requires SSO, you must enable SSO for your new token. {% warning %} - **Note:** By default, when you select the `write:packages` scope for your {% data variables.product.pat_v1 %} in the user interface, the `repo` scope will also be selected. The `repo` scope offers unnecessary and broad access, which we recommend you avoid using for {% data variables.product.prodname_actions %} workflows in particular. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#considering-cross-repository-access)." As a workaround, you can select just the `write:packages` scope for your {% data variables.product.pat_v1 %} in the user interface with this url: `https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/settings/tokens/new?scopes=write:packages`. + **Note:** By default, when you select the `write:packages` scope for your {% data variables.product.pat_v1 %} in the user interface, the `repo` scope will also be selected. The `repo` scope offers unnecessary and broad access, which we recommend you avoid using for {% data variables.product.prodname_actions %} workflows in particular. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#considering-cross-repository-access)." As a workaround, you can select just the `write:packages` scope for your {% data variables.product.pat_v1 %} in the user interface with this url: `https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/settings/tokens/new?scopes=write:packages`. {% endwarning %} diff --git a/data/reusables/package_registry/container-registry-ghes-beta.md b/data/reusables/package_registry/container-registry-ghes-beta.md index e2f581abb029..4848eb1c169c 100644 --- a/data/reusables/package_registry/container-registry-ghes-beta.md +++ b/data/reusables/package_registry/container-registry-ghes-beta.md @@ -2,7 +2,7 @@ {% note %} -**Note**: {% data variables.product.prodname_container_registry %} is currently in beta for {% data variables.product.product_name %} and subject to change. +**Note**: {% data variables.product.prodname_container_registry %} is currently in beta for {% data variables.product.product_name %} and subject to change. Both {% data variables.product.prodname_registry %} and subdomain isolation must be enabled to use {% data variables.product.prodname_container_registry %}. For more information, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." diff --git a/data/reusables/pages/about-private-publishing.md b/data/reusables/pages/about-private-publishing.md index fc8ad581ab64..eee4addbe8c9 100644 --- a/data/reusables/pages/about-private-publishing.md +++ b/data/reusables/pages/about-private-publishing.md @@ -1,5 +1,5 @@ {% ifversion fpt %} You can create {% data variables.product.prodname_pages %} sites that are publicly available on the internet. Organizations that use {% data variables.product.prodname_ghe_cloud %} can also publish sites privately by managing access control for the site. {% elsif ghec %} -Unless your enterprise uses {% data variables.product.prodname_emus %}, you can choose to publish project sites publicly or privately by managing access control for the site. +Unless your enterprise uses {% data variables.product.prodname_emus %}, you can choose to publish project sites publicly or privately by managing access control for the site. {% endif %} diff --git a/data/reusables/pages/admin-must-push.md b/data/reusables/pages/admin-must-push.md index acdc14eab157..3606a1508822 100644 --- a/data/reusables/pages/admin-must-push.md +++ b/data/reusables/pages/admin-must-push.md @@ -1,6 +1,6 @@ {% note %} -**Notes**: +**Notes**: - {% ifversion pages-custom-workflow %}If you are publishing from a branch and{% else %}If{% endif %} your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source. diff --git a/data/reusables/profile/navigating-to-profile.md b/data/reusables/profile/navigating-to-profile.md index a23e25a22961..1ce37ccde46d 100644 --- a/data/reusables/profile/navigating-to-profile.md +++ b/data/reusables/profile/navigating-to-profile.md @@ -1 +1 @@ -1. In the upper-right corner of any {% data variables.product.product_name %} page, click your profile photo, then click **Your profile**. +1. In the upper-right corner of any {% data variables.product.product_name %} page, click your profile photo, then click **Your profile**. diff --git a/data/reusables/projects/about-board-layout.md b/data/reusables/projects/about-board-layout.md index ca8efdf7e5c2..1033edc03fe5 100644 --- a/data/reusables/projects/about-board-layout.md +++ b/data/reusables/projects/about-board-layout.md @@ -1,3 +1,3 @@ -The board layout spreads your issues, pull requests, and draft issues across customizable columns. You can create a kanban board by setting your column field to a "Status" field or set any other single select or iteration field as the column field. +The board layout spreads your issues, pull requests, and draft issues across customizable columns. You can create a kanban board by setting your column field to a "Status" field or set any other single select or iteration field as the column field. You can drag {% ifversion projects-v2-board-drag-multiple %}individual or multiple items{% else %}items{% endif %} from column to column and the value of {% ifversion projects-v2-board-drag-multiple %}those items{% else %}the item{% endif %} will adjust to match the column you drag them to. diff --git a/data/reusables/projects/about-table-layout.md b/data/reusables/projects/about-table-layout.md index c6053b9fbd23..80144b87c6e4 100644 --- a/data/reusables/projects/about-table-layout.md +++ b/data/reusables/projects/about-table-layout.md @@ -1 +1 @@ -The table layout is a powerful and adaptable spreadsheet comprised of your issues, pull requests, and draft issues with metadata from {% data variables.product.company_short %} and the custom fields you've added to your project. You can group, sort, and filter items, and show or hide fields in your table layouts to suit the needs of everyone on your team. +The table layout is a powerful and adaptable spreadsheet comprised of your issues, pull requests, and draft issues with metadata from {% data variables.product.company_short %} and the custom fields you've added to your project. You can group, sort, and filter items, and show or hide fields in your table layouts to suit the needs of everyone on your team. diff --git a/data/reusables/projects/create-issue-modal.md b/data/reusables/projects/create-issue-modal.md index b04207691c29..8aa27c381327 100644 --- a/data/reusables/projects/create-issue-modal.md +++ b/data/reusables/projects/create-issue-modal.md @@ -10,9 +10,9 @@ 1. Below the repository dropdown, type a title for the new issue. -1. Optionally, use the fields below the title field to set assignees, labels, and milestones, and add the new issue to other projects. +1. Optionally, use the fields below the title field to set assignees, labels, and milestones, and add the new issue to other projects. -1. Optionally, type a description for your issue. +1. Optionally, type a description for your issue. 1. Optionally, if you want to create more issues, select **Create more** and the dialog will reopen when you create your issue. diff --git a/data/reusables/projects/enable-basic-workflow.md b/data/reusables/projects/enable-basic-workflow.md index 5ce56a93eece..4b7fc7260b22 100644 --- a/data/reusables/projects/enable-basic-workflow.md +++ b/data/reusables/projects/enable-basic-workflow.md @@ -3,9 +3,9 @@ {% data reusables.projects.access-workflows %} 1. Under "Default workflows", click on the workflow that you want to edit. 1. In the top right, click **Edit**. - + ![Screenshot showing a project's menu bar. The "Edit" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/workflow-start-editing.png) - + 1. Select whether the workflow should apply to issues, pull requests, or both. 1. Under "Set value", choose the value that you want to set the status to. 1. To save your changes and enable the workflow, click **Save and turn on workflow**. @@ -16,6 +16,6 @@ 1. Under "Default workflows", click on the workflow that you want to edit. 1. Select whether the workflow should apply to issues, pull requests, or both. 1. Next to "Set", choose the value that you want to set the status to. -1. If the workflow is disabled, click the toggle next to "Off" to enable the workflow. +1. If the workflow is disabled, click the toggle next to "Off" to enable the workflow. {% endif %} diff --git a/data/reusables/projects/graphql-ghes.md b/data/reusables/projects/graphql-ghes.md index 22132731cae1..755024833202 100644 --- a/data/reusables/projects/graphql-ghes.md +++ b/data/reusables/projects/graphql-ghes.md @@ -2,7 +2,7 @@ {% note %} -**Note:** The ProjectsV2 GraphQL API may not be available on {% data variables.location.product_location %}. +**Note:** The ProjectsV2 GraphQL API may not be available on {% data variables.location.product_location %}. {% endnote %} diff --git a/data/reusables/projects/projects-api.md b/data/reusables/projects/projects-api.md index 73d1cf6b4730..898451001af8 100644 --- a/data/reusables/projects/projects-api.md +++ b/data/reusables/projects/projects-api.md @@ -1,7 +1,7 @@ {% ifversion fpt or ghec %} {% note %} -**Notes:** +**Notes:** - These endpoints only interact with {% data variables.product.prodname_projects_v1 %}. To manage {% data variables.product.prodname_projects_v2 %}, use the GraphQL API. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." - To create a new {% data variables.projects.projects_v1_board %}, the organization, user, or repository must already have at least one {% data variables.projects.projects_v1_board %}. diff --git a/data/reusables/pull_requests/rebase_and_merge_verification.md b/data/reusables/pull_requests/rebase_and_merge_verification.md index 21ddcd57ad22..cc5acfedfa7e 100644 --- a/data/reusables/pull_requests/rebase_and_merge_verification.md +++ b/data/reusables/pull_requests/rebase_and_merge_verification.md @@ -1,5 +1,5 @@ -When using the **Rebase and Merge** option on a pull request, it's important to note that the commits in the head branch are added to the base branch without commit signature verification. -When you use this option, {% data variables.product.prodname_dotcom %} creates a modified commit, using the data and content of the original commit. This means that {% data variables.product.prodname_dotcom %} didn't truly create this commit, and can't therefore sign it as a generic system user. +When using the **Rebase and Merge** option on a pull request, it's important to note that the commits in the head branch are added to the base branch without commit signature verification. +When you use this option, {% data variables.product.prodname_dotcom %} creates a modified commit, using the data and content of the original commit. This means that {% data variables.product.prodname_dotcom %} didn't truly create this commit, and can't therefore sign it as a generic system user. {% data variables.product.prodname_dotcom %} doesn't have access to the committer's private signing keys, so it can't sign the commit on the user's behalf. A workaround for this is to rebase and merge locally, and then push the changes to the pull request's base branch. diff --git a/data/reusables/reminders/scheduled-reminders-limitations.md b/data/reusables/reminders/scheduled-reminders-limitations.md index a20bdcdd64ef..40a266984839 100644 --- a/data/reusables/reminders/scheduled-reminders-limitations.md +++ b/data/reusables/reminders/scheduled-reminders-limitations.md @@ -1 +1 @@ -{% data variables.product.product_name %} will only trigger reminders for up to five repositories per owner and 20 pull requests per repository. Reminders are not sent when changes are merged from upstream into a fork. +{% data variables.product.product_name %} will only trigger reminders for up to five repositories per owner and 20 pull requests per repository. Reminders are not sent when changes are merged from upstream into a fork. diff --git a/data/reusables/repositories/create-ruleset-step.md b/data/reusables/repositories/create-ruleset-step.md index 71d93b97b989..81f560e58da0 100644 --- a/data/reusables/repositories/create-ruleset-step.md +++ b/data/reusables/repositories/create-ruleset-step.md @@ -1,5 +1,5 @@ 1. You can create a ruleset targeting branches, or a ruleset targeting tags. - To create a ruleset targeting branches, click **New branch ruleset**. - To create a ruleset targeting tags, select {% octicon "triangle-down" aria-label="Open ruleset creation menu" %}, then click **New tag ruleset**. - + ![Screenshot of the "Rulesets" page. Next to the "New branch ruleset" button, a dropdown menu is expanded, with an option labeled "New tag ruleset" outlined in orange.](/assets/images/help/repository/new-tag-ruleset.png) diff --git a/data/reusables/repositories/fork-definition-long.md b/data/reusables/repositories/fork-definition-long.md index 81d06cffe460..472df8f843d4 100644 --- a/data/reusables/repositories/fork-definition-long.md +++ b/data/reusables/repositories/fork-definition-long.md @@ -1 +1 @@ -A fork is a new repository that shares code and visibility settings with the original “upstream” repository. Forks are often used to iterate on ideas or changes before they are proposed back to the upstream repository, such as in open source projects or when a user does not have write access to the upstream repository. +A fork is a new repository that shares code and visibility settings with the original “upstream” repository. Forks are often used to iterate on ideas or changes before they are proposed back to the upstream repository, such as in open source projects or when a user does not have write access to the upstream repository. diff --git a/data/reusables/repositories/github-security-lab.md b/data/reusables/repositories/github-security-lab.md index d9706940b4e7..517339ccf7a1 100644 --- a/data/reusables/repositories/github-security-lab.md +++ b/data/reusables/repositories/github-security-lab.md @@ -1 +1 @@ -You can also join [{% data variables.product.prodname_security %}]({% data variables.product.prodname_security_link %}) to browse security-related topics and contribute to security tools and projects. +You can also join [{% data variables.product.prodname_security %}]({% data variables.product.prodname_security_link %}) to browse security-related topics and contribute to security tools and projects. diff --git a/data/reusables/repositories/navigate-to-branches.md b/data/reusables/repositories/navigate-to-branches.md index 79e8ecb675b4..6a134ea4e91f 100644 --- a/data/reusables/repositories/navigate-to-branches.md +++ b/data/reusables/repositories/navigate-to-branches.md @@ -1,5 +1,5 @@ {% ifversion code-search-code-view %} -1. From the file tree view on the left, select the {% octicon "git-branch" aria-hidden="true" %} branch dropdown menu, then click **View all branches**. You can also find the branch dropdown menu at the top of the integrated file editor. +1. From the file tree view on the left, select the {% octicon "git-branch" aria-hidden="true" %} branch dropdown menu, then click **View all branches**. You can also find the branch dropdown menu at the top of the integrated file editor. ![Screenshot of the file tree view for a repository. A dropdown menu for branches is expanded and outlined in dark orange.](/assets/images/help/repository/file-tree-view-branch-dropdown-expanded.png) {% else %} diff --git a/data/reusables/repositories/rulesets-metadata-step.md b/data/reusables/repositories/rulesets-metadata-step.md index 67a4cf2657e2..a3e618da42c1 100644 --- a/data/reusables/repositories/rulesets-metadata-step.md +++ b/data/reusables/repositories/rulesets-metadata-step.md @@ -11,7 +11,7 @@ 1. If you're adding a metadata restriction, configure the settings for the metadata restriction rule, then click **Add**. You can add multiple restrictions to the same ruleset. For most requirements, such as "Must start with a matching pattern," the pattern you enter is interpreted literally, and wildcards are not supported. For example, the `*` character only represents the literal `*` character. - - For more complex patterns, you can select "Must match a given regex pattern" or "Must not match a given regex pattern," then use regular expression syntax to define the matching pattern. For more information, see "[Using regular expressions for commit metadata](#using-regular-expressions-for-commit-metadata)." - + + For more complex patterns, you can select "Must match a given regex pattern" or "Must not match a given regex pattern," then use regular expression syntax to define the matching pattern. For more information, see "[Using regular expressions for commit metadata](#using-regular-expressions-for-commit-metadata)." + Anyone who views the rulesets for a repository will be able to see the description you provide. diff --git a/data/reusables/repositories/sidebar-dependabot-alerts.md b/data/reusables/repositories/sidebar-dependabot-alerts.md index 238aebc0e7bb..055b480b5fda 100644 --- a/data/reusables/repositories/sidebar-dependabot-alerts.md +++ b/data/reusables/repositories/sidebar-dependabot-alerts.md @@ -1,4 +1,4 @@ 1. In the "Vulnerability alerts" sidebar of security overview, click **{% data variables.product.prodname_dependabot %}**. If this option is missing, it means you don't have access to security alerts and need to be given access. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."{% ifversion fpt or ghec %} - + ![Screenshot of security overview, with the "Dependabot" tab highlighted with a dark orange outline.](/assets/images/help/repository/dependabot-tab.png){% else %} ![Screenshot of security overview, with the "Dependabot" tab highlighted with a dark orange outline.](/assets/images/enterprise/repository/dependabot-alerts-tab.png){% endif %} diff --git a/data/reusables/saml/authentication-loop.md b/data/reusables/saml/authentication-loop.md index c86ee6311126..14d6a364d13c 100644 --- a/data/reusables/saml/authentication-loop.md +++ b/data/reusables/saml/authentication-loop.md @@ -1,7 +1,7 @@ ## Users are repeatedly redirected to authenticate -If users are repeatedly redirected to the SAML authentication prompt in a loop, you may need to increase the SAML session duration in your IdP settings. +If users are repeatedly redirected to the SAML authentication prompt in a loop, you may need to increase the SAML session duration in your IdP settings. -The `SessionNotOnOrAfter` value sent in a SAML response determines when a user will be redirected back to the IdP to authenticate. If a SAML session duration is configured for 2 hours or less, {% data variables.product.prodname_dotcom_the_website %} will refresh a SAML session 5 minutes before it expires. If your session duration is configured as 5 minutes or less, users can get stuck in a SAML authentication loop. +The `SessionNotOnOrAfter` value sent in a SAML response determines when a user will be redirected back to the IdP to authenticate. If a SAML session duration is configured for 2 hours or less, {% data variables.product.prodname_dotcom_the_website %} will refresh a SAML session 5 minutes before it expires. If your session duration is configured as 5 minutes or less, users can get stuck in a SAML authentication loop. To fix this problem, we recommend configuring a minimum SAML session duration of 4 hours. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference#session-duration-and-timeout)." diff --git a/data/reusables/search/code-view-link.md b/data/reusables/search/code-view-link.md index b5c6c935f534..459c14840ec6 100644 --- a/data/reusables/search/code-view-link.md +++ b/data/reusables/search/code-view-link.md @@ -1 +1 @@ -For more information on the new code view, see "[AUTOTITLE](/repositories/working-with-files/managing-files/navigating-files-with-the-new-code-view)." +For more information on the new code view, see "[AUTOTITLE](/repositories/working-with-files/managing-files/navigating-files-with-the-new-code-view)." diff --git a/data/reusables/secret-scanning/push-protection-command-line-choice.md b/data/reusables/secret-scanning/push-protection-command-line-choice.md index d77ab50d3718..decc96a03c98 100644 --- a/data/reusables/secret-scanning/push-protection-command-line-choice.md +++ b/data/reusables/secret-scanning/push-protection-command-line-choice.md @@ -1 +1 @@ -When you attempt to push a supported secret to a repository or organization with {% data variables.product.prodname_secret_scanning %} as a push protection enabled, {% data variables.product.prodname_dotcom %} will block the push. You can remove the secret from your branch or follow a provided URL to allow the push. +When you attempt to push a supported secret to a repository or organization with {% data variables.product.prodname_secret_scanning %} as a push protection enabled, {% data variables.product.prodname_dotcom %} will block the push. You can remove the secret from your branch or follow a provided URL to allow the push. diff --git a/data/reusables/secret-scanning/push-protection-multiple-branch-note.md b/data/reusables/secret-scanning/push-protection-multiple-branch-note.md index 7c82e41f5760..568f04def8e4 100644 --- a/data/reusables/secret-scanning/push-protection-multiple-branch-note.md +++ b/data/reusables/secret-scanning/push-protection-multiple-branch-note.md @@ -1,6 +1,6 @@ {% note %} -**Notes**: +**Notes**: - If your git configuration supports pushes to multiple branches, and not only to the current branch, your push may be blocked due to additional and unintended refs being pushed. For more information, see the [`push.default` options](https://git-scm.com/docs/git-config#Documentation/git-config.txt-pushdefault) in the Git documentation. - If {% data variables.product.prodname_secret_scanning %} upon a push times out, {% data variables.product.prodname_dotcom %} will still scan your commits for secrets after the push. diff --git a/data/reusables/security-advisory/private-vulnerability-reporting-configure-notifications.md b/data/reusables/security-advisory/private-vulnerability-reporting-configure-notifications.md index 9e67618d052b..d6e1337cc3e7 100644 --- a/data/reusables/security-advisory/private-vulnerability-reporting-configure-notifications.md +++ b/data/reusables/security-advisory/private-vulnerability-reporting-configure-notifications.md @@ -1,4 +1,4 @@ When a new vulnerability is privately reported on a repository where private vulnerability reporting is enabled, {% data variables.product.product_name %} notifies repository maintainers and security managers if: - They're watching the repository for all activity. -- They have notifications enabled for the repository. +- They have notifications enabled for the repository. diff --git a/data/reusables/security-advisory/private-vulnerability-reporting-overview.md b/data/reusables/security-advisory/private-vulnerability-reporting-overview.md index 222436849238..c3594706217c 100644 --- a/data/reusables/security-advisory/private-vulnerability-reporting-overview.md +++ b/data/reusables/security-advisory/private-vulnerability-reporting-overview.md @@ -1,3 +1,3 @@ -Private vulnerability reporting makes it easy for security researchers to report vulnerabilities directly to you using a simple form. +Private vulnerability reporting makes it easy for security researchers to report vulnerabilities directly to you using a simple form. When a security researcher reports a vulnerability privately, you are notified and can choose to either accept it, ask more questions, or reject it. If you accept the report, you're ready to collaborate on a fix for the vulnerability in private with the security researcher. diff --git a/data/reusables/security-advisory/private-vulnerability-reporting-security-researcher.md b/data/reusables/security-advisory/private-vulnerability-reporting-security-researcher.md index c2b4a15eec76..d46b04bf0c25 100644 --- a/data/reusables/security-advisory/private-vulnerability-reporting-security-researcher.md +++ b/data/reusables/security-advisory/private-vulnerability-reporting-security-researcher.md @@ -1,3 +1,3 @@ -When private vulnerability reporting is enabled for a repository, security researchers will see a new button in the **Advisories** page of the repository. The security researcher can click this button to privately report a security vulnerability to the repository maintainer. +When private vulnerability reporting is enabled for a repository, security researchers will see a new button in the **Advisories** page of the repository. The security researcher can click this button to privately report a security vulnerability to the repository maintainer. ![Screenshot showing the "Report a vulnerability" button for a repository where private vulnerability reporting has been enabled.](/assets/images/help/security/report-a-vulnerability-button.png) diff --git a/data/reusables/sponsors/tier-details.md b/data/reusables/sponsors/tier-details.md index 3f11bc78638a..4a5292471e2b 100644 --- a/data/reusables/sponsors/tier-details.md +++ b/data/reusables/sponsors/tier-details.md @@ -1,10 +1,10 @@ You can publish up to 10 one-time sponsorship tiers and 10 monthly tiers for sponsors to choose from. Each tier has its own one-time or monthly payment amount in US dollars. Publishing tiers is optional. You can customize the rewards for each tier. For example, rewards for a tier could include: -- Early access to new versions +- Early access to new versions - Logo or name in README - Weekly newsletter updates -- Other rewards your sponsors would enjoy ✨ +- Other rewards your sponsors would enjoy ✨ {% data reusables.sponsors.sponsors-only-repos %} For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier)." diff --git a/data/reusables/stars/stars-page-navigation.md b/data/reusables/stars/stars-page-navigation.md index 195b628b879f..22983fae5f3d 100644 --- a/data/reusables/stars/stars-page-navigation.md +++ b/data/reusables/stars/stars-page-navigation.md @@ -1,3 +1,3 @@ -1. In the upper-right corner of any page, click your profile photo, then click ** Your stars**. +1. In the upper-right corner of any page, click your profile photo, then click ** Your stars**. ![Screenshot of the profile menu for octocat. The "Your stars" option is highlighted with an orange outline.](/assets/images/help/stars/navigate-to-stars-page.png) diff --git a/data/reusables/subversion/sunset.md b/data/reusables/subversion/sunset.md index 8b9f036ffe87..980f8ef74905 100644 --- a/data/reusables/subversion/sunset.md +++ b/data/reusables/subversion/sunset.md @@ -1,7 +1,7 @@ {% note %} **Note**: Subversion support will be removed from {% data variables.product.prodname_dotcom %} -on January 8, 2024. A future release of {% data variables.product.prodname_ghe_server %} after January 8, 2024 +on January 8, 2024. A future release of {% data variables.product.prodname_ghe_server %} after January 8, 2024 will also remove Subversion support. To read more about this, see [the GitHub blog][svn-sunset-blog]. [svn-sunset-blog]: https://github.blog/2023-01-20-sunsetting-subversion-support/ diff --git a/data/reusables/support/view-open-tickets.md b/data/reusables/support/view-open-tickets.md index 8f5225ccb3d1..613eced1d10d 100644 --- a/data/reusables/support/view-open-tickets.md +++ b/data/reusables/support/view-open-tickets.md @@ -1,5 +1,5 @@ {% data reusables.support.navigate-to-my-tickets %} -1. Optionally, to view tickets associated with an organization or enterprise account, select the **My Tickets** drop-down menu and click the name of the organization or enterprise account. +1. Optionally, to view tickets associated with an organization or enterprise account, select the **My Tickets** drop-down menu and click the name of the organization or enterprise account. {% indented_data_reference reusables.support.entitlements-note spaces=3 %} diff --git a/data/reusables/time_date/time_format.md b/data/reusables/time_date/time_format.md index fb71921b4d6b..8d21e6405c84 100644 --- a/data/reusables/time_date/time_format.md +++ b/data/reusables/time_date/time_format.md @@ -1 +1 @@ -You can also add optional time information `THH:MM:SS+00:00` after the date, to search by the hour, minute, and second. That's `T`, followed by `HH:MM:SS` (hour-minutes-seconds), and a UTC offset (`+00:00`). +You can also add optional time information `THH:MM:SS+00:00` after the date, to search by the hour, minute, and second. That's `T`, followed by `HH:MM:SS` (hour-minutes-seconds), and a UTC offset (`+00:00`). diff --git a/data/reusables/two_fa/mandatory-2fa-contributors-2023.md b/data/reusables/two_fa/mandatory-2fa-contributors-2023.md index 5e79bd4d7ed1..81605e1c59fc 100644 --- a/data/reusables/two_fa/mandatory-2fa-contributors-2023.md +++ b/data/reusables/two_fa/mandatory-2fa-contributors-2023.md @@ -2,6 +2,6 @@ **Note:** Starting in March 2023 and through the end of 2023, {% data variables.product.prodname_dotcom %} will gradually begin to require all users who contribute code on {% data variables.product.prodname_dotcom_the_website %} to enable one or more forms of two-factor authentication (2FA). If you are in an eligible group, you will receive a notification email when that group is selected for enrollment, marking the beginning of a 45-day 2FA enrollment period, and you will see banners asking you to enroll in 2FA on {% data variables.product.prodname_dotcom_the_website %}. If you don't receive a notification, then you are not part of a group required to enable 2FA, though we strongly recommend it. -For more information about the 2FA enrollment rollout, see [this blog post](https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13). +For more information about the 2FA enrollment rollout, see [this blog post](https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13). {% endnote %} diff --git a/data/reusables/user-settings/access_authorized_oauth_apps.md b/data/reusables/user-settings/access_authorized_oauth_apps.md index 960836c70c53..dbbe9bbfed96 100644 --- a/data/reusables/user-settings/access_authorized_oauth_apps.md +++ b/data/reusables/user-settings/access_authorized_oauth_apps.md @@ -1,3 +1,3 @@ 1. Click the **Authorized OAuth Apps** tab. - + ![Screenshot of the "Applications" page. A tab, labeled "Authorized OAuth Apps," is highlighted with an orange outline.](/assets/images/help/settings/settings-authorized-oauth-apps-tab.png) diff --git a/data/reusables/user-settings/access_settings.md b/data/reusables/user-settings/access_settings.md index f8c762268d1b..54562b67cc15 100644 --- a/data/reusables/user-settings/access_settings.md +++ b/data/reusables/user-settings/access_settings.md @@ -1,3 +1,3 @@ -1. In the upper-right corner of any page, click your profile photo, then click **Settings**. +1. In the upper-right corner of any page, click your profile photo, then click **Settings**. ![Screenshot of {% data variables.product.prodname_dotcom %}'s account menu showing options for users to view and edit their profile, content, and settings. The menu item "Settings" is outlined in dark orange.](/assets/images/help/settings/userbar-account-settings.png) diff --git a/data/reusables/user-settings/deleted-repos.md b/data/reusables/user-settings/deleted-repos.md index 41b159d98192..0f66733d218e 100644 --- a/data/reusables/user-settings/deleted-repos.md +++ b/data/reusables/user-settings/deleted-repos.md @@ -1,3 +1,3 @@ 1. Under "Repositories", click **Deleted repositories**. - + ![Screenshot of the "Repositories" settings page. Above a list of repositories, a link in gray text, labeled "Deleted repositories," is outlined in orange.](/assets/images/help/settings/deleted-repos.png) diff --git a/data/reusables/user-settings/developer_settings.md b/data/reusables/user-settings/developer_settings.md index 776e1490ff27..bf79141b274c 100644 --- a/data/reusables/user-settings/developer_settings.md +++ b/data/reusables/user-settings/developer_settings.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} 1. In the left sidebar, click **{% octicon "code" aria-hidden="true" %} Developer settings**. -{% else %} +{% else %} 1. In the left sidebar, click **Developer settings**. {% endif %} diff --git a/data/reusables/user-settings/patv2-filters.md b/data/reusables/user-settings/patv2-filters.md index 052394680e6c..d0fd8190c680 100644 --- a/data/reusables/user-settings/patv2-filters.md +++ b/data/reusables/user-settings/patv2-filters.md @@ -1,4 +1,4 @@ -1. Optionally, use filters to only display certain tokens. - - Use the **Owner** dropdown to filter the tokens by the member who created the token. - - Use the **Repository** dropdown to filter the tokens by repository access. +1. Optionally, use filters to only display certain tokens. + - Use the **Owner** dropdown to filter the tokens by the member who created the token. + - Use the **Repository** dropdown to filter the tokens by repository access. - Use the **Permissions** dropdown to filter the tokens by permission. diff --git a/data/reusables/user-settings/review-oauth-apps.md b/data/reusables/user-settings/review-oauth-apps.md index 53e8bdcc4258..759c57cd6736 100644 --- a/data/reusables/user-settings/review-oauth-apps.md +++ b/data/reusables/user-settings/review-oauth-apps.md @@ -1,3 +1,3 @@ 1. Review the tokens that have access to your account. For those that you don't recognize or that are out-of-date, click **{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}**, then click **Revoke**. To revoke all tokens, click **Revoke all**. - + ![Screenshot of the "Authorized {% data variables.product.prodname_oauth_apps %}" tab. To the right of an app's name, an icon of three horizontal dots is outlined in orange.](/assets/images/help/settings/revoke-oauth-app.png) diff --git a/data/reusables/user-settings/select_primary_email.md b/data/reusables/user-settings/select_primary_email.md index ff0ac32fcb6d..4f5f49bdc2ca 100644 --- a/data/reusables/user-settings/select_primary_email.md +++ b/data/reusables/user-settings/select_primary_email.md @@ -1,3 +1,3 @@ 1. In the "Primary email address" dropdown menu, select the email address you'd like to associate with your web-based Git operations. - + ![Screenshot of the "Email" settings page. Under "Primary email address," a dropdown menu, labeled with Octocat's email address, is outlined in orange.](/assets/images/help/settings/email-primary.png) diff --git a/data/reusables/webhooks/public_short_desc.md b/data/reusables/webhooks/public_short_desc.md index 9333dc3841cc..3f7ac658afc0 100644 --- a/data/reusables/webhooks/public_short_desc.md +++ b/data/reusables/webhooks/public_short_desc.md @@ -1 +1 @@ -When a private repository is made public. Without a doubt: the best {% data variables.product.product_name %} event. +When a private repository is made public. Without a doubt: the best {% data variables.product.product_name %} event.