diff --git a/.github/workflows/azure-preview-env-deploy.yml b/.github/workflows/azure-preview-env-deploy.yml index f3c838dcdb..892e0ebbc6 100644 --- a/.github/workflows/azure-preview-env-deploy.yml +++ b/.github/workflows/azure-preview-env-deploy.yml @@ -59,6 +59,7 @@ jobs: IS_INTERNAL_BUILD: ${{ github.repository == 'github/docs-internal' }} # This may also run in forked repositories, not just 'github/docs' IS_PUBLIC_BUILD: ${{ github.repository != 'github/docs-internal' }} + NONPROD_REGISTRY_USERNAME: ${{ fromJSON('["ghdocs", "ghdocsinternal"]')[github.repository == 'github/docs-internal'] }} steps: - name: 'Az CLI login' @@ -70,7 +71,7 @@ jobs: uses: azure/docker-login@81744f9799e7eaa418697cb168452a2882ae844a with: login-server: ${{ secrets.NONPROD_REGISTRY_SERVER }} - username: ${{ secrets.NONPROD_REGISTRY_USERNAME }} + username: ${{ env.NONPROD_REGISTRY_USERNAME }} password: ${{ secrets.NONPROD_REGISTRY_PASSWORD }} - name: Set up Docker Buildx @@ -205,7 +206,7 @@ jobs: parameters: appName="${{ env.APP_NAME }}" containerImage="${{ env.DOCKER_IMAGE }}" dockerRegistryUrl="${{ secrets.NONPROD_REGISTRY_SERVER }}" - dockerRegistryUsername="${{ secrets.NONPROD_REGISTRY_USERNAME }}" + dockerRegistryUsername="${{ env.NONPROD_REGISTRY_USERNAME }}" dockerRegistryPassword="${{ secrets.NONPROD_REGISTRY_PASSWORD }}" # this shows warnings in the github actions console, because the flag is passed through a validation run, # but it *is* functional during the actual execution diff --git a/.github/workflows/main-preview-docker-cache.yml b/.github/workflows/main-preview-docker-cache.yml index 2e41036ffe..1522e9a415 100644 --- a/.github/workflows/main-preview-docker-cache.yml +++ b/.github/workflows/main-preview-docker-cache.yml @@ -26,6 +26,7 @@ jobs: env: ENABLE_EARLY_ACCESS: ${{ github.repository == 'github/docs-internal' }} DOCKER_IMAGE_CACHE_REF: ${{ secrets.NONPROD_REGISTRY_SERVER }}/${{ github.repository }}:main-preview + NONPROD_REGISTRY_USERNAME: ${{ fromJSON('["ghdocs", "ghdocsinternal"]')[github.repository == 'github/docs-internal'] }} steps: - name: 'Az CLI login' @@ -37,7 +38,7 @@ jobs: uses: azure/docker-login@81744f9799e7eaa418697cb168452a2882ae844a with: login-server: ${{ secrets.NONPROD_REGISTRY_SERVER }} - username: ${{ secrets.NONPROD_REGISTRY_USERNAME }} + username: ${{ env.NONPROD_REGISTRY_USERNAME }} password: ${{ secrets.NONPROD_REGISTRY_PASSWORD }} - name: Set up Docker Buildx diff --git a/.github/workflows/needs-sme-stale-check.yaml b/.github/workflows/needs-sme-stale-check.yaml index f4faca3e40..b76eac8271 100644 --- a/.github/workflows/needs-sme-stale-check.yaml +++ b/.github/workflows/needs-sme-stale-check.yaml @@ -14,7 +14,7 @@ permissions: jobs: stale_needs-sme: - if: ${{ github.repository == 'github/docs'' }} + if: ${{ github.repository == 'github/docs' }} runs-on: ubuntu-latest steps: diff --git a/.github/workflows/triage-unallowed-internal-changes.yml b/.github/workflows/triage-unallowed-internal-changes.yml index 00299d1ca8..6908831f81 100644 --- a/.github/workflows/triage-unallowed-internal-changes.yml +++ b/.github/workflows/triage-unallowed-internal-changes.yml @@ -74,7 +74,7 @@ jobs: run: $GITHUB_WORKSPACE/.github/actions-scripts/enterprise-search-label.js - name: Fail if unallowed changes were made outside of the Search Sync label added - if: false == steps.labelExists.outputs.versionToSync && false == contains(github.event.pull_request.labels.*.name, 'deprecate-lunr-index') + if: false == steps.labelExists.outputs.versionToSync && false == contains(github.event.pull_request.labels.*.name, 'deprecate-lunr-index') && !contains(github.event.pull_request.labels.*.name, 'skip-index-check') run: | echo "Search indices are updated automatically every 4 hours. Please revert any changes you have made to the search indexes before you merge this PR. If you need to update the search indices directly after you merge your PR, you can manually run the search sync workflow: Sync search indexes. See the docs/contributing/search.md for more details. If you have any other questions, please ping us in #docs-engineering." exit 1 diff --git a/.gitignore b/.gitignore index 0a4285c2a2..8b780e4e2e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ .search-cache .DS_Store .env +.vscode/settings.json /node_modules/ npm-debug.log coverage/ diff --git a/assets/images/help/classroom/reuse-assignment-button.png b/assets/images/help/classroom/reuse-assignment-button.png new file mode 100644 index 0000000000..c4e23cbcc5 Binary files /dev/null and b/assets/images/help/classroom/reuse-assignment-button.png differ diff --git a/assets/images/help/classroom/reuse-assignment-completed-message.png b/assets/images/help/classroom/reuse-assignment-completed-message.png new file mode 100644 index 0000000000..0aedc5f252 Binary files /dev/null and b/assets/images/help/classroom/reuse-assignment-completed-message.png differ diff --git a/assets/images/help/classroom/reuse-assignment-modal.png b/assets/images/help/classroom/reuse-assignment-modal.png new file mode 100644 index 0000000000..f7eefd12a1 Binary files /dev/null and b/assets/images/help/classroom/reuse-assignment-modal.png differ diff --git a/assets/images/help/codespaces/prebuilds-triggers.png b/assets/images/help/codespaces/prebuilds-triggers.png new file mode 100644 index 0000000000..f04bbfacf2 Binary files /dev/null and b/assets/images/help/codespaces/prebuilds-triggers.png differ diff --git a/assets/images/help/discussions/enable-org-discussions.png b/assets/images/help/discussions/enable-org-discussions.png new file mode 100644 index 0000000000..5c1d86d2ad Binary files /dev/null and b/assets/images/help/discussions/enable-org-discussions.png differ diff --git a/assets/images/help/discussions/hero.png b/assets/images/help/discussions/hero.png index bca400f11b..d9089bacc4 100644 Binary files a/assets/images/help/discussions/hero.png and b/assets/images/help/discussions/hero.png differ diff --git a/assets/images/help/discussions/new-poll-add-option.png b/assets/images/help/discussions/new-poll-add-option.png new file mode 100644 index 0000000000..64eaf225fa Binary files /dev/null and b/assets/images/help/discussions/new-poll-add-option.png differ diff --git a/assets/images/help/discussions/new-poll-options.png b/assets/images/help/discussions/new-poll-options.png new file mode 100644 index 0000000000..429f6c7efd Binary files /dev/null and b/assets/images/help/discussions/new-poll-options.png differ diff --git a/assets/images/help/discussions/new-poll-question.png b/assets/images/help/discussions/new-poll-question.png new file mode 100644 index 0000000000..f5ad8321de Binary files /dev/null and b/assets/images/help/discussions/new-poll-question.png differ diff --git a/assets/images/help/discussions/new-poll-start-poll-button.png b/assets/images/help/discussions/new-poll-start-poll-button.png new file mode 100644 index 0000000000..ae5361f391 Binary files /dev/null and b/assets/images/help/discussions/new-poll-start-poll-button.png differ diff --git a/assets/images/help/discussions/new-poll-title-and-body-fields.png b/assets/images/help/discussions/new-poll-title-and-body-fields.png new file mode 100644 index 0000000000..f817bfd7f9 Binary files /dev/null and b/assets/images/help/discussions/new-poll-title-and-body-fields.png differ diff --git a/assets/images/help/discussions/org-settings.png b/assets/images/help/discussions/org-settings.png new file mode 100644 index 0000000000..2f5488d12b Binary files /dev/null and b/assets/images/help/discussions/org-settings.png differ diff --git a/assets/images/help/discussions/poll-category.png b/assets/images/help/discussions/poll-category.png new file mode 100644 index 0000000000..63f03f3c77 Binary files /dev/null and b/assets/images/help/discussions/poll-category.png differ diff --git a/assets/images/help/discussions/start-poll-button.png b/assets/images/help/discussions/start-poll-button.png new file mode 100644 index 0000000000..8c5ca72d01 Binary files /dev/null and b/assets/images/help/discussions/start-poll-button.png differ diff --git a/components/lib/get-rest-code-samples.ts b/components/lib/get-rest-code-samples.ts index a7a72b178b..1439476bf6 100644 --- a/components/lib/get-rest-code-samples.ts +++ b/components/lib/get-rest-code-samples.ts @@ -117,7 +117,26 @@ export function getJSExample(operation: Operation, codeSample: CodeSample) { const parameters = codeSample.request ? { ...codeSample.request.parameters, ...codeSample.request.bodyParameters } : {} + + let queryParameters = '' + + // Add query parameters to the request path for POST and PUT operations in + // URL template format e.g. 'POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}' + if (operation.verb === 'post' || operation.verb === 'put') { + const queryParms = operation.parameters + .filter((param) => { + return param.in === 'query' + }) + .map((param) => { + return param.name + }) + + if (queryParms.length > 0) { + queryParameters = `{?${queryParms.join(',')}}` + } + } + return `await octokit.request('${operation.verb.toUpperCase()} ${ operation.requestPath - }', ${stringify(parameters, null, 2)})` + }${queryParameters}', ${stringify(parameters, null, 2)})` } diff --git a/content/account-and-profile/index.md b/content/account-and-profile/index.md index 2e3be14cd4..2c63ecf2ea 100644 --- a/content/account-and-profile/index.md +++ b/content/account-and-profile/index.md @@ -1,7 +1,7 @@ --- title: Your account and profile on GitHub shortTitle: Account and profile -intro: 'Make {% data variables.product.product_name %} work best for you by adjusting the settings for your user account, personalizing your profile page, and managing the notifications you receive for activity on {% data variables.product.prodname_dotcom %}.' +intro: 'Make {% data variables.product.product_name %} work best for you by adjusting the settings for your personal account, personalizing your profile page, and managing the notifications you receive for activity on {% data variables.product.prodname_dotcom %}.' introLinks: quickstart: /get-started/onboarding/getting-started-with-your-github-account featuredLinks: diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md index 6bd1bd1d41..7584dfbb0d 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md @@ -44,7 +44,7 @@ In general, you are automatically subscribed to conversations by default when yo - Changed the state of a thread, such as by closing an issue or merging a pull request. - Had a team you're a member of @mentioned. -By default, you also automatically watch all repositories that you create and are owned by your user account. +By default, you also automatically watch all repositories that you create and are owned by your personal account. To unsubscribe from conversations you're automatically subscribed to, you can change your notification settings or directly unsubscribe or unwatch activity on {% data variables.product.product_location %}. For more information, see "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/index.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/index.md index 4d28909010..546240072c 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/index.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/index.md @@ -1,7 +1,7 @@ --- title: Setting up and managing your GitHub user account -intro: 'You can manage settings in your GitHub user account including email preferences, collaborator access for personal repositories, and organization memberships.' -shortTitle: User accounts +intro: 'You can manage settings in your GitHub personal account including email preferences, collaborator access for personal repositories, and organization memberships.' +shortTitle: Personal accounts redirect_from: - /categories/setting-up-and-managing-your-github-user-account - /github/setting-up-and-managing-your-github-user-account diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md index e529d774e8..a62bd18c7a 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md @@ -60,7 +60,7 @@ If you're a member of an {% data variables.product.prodname_emu_enterprise %}, y ## Further reading -- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-user-account)" +- "[Permission levels for a personal account repository](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-personal-account)" - "[Removing a collaborator from a personal repository](/articles/removing-a-collaborator-from-a-personal-repository)" - "[Removing yourself from a collaborator's repository](/articles/removing-yourself-from-a-collaborator-s-repository)" - "[Organizing members into teams](/organizations/organizing-members-into-teams)" diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address.md index d7f7361a60..107b10430d 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address.md @@ -1,6 +1,6 @@ --- title: Changing your primary email address -intro: You can change the email address associated with your user account at any time. +intro: You can change the email address associated with your personal account at any time. redirect_from: - /articles/changing-your-primary-email-address - /github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email.md index e3a1cec0b9..1be333af6e 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email.md @@ -1,6 +1,6 @@ --- title: Remembering your GitHub username or email -intro: 'Are you signing in to {% data variables.product.product_location %} for the first time in a while? If so, welcome back! If you can''t remember your {% data variables.product.product_name %} user account name, you can try these methods for remembering it.' +intro: 'Are you signing in to {% data variables.product.product_location %} for the first time in a while? If so, welcome back! If you can''t remember the username for your personal account on {% data variables.product.product_name %}, you can try these methods for remembering it.' redirect_from: - /articles/oh-noes-i-ve-forgotten-my-username-email - /articles/oh-noes-i-ve-forgotten-my-username-or-email diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company.md index b1295c2cf2..f7d00a0f0a 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company.md @@ -1,6 +1,6 @@ --- title: Best practices for leaving your company -intro: 'Changing jobs is a fact of life. If you use your GitHub user account for both personal *and* work purposes, there are a few things to keep in mind when you leave your company or organization.' +intro: 'If you use your account on {% data variables.product.product_name %} for both personal and work purposes, there are a few things to keep in mind when you leave your company or organization.' redirect_from: - /articles/best-practices-for-leaving-your-company - /github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company @@ -12,7 +12,7 @@ topics: - Accounts shortTitle: Leaving your company --- -Before you leave your company, make sure you update the following information in your user account: +Before you leave your company, make sure you update the following information in your personal account: - Unverify your company email address by [deleting it in your Email settings](/articles/changing-your-primary-email-address). You can then re-add it without verifying to keep any associated commits linked to your account. - [Change your primary email address](/articles/changing-your-primary-email-address) from your company email to your personal email. @@ -27,7 +27,7 @@ If you've been working with repositories that belong to an organization, you'll ## Removing professional associations with personal repositories -If you've been collaborating professionally with another person on repositories that belong to their personal user account, you'll want to [remove yourself as a collaborator](/articles/removing-yourself-from-a-collaborator-s-repository) from those repositories. +If you've been collaborating professionally with another person on repositories that belong to their personal account, you'll want to [remove yourself as a collaborator](/articles/removing-yourself-from-a-collaborator-s-repository) from those repositories. - [Stop watching repositories](https://github.com/watching) related to your work. You won't want those notifications anymore! - [Transfer repositories you own](/articles/how-to-transfer-a-repository) that others may need to continue working on after you leave. diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md index b872909d1e..59d90651f0 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md @@ -6,7 +6,7 @@ redirect_from: - /articles/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization -intro: You can convert your user account into an organization. This allows more granular permissions for repositories that belong to the organization. +intro: You can convert your personal account into an organization. This allows more granular permissions for repositories that belong to the organization. versions: fpt: '*' ghes: '*' @@ -19,32 +19,32 @@ shortTitle: User into an organization **Warning**: Before converting a user into an organization, keep these points in mind: - - You will **no longer** be able to sign into the converted user account. - - You will **no longer** be able to create or modify gists owned by the converted user account. + - You will **no longer** be able to sign into the converted personal account. + - You will **no longer** be able to create or modify gists owned by the converted personal account. - An organization **cannot** be converted back to a user. - - The SSH keys, OAuth tokens, job profile, reactions, and associated user information, **will not** be transferred to the organization. This is only true for the user account that's being converted, not any of the user account's collaborators. - - Any commits made with the converted user account **will no longer be linked** to that account. The commits themselves **will** remain intact. - - Any forks of private repositories made with the converted user account will be deleted. + - The SSH keys, OAuth tokens, job profile, reactions, and associated user information, **will not** be transferred to the organization. This is only true for the personal account that's being converted, not any of the personal account's collaborators. + - Any commits made with the converted personal account **will no longer be linked** to that account. The commits themselves **will** remain intact. + - Any forks of private repositories made with the converted personal account will be deleted. {% endwarning %} -## Keep your personal user account and create a new organization manually +## Keep your personal account and create a new organization manually -If you want your organization to have the same name that you are currently using for your personal account, or if you want to keep your personal user account's information intact, then you must create a new organization and transfer your repositories to it instead of converting your user account into an organization. +If you want your organization to have the same name that you are currently using for your personal account, or if you want to keep your personal account's information intact, then you must create a new organization and transfer your repositories to it instead of converting your personal account into an organization. -1. To retain your current user account name for your personal use, [change the name of your personal user account](/articles/changing-your-github-username) to something new and wonderful. -2. [Create a new organization](/articles/creating-a-new-organization-from-scratch) with the original name of your personal user account. +1. To retain your current personal account name for your personal use, [change the name of your personal account](/articles/changing-your-github-username) to something new and wonderful. +2. [Create a new organization](/articles/creating-a-new-organization-from-scratch) with the original name of your personal account. 3. [Transfer your repositories](/articles/transferring-a-repository) to your new organization account. ## Convert your personal account into an organization automatically -You can also convert your personal user account directly into an organization. Converting your account: +You can also convert your personal account directly into an organization. Converting your account: - Preserves the repositories as they are without the need to transfer them to another account manually - Automatically invites collaborators to teams with permissions equivalent to what they had before - {% ifversion fpt or ghec %}- For user accounts on {% data variables.product.prodname_pro %}, automatically transitions billing to [the paid {% data variables.product.prodname_team %}](/articles/about-billing-for-github-accounts) without the need to re-enter payment information, adjust your billing cycle, or double pay at any time{% endif %} + {% ifversion fpt or ghec %}- For personal accounts on {% data variables.product.prodname_pro %}, automatically transitions billing to [the paid {% data variables.product.prodname_team %}](/articles/about-billing-for-github-accounts) without the need to re-enter payment information, adjust your billing cycle, or double pay at any time{% endif %} 1. Create a new personal account, which you'll use to sign into GitHub and access the organization and your repositories after you convert. -2. [Leave any organizations](/articles/removing-yourself-from-an-organization) the user account you're converting has joined. +2. [Leave any organizations](/articles/removing-yourself-from-an-organization) the personal account you're converting has joined. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.organizations %} 5. Under "Transform account", click **Turn into an organization**. @@ -55,11 +55,11 @@ You can also convert your personal user account directly into an organization. C ![Add organization owner page](/assets/images/help/organizations/organization-add-owner.png) 8. Choose your new organization's subscription and enter your billing information if prompted. 9. Click **Create Organization**. -10. Sign in to the new user account you created in step one, then use the context switcher to access your new organization. +10. Sign in to the new personal account you created in step one, then use the context switcher to access your new organization. {% tip %} -**Tip**: When you convert a user account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as *outside collaborators*. You can then invite *outside collaborators* to become members of your new organization if you wish. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." +**Tip**: When you convert a personal account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as *outside collaborators*. You can then invite *outside collaborators* to become members of your new organization if you wish. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." {% endtip %} diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md index f2cbb3adb6..f5591683eb 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md @@ -1,6 +1,6 @@ --- title: Deleting your user account -intro: 'You can delete your {% data variables.product.product_name %} user account at any time.' +intro: 'You can delete your personal account on {% data variables.product.product_name %} at any time.' redirect_from: - /articles/deleting-a-user-account - /articles/deleting-your-user-account @@ -12,13 +12,13 @@ versions: ghec: '*' topics: - Accounts -shortTitle: Delete your user account +shortTitle: Delete your personal account --- -Deleting your user account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %} Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted - instead, they'll be associated with our [Ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %} +Deleting your personal account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %} Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted - instead, they'll be associated with our [Ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %} {% ifversion fpt or ghec %} When you delete your account we stop billing you. The email address associated with the account becomes available for use with a different account on {% data variables.product.product_location %}. After 90 days, the account name also becomes available to anyone else to use on a new account. {% endif %} -If you’re the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your user account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your user account. +If you’re the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your personal account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your personal account. For more information, see: - "[Transferring organization ownership](/articles/transferring-organization-ownership)" @@ -27,19 +27,19 @@ For more information, see: ## Back up your account data -Before you delete your user account, make a copy of all repositories, private forks, wikis, issues, and pull requests owned by your account. +Before you delete your personal account, make a copy of all repositories, private forks, wikis, issues, and pull requests owned by your account. {% warning %} -**Warning:** Once your user account has been deleted, GitHub cannot restore your content. +**Warning:** Once your personal account has been deleted, GitHub cannot restore your content. {% endwarning %} -## Delete your user account +## Delete your personal account {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.account_settings %} -3. At the bottom of the Account Settings page, under "Delete account", click **Delete your account**. Before you can delete your user account: +3. At the bottom of the Account Settings page, under "Delete account", click **Delete your account**. Before you can delete your personal account: - If you're the only owner in the organization, you must transfer ownership to another person or delete your organization. - If there are other organization owners in the organization, you must remove yourself from the organization. ![Account deletion button](/assets/images/help/settings/settings-account-delete.png) diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md index 5869a719ec..f6f5bb8f12 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md @@ -30,6 +30,6 @@ children: - /integrating-jira-with-your-personal-projects - /best-practices-for-leaving-your-company - /what-does-the-available-for-hire-checkbox-do -shortTitle: User account settings +shortTitle: Personal account settings --- diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects.md index 5711f66ac5..7a5bbd5c3d 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects.md @@ -1,6 +1,6 @@ --- title: Integrating Jira with your personal projects -intro: 'You can integrate Jira Cloud with your user account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues.' +intro: 'You can integrate Jira Cloud with your personal account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues.' redirect_from: - /articles/integrating-jira-with-your-personal-projects - /github/setting-up-and-managing-your-github-user-account/integrating-jira-with-your-personal-projects diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md index eda7a7fcba..b64c8c5285 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md @@ -18,7 +18,7 @@ shortTitle: Manage security & analysis You can still manage the security and analysis features for individual repositories. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." -You can also review the security log for all activity on your user account. For more information, see "[Reviewing your security log](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)." +You can also review the security log for all activity on your personal account. For more information, see "[Reviewing your security log](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)." {% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %} diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md index 0b9a0dab51..17103b8a96 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md @@ -1,6 +1,6 @@ --- title: Managing your tab size rendering preference -intro: You can manage the number of spaces a tab is equal to for your user account. +intro: You can manage the number of spaces a tab is equal to for your personal account. versions: fpt: '*' ghae: issue-5083 diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md index a484ab4a52..ebfa80dd2b 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md @@ -12,17 +12,17 @@ versions: ghec: '*' topics: - Accounts -shortTitle: Merge multiple user accounts +shortTitle: Merge multiple personal accounts --- {% tip %} {% ifversion ghec %} -**Tip:** {% data variables.product.prodname_emus %} allow an enterprise to provision unique user accounts for its members through an identity provider (IdP). For more information, see "[About Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users)." For other use cases, we recommend using only one user account to manage both personal and professional repositories. +**Tip:** {% data variables.product.prodname_emus %} allow an enterprise to provision unique personal accounts for its members through an identity provider (IdP). For more information, see "[About Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users)." For other use cases, we recommend using only one personal account to manage both personal and professional repositories. {% else %} -**Tip:** We recommend using only one user account to manage both personal and professional repositories. +**Tip:** We recommend using only one personal account to manage both personal and professional repositories. {% endif %} diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md index e9b90a2b10..7c611a4533 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md @@ -1,6 +1,6 @@ --- title: Permission levels for a user account repository -intro: 'A repository owned by a user account has two permission levels: the repository owner and collaborators.' +intro: 'A repository owned by a personal account has two permission levels: the repository owner and collaborators.' redirect_from: - /articles/permission-levels-for-a-user-account-repository - /github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository @@ -14,19 +14,19 @@ topics: - Accounts shortTitle: Permission user repositories --- -## About permissions levels for a user account repository +## About permissions levels for a personal account repository -Repositories owned by user accounts have one owner. Ownership permissions can't be shared with another user account. +Repositories owned by personal accounts have one owner. Ownership permissions can't be shared with another personal account. You can also {% ifversion fpt or ghec %}invite{% else %}add{% endif %} users on {% data variables.product.product_name %} to your repository as collaborators. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)." {% tip %} -**Tip:** If you require more granular access to a repository owned by your user account, consider transferring the repository to an organization. For more information, see "[Transferring a repository](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-user-account)." +**Tip:** If you require more granular access to a repository owned by your personal account, consider transferring the repository to an organization. For more information, see "[Transferring a repository](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-personal-account)." {% endtip %} -## Owner access for a repository owned by a user account +## Owner access for a repository owned by a personal account The repository owner has full control of the repository. In addition to the actions that any collaborator can perform, the repository owner can perform the following actions. @@ -53,13 +53,13 @@ The repository owner has full control of the repository. In addition to the acti | Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %} | Allow or disallow auto-merge for pull requests | "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | -## Collaborator access for a repository owned by a user account +## Collaborator access for a repository owned by a personal account Collaborators on a personal repository can pull (read) the contents of the repository and push (write) changes to the repository. {% note %} -**Note:** In a private repository, repository owners can only grant write access to collaborators. Collaborators can't have read-only access to repositories owned by a user account. +**Note:** In a private repository, repository owners can only grant write access to collaborators. Collaborators can't have read-only access to repositories owned by a personal account. {% endnote %} diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards.md index df83878dc8..ac912b72cb 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards.md @@ -1,6 +1,6 @@ --- title: Permission levels for user-owned project boards -intro: 'A project board owned by a user account has two permission levels: the project board owner and collaborators.' +intro: 'A project board owned by a personal account has two permission levels: the project board owner and collaborators.' redirect_from: - /articles/permission-levels-for-user-owned-project-boards - /github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards @@ -16,7 +16,7 @@ shortTitle: Permission user project boards --- ## Permissions overview -There is only one owner of a user-owned project board; this permission cannot be shared with another user account. In addition to the owner, other people can collaborate on project boards. +There is only one owner of a user-owned project board; this permission cannot be shared with another personal account. In addition to the owner, other people can collaborate on project boards. There are three levels of permissions for project board collaborators: @@ -60,4 +60,4 @@ You can change the project board's visibility from private to {% ifversion ghae ## Further reading - - "[Managing access to your user account's project boards](/articles/managing-access-to-your-user-account-s-project-boards)" + - "[Managing access to your personal account's project boards](/articles/managing-access-to-your-user-account-s-project-boards)" diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization.md index eb90c64f7a..19a261a7af 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization.md @@ -1,6 +1,6 @@ --- title: Accessing an organization -intro: 'To access an organization that you''re a member of, you must sign in to your personal user account.' +intro: 'To access an organization that you''re a member of, you must sign in to your personal account.' redirect_from: - /articles/error-cannot-log-in-that-account-is-an-organization - /articles/cannot-log-in-that-account-is-an-organization diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md index 188eab6781..93c8fbef3b 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md @@ -21,7 +21,7 @@ You can set scheduled reminders for personal or team-level review requests for p {% data reusables.reminders.scheduled-reminders-limitations %} -## Creating scheduled reminders for your user account +## Creating scheduled reminders for your personal account {% data reusables.user-settings.access_settings %} {% data reusables.reminders.scheduled-reminders %} @@ -39,7 +39,7 @@ You can set scheduled reminders for personal or team-level review requests for p ![Enable real-time alerts checkbox](/assets/images/help/settings/scheduled-reminders-real-time-alerts-personal.png) {% data reusables.reminders.create-reminder %} -## Managing scheduled reminders for your user account +## Managing scheduled reminders for your personal account {% data reusables.user-settings.access_settings %} {% data reusables.reminders.scheduled-reminders %} 1. Next to the organization you'd like to edit scheduled reminders for, click **Edit**. @@ -47,7 +47,7 @@ You can set scheduled reminders for personal or team-level review requests for p {% data reusables.reminders.edit-page %} {% data reusables.reminders.update-buttons %} -## Deleting scheduled reminders for your user account +## Deleting scheduled reminders for your personal account {% data reusables.user-settings.access_settings %} {% data reusables.reminders.scheduled-reminders %} 1. Next to the organization you'd like to delete reminders for, click **Edit**. diff --git a/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index 6908c635f4..80730a9ade 100644 --- a/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -114,7 +114,7 @@ The token also includes custom claims provided by {% data variables.product.prod | Claim | Description | | ----------- | ---------------------- | -| `actor`| The user account that initiated the workflow run. | +| `actor`| The personal account that initiated the workflow run. | | `base_ref`| The target branch of the pull request in a workflow run. | | `environment`| The name of the environment used by the job. | | `event_name`| The name of the event that triggered the workflow run. | diff --git a/content/actions/learn-github-actions/understanding-github-actions.md b/content/actions/learn-github-actions/understanding-github-actions.md index c5e56e19f6..22050b4b2b 100644 --- a/content/actions/learn-github-actions/understanding-github-actions.md +++ b/content/actions/learn-github-actions/understanding-github-actions.md @@ -192,7 +192,7 @@ Defines a job named check-bats-version. The child keys will define ``` -The uses keyword specifies that this step will run v2 of the actions/checkout action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will run against the repository's code. +The uses keyword specifies that this step will run v3 of the actions/checkout action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will run against the repository's code. diff --git a/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md b/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md index 693c78b6c6..9dd033ac14 100644 --- a/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md +++ b/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md @@ -63,7 +63,7 @@ In the tutorial, you will first make a workflow file that uses the [`alex-page/g Whenever an issue in your repository is assigned, the issue will be moved to the specified project board column. If the issue is not already on the project board, it will be added to the project board. -If your repository is user-owned, the `alex-page/github-project-automation-plus` action will act on all projects in your repository or user account that have the specified project name and column. Likewise, if your repository is organization-owned, the action will act on all projects in your repository or organization that have the specified project name and column. +If your repository is user-owned, the `alex-page/github-project-automation-plus` action will act on all projects in your repository or personal account that have the specified project name and column. Likewise, if your repository is organization-owned, the action will act on all projects in your repository or organization that have the specified project name and column. Test your workflow by assigning an issue in your repository. 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 efbb783477..e338216e22 100644 --- a/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/content/actions/security-guides/security-hardening-for-github-actions.md @@ -256,10 +256,10 @@ This list describes the recommended approaches for accessing repository data wit 3. **{% data variables.product.prodname_github_app %} tokens** - {% data variables.product.prodname_github_apps %} can be installed on select repositories, and even have granular permissions on the resources within them. You could create a {% data variables.product.prodname_github_app %} internal to your organization, install it on the repositories you need access to within your workflow, and authenticate as the installation within your workflow to access those repositories. 4. **Personal access tokens** - - You should never use personal access tokens from your own account. These tokens grant access to all repositories within the organizations that you have access to, as well as all personal repositories in your user account. This indirectly grants broad access to all write-access users of the repository the workflow is in. In addition, if you later leave an organization, workflows using this token will immediately break, and debugging this issue can be challenging. + - You should never use personal access tokens from your own account. These tokens grant access to all repositories within the organizations that you have access to, as well as all personal repositories in your personal account. This indirectly grants broad access to all write-access users of the repository the workflow is in. In addition, if you later leave an organization, workflows using this token will immediately break, and debugging this issue can be challenging. - If a personal access token is used, it should be one that was generated for a new account that is only granted access to the specific repositories that are needed for the workflow. Note that this approach is not scalable and should be avoided in favor of alternatives, such as deploy keys. -5. **SSH keys on a user account** - - Workflows should never use the SSH keys on a user account. Similar to personal access tokens, they grant read/write permissions to all of your personal repositories as well as all the repositories you have access to through organization membership. This indirectly grants broad access to all write-access users of the repository the workflow is in. If you're intending to use an SSH key because you only need to perform repository clones or pushes, and do not need to interact with public APIs, then you should use individual deploy keys instead. +5. **SSH keys on a personal account** + - Workflows should never use the SSH keys on a personal account. Similar to personal access tokens, they grant read/write permissions to all of your personal repositories as well as all the repositories you have access to through organization membership. This indirectly grants broad access to all write-access users of the repository the workflow is in. If you're intending to use an SSH key because you only need to perform repository clones or pushes, and do not need to interact with public APIs, then you should use individual deploy keys instead. ## Hardening for self-hosted runners @@ -300,7 +300,7 @@ If you are using {% data variables.product.prodname_actions %} to deploy to a cl ## Auditing {% data variables.product.prodname_actions %} events -You can use the audit log to monitor administrative tasks in an organization. The audit log records the type of action, when it was run, and which user account performed the action. +You can use the audit log to monitor administrative tasks in an organization. The audit log records the type of action, when it was run, and which personal account performed the action. For example, you can use the audit log to track the `org.update_actions_secret` event, which tracks changes to organization secrets: ![Audit log entries](/assets/images/help/repository/audit-log-entries.png) 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 94f9079075..767c275bfe 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 @@ -26,7 +26,7 @@ If you can't access {% data variables.product.product_name %}, contact your loca {% ifversion fpt or ghec %} -{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your user account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}. +{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your personal account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}. If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you will use a new account that is provisioned for you. {% data reusables.enterprise-accounts.emu-more-info-account %} diff --git a/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/content/authentication/connecting-to-github-with-ssh/about-ssh.md index a649ffb628..10b11d3d00 100644 --- a/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -25,7 +25,7 @@ To maintain account security, you can regularly review your SSH keys list and re If you haven't used your SSH key for a year, then {% data variables.product.prodname_dotcom %} will automatically delete your inactive SSH key as a security precaution. For more information, see "[Deleted or missing SSH keys](/articles/deleted-or-missing-ssh-keys)." {% endif %} -If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your account on {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories that are owned by your user account. For more information, see "[About SSH certificate authorities](/articles/about-ssh-certificate-authorities)." +If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your account on {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories that are owned by your personal account. For more information, see "[About SSH certificate authorities](/articles/about-ssh-certificate-authorities)." ## Further reading diff --git a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md index 3c61925687..4539c7f137 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md @@ -33,7 +33,7 @@ You can authenticate to {% data variables.product.product_name %} in your browse {% endif %} - **Username and password only** - - You'll create a password when you create your user account on {% data variables.product.product_name %}. We recommend that you use a password manager to generate a random and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/creating-a-strong-password)." + - You'll create a password when you create your personal account on {% data variables.product.product_name %}. We recommend that you use a password manager to generate a random and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/creating-a-strong-password)." - **Two-factor authentication (2FA)** (recommended) - If you enable 2FA, we'll also prompt you to provide a code that's generated by an application on your mobile device or sent as a text message (SMS) after you successfully enter your username and password. For more information, see "[Accessing {% data variables.product.prodname_dotcom %} using two-factor authentication](/github/authenticating-to-github/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website)." - In addition to authentication with a mobile application or a text message, you can optionally add a secondary method of authentication with a security key using WebAuthn. For more information, see "[Configuring two-factor authentication using a security key](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)." diff --git a/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md b/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md index 33170c5658..1581053af2 100644 --- a/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md +++ b/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md @@ -77,7 +77,7 @@ When {% data variables.product.prodname_oauth_apps %} request new access permiss ## {% data variables.product.prodname_oauth_apps %} and organizations -When you authorize an {% data variables.product.prodname_oauth_app %} for your personal user account, you'll also see how the authorization will affect each organization you're a member of. +When you authorize an {% data variables.product.prodname_oauth_app %} for your personal account, you'll also see how the authorization will affect each organization you're a member of. - **For organizations *with* {% data variables.product.prodname_oauth_app %} access restrictions, you can request that organization admins approve the application for use in that organization.** If the organization does not approve the application, then the application will only be able to access the organization's public resources. If you're an organization admin, you can [approve the application](/articles/approving-oauth-apps-for-your-organization) yourself. diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md index 83ac731e79..8f67ff6238 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md @@ -1,6 +1,6 @@ --- title: Reviewing your security log -intro: You can review the security log for your user account to better understand actions you've performed and actions others have performed that involve you. +intro: You can review the security log for your personal account to better understand actions you've performed and actions others have performed that involve you. miniTocMaxHeadingLevel: 3 redirect_from: - /articles/reviewing-your-security-log @@ -87,7 +87,7 @@ An overview of some of the most common actions that are recorded as events in th | `resume` | Triggered when you resume a suspended codespace. | `delete` | Triggered when you [delete a codespace](/github/developing-online-with-codespaces/deleting-a-codespace). | `manage_access_and_security` | Triggered when you update [the repositories a codespace has access to](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). -| `trusted_repositories_access_update` | Triggered when you change your user account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). +| `trusted_repositories_access_update` | Triggered when you change your personal account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). ### `marketplace_agreement_signature` category actions @@ -186,16 +186,16 @@ An overview of some of the most common actions that are recorded as events in th | `sponsor_sponsorship_payment_complete` | Triggered after you sponsor an account and your payment has been processed (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") | `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") | `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled | `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state | `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") -| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") | `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") -| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") {% endif %} {% ifversion fpt or ghec %} @@ -203,11 +203,11 @@ An overview of some of the most common actions that are recorded as events in th | Action | Description |------------------|------------------- -| `accept` | Triggered when you accept a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") -| `cancel` | Triggered when you cancel a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") -| `create` | Triggered when you create a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") -| `decline` | Triggered when you decline a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") -| `revoke` | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `accept` | Triggered when you accept a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `cancel` | Triggered when you cancel a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `create` | Triggered when you create a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `decline` | Triggered when you decline a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") +| `revoke` | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") {% endif %} {% ifversion ghes or ghae %} @@ -239,9 +239,9 @@ An overview of some of the most common actions that are recorded as events in th | Action | Description |--------------------|--------------------- | `add_email` | Triggered when you {% ifversion not ghae %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}.{% ifversion fpt or ghec %} -| `codespaces_trusted_repo_access_granted` | Triggered when you [allow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). -| `codespaces_trusted_repo_access_revoked` | Triggered when you [disallow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). {% endif %} -| `create` | Triggered when you create a new user account.{% ifversion not ghae %} +| `codespaces_trusted_repo_access_granted` | Triggered when you [allow the codespaces you create for a repository to access other repositories owned by your personal account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). +| `codespaces_trusted_repo_access_revoked` | Triggered when you [disallow the codespaces you create for a repository to access other repositories owned by your personal account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). {% endif %} +| `create` | Triggered when you create a new personal account.{% ifversion not ghae %} | `change_password` | Triggered when you change your password. | `forgot_password` | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).{% endif %} | `hide_private_contributions_count` | Triggered when you [hide private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile). diff --git a/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md b/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md index 6c4f7c1cc6..d5edaf9ab6 100644 --- a/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md +++ b/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md @@ -15,6 +15,6 @@ topics: - SSH shortTitle: Permission denied other-repo --- -To fix this, remove the deploy key from the repository, and [add the key to your user account](/articles/adding-a-new-ssh-key-to-your-github-account) instead. +To fix this, remove the deploy key from the repository, and [add the key to your personal account](/articles/adding-a-new-ssh-key-to-your-github-account) instead. If the key you are using is intended to be a deploy key, check out [our guide on deploy keys](/guides/managing-deploy-keys) for more details. 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 e72e9be9c4..70f0245062 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 @@ -32,9 +32,9 @@ As soon as you set a spending limit other than $0, you will be responsible for a Because you have not enabled overages, your next attempt to create a workflow artifact will fail. You will not receive a bill for the 0.1GB overage that month. However, if you enable overages, your first bill will include the 0.1GB of existing overage for the current billing cycle, as well as any additional overages you accrue. -## Managing the spending limit for {% data variables.product.prodname_actions %} for your user account +## Managing the spending limit for {% data variables.product.prodname_actions %} for your personal account -Anyone can manage the spending limit for {% data variables.product.prodname_actions %} for their own user account. +Anyone can manage the spending limit for {% data variables.product.prodname_actions %} for their own personal account. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} diff --git a/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md b/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md index 22c625c358..8845caa889 100644 --- a/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md +++ b/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md @@ -17,9 +17,9 @@ shortTitle: View your Actions usage --- You can also view the billable job execution minutes for an individual workflow run. For more information, see "[Viewing job execution time](/actions/managing-workflow-runs/viewing-job-execution-time)." -## Viewing {% data variables.product.prodname_actions %} usage for your user account +## Viewing {% data variables.product.prodname_actions %} usage for your personal account -Anyone can view {% data variables.product.prodname_actions %} usage for their own user account. +Anyone can view {% data variables.product.prodname_actions %} usage for their own personal account. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} 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 d7affdb648..2bb73fdf9a 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 @@ -33,9 +33,9 @@ As soon as you set a spending limit other than $0, you will be responsible for a Because you have not enabled overages, your next attempt to publish a version of the package will fail. You will not receive a bill for the 0.1GB overage that month. However, if you enable overages, your first bill will include the 0.1GB of existing overage for the current billing cycle, as well as any additional overages you accrue. -## Managing the spending limit for {% data variables.product.prodname_registry %} for your user account +## Managing the spending limit for {% data variables.product.prodname_registry %} for your personal account -Anyone can manage the spending limit for {% data variables.product.prodname_registry %} for their own user account. +Anyone can manage the spending limit for {% data variables.product.prodname_registry %} for their own personal account. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} diff --git a/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md b/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md index fb21612fdd..8d782d3e1b 100644 --- a/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md +++ b/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md @@ -16,9 +16,9 @@ topics: - User account shortTitle: View your usage --- -## Viewing {% data variables.product.prodname_registry %} usage for your user account +## Viewing {% data variables.product.prodname_registry %} usage for your personal account -Anyone can view {% data variables.product.prodname_registry %} usage for their own user account. +Anyone can view {% data variables.product.prodname_registry %} usage for their own personal account. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} diff --git a/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md b/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md index 4223600d96..d73faf0e4b 100644 --- a/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md +++ b/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md @@ -30,17 +30,17 @@ shortTitle: Downgrade subscription --- ## Downgrading your {% data variables.product.product_name %} subscription -When you downgrade your user account or organization's subscription, pricing and account feature changes take effect on your next billing date. Changes to your paid user account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features. For more information, see "[How does upgrading or downgrading affect the billing process?](/articles/how-does-upgrading-or-downgrading-affect-the-billing-process)." +When you downgrade your personal account or organization's subscription, pricing and account feature changes take effect on your next billing date. Changes to your paid personal account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features. For more information, see "[How does upgrading or downgrading affect the billing process?](/articles/how-does-upgrading-or-downgrading-affect-the-billing-process)." -## Downgrading your user account's subscription +## Downgrading your personal account's subscription -If you downgrade your user account from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, the account will lose access to advanced code review tools on private repositories. {% data reusables.gated-features.more-info %} +If you downgrade your personal account from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, the account will lose access to advanced code review tools on private repositories. {% data reusables.gated-features.more-info %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} 1. Under "Current plan", use the **Edit** drop-down and click **Downgrade to Free**. ![Downgrade to free button](/assets/images/help/billing/downgrade-to-free.png) -5. Read the information about the features your user account will no longer have access to on your next billing date, then click **I understand. Continue with downgrade**. +5. Read the information about the features your personal account will no longer have access to on your next billing date, then click **I understand. Continue with downgrade**. ![Continue with downgrade button](/assets/images/help/billing/continue-with-downgrade.png) If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, remove or update your DNS records before downgrading from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)." diff --git a/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md b/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md index 3f18df1fd2..4e65433446 100644 --- a/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md +++ b/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md @@ -16,7 +16,7 @@ topics: - User account shortTitle: Billing process --- -Changes to your paid user account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features, such as {% data variables.large_files.product_name_long %} or paid apps purchased in {% data variables.product.prodname_marketplace %}. +Changes to your paid personal account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features, such as {% data variables.large_files.product_name_long %} or paid apps purchased in {% data variables.product.prodname_marketplace %}. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)" and "[About billing on {% data variables.product.prodname_dotcom %}](/articles/about-billing-on-github)." diff --git a/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md b/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md index 7e8c2a9b1d..2d5df42d4c 100644 --- a/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md +++ b/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md @@ -40,7 +40,7 @@ When you upgrade the subscription for an account, the upgrade changes the paid f ## Upgrading your personal account's subscription -You can upgrade your personal account from {% data variables.product.prodname_free_user %} to {% data variables.product.prodname_pro %} to get advanced code review tools on private repositories owned by your user account. Upgrading your personal account does not affect any organizations you may manage or repositories owned by those organizations. {% data reusables.gated-features.more-info %} +You can upgrade your personal account from {% data variables.product.prodname_free_user %} to {% data variables.product.prodname_pro %} to get advanced code review tools on private repositories owned by your personal account. Upgrading your personal account does not affect any organizations you may manage or repositories owned by those organizations. {% data reusables.gated-features.more-info %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} diff --git a/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md b/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md index 8fe8b22212..c2dc70e5d9 100644 --- a/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md +++ b/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md @@ -23,15 +23,15 @@ shortTitle: About {% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.product.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, see [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) on the {% data variables.product.prodname_vs %} website. -To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's user account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. The subscriber can accept the invitation with an existing user account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. +To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's personal account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. To accomplish this, organization owners can invite new members to an organization by email address. The subscriber can accept the invitation with an existing personal account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. For more information about the setup of {% data variables.product.prodname_vss_ghe %}, see "[Setting up {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." ## About licenses for {% data variables.product.prodname_vss_ghe %} -After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a user account on {% data variables.product.prodname_dotcom_the_website %}. If the email address for the user account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.product.prodname_vss_ghe %}. +After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a personal account on {% data variables.product.prodname_dotcom_the_website %}. If the email address for the personal account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.product.prodname_vss_ghe %}. -The total quantity of your licenses for your enterprise on {% data variables.product.prodname_dotcom %} is the sum of any standard {% data variables.product.prodname_enterprise %} licenses and the number of {% data variables.product.prodname_vs %} subscription licenses that include access to {% data variables.product.prodname_dotcom %}. If the user account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the user account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber. +The total quantity of your licenses for your enterprise on {% data variables.product.prodname_dotcom %} is the sum of any standard {% data variables.product.prodname_enterprise %} licenses and the number of {% data variables.product.prodname_vs %} subscription licenses that include access to {% data variables.product.prodname_dotcom %}. If the personal account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the personal account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber. For more information about {% data variables.product.prodname_enterprise %}, see "[{% data variables.product.company_short %}'s products](/github/getting-started-with-github/githubs-products#github-enterprise)." For more information about accounts on {% data variables.product.prodname_dotcom_the_website %}, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/github/getting-started-with-github/types-of-github-accounts)." diff --git a/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md b/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md index cbd795eb3a..15c126e263 100644 --- a/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md +++ b/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md @@ -27,9 +27,9 @@ Before setting up {% data variables.product.prodname_vss_ghe %}, it's important | :- | :- | :- | :- | | **Subscriptions admin** | {% data variables.product.prodname_vs %} subscription | Person who assigns licenses for {% data variables.product.prodname_vs %} subscription | [Overview of admin responsibilities](https://docs.microsoft.com/en-us/visualstudio/subscriptions/admin-responsibilities) in Microsoft Docs | | **Subscriber** | {% data variables.product.prodname_vs %} subscription | Person who uses a license for {% data variables.product.prodname_vs %} subscription | [Visual Studio Subscriptions documentation](https://docs.microsoft.com/en-us/visualstudio/subscriptions/) in Microsoft Docs | -| **Enterprise owner** | {% data variables.product.prodname_dotcom %} | Person who has a user account that's an administrator of an enterprise on {% data variables.product.product_location %} | "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)" | -| **Organization owner** | {% data variables.product.prodname_dotcom %} | Person who has a user account that's an owner of an organization in your team's enterprise on {% data variables.product.product_location %} | "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)" | -| **Enterprise member** | {% data variables.product.prodname_dotcom %} | Person who has a user account that's a member of an enterprise on {% data variables.product.product_location %} | "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-members)" | +| **Enterprise owner** | {% data variables.product.prodname_dotcom %} | Person who has a personal account that's an administrator of an enterprise on {% data variables.product.product_location %} | "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)" | +| **Organization owner** | {% data variables.product.prodname_dotcom %} | Person who has a personal account that's an owner of an organization in your team's enterprise on {% data variables.product.product_location %} | "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)" | +| **Enterprise member** | {% data variables.product.prodname_dotcom %} | Person who has a personal account that's a member of an enterprise on {% data variables.product.product_location %} | "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-members)" | ## Prerequisites @@ -52,14 +52,14 @@ One person may be able to complete the tasks because the person has all of the r 1. If the subscription admin has not disabled email notifications, the subscriber will receive two confirmation emails. For more information, see [{% data variables.product.prodname_vs %} subscriptions with {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/en-us/visualstudio/subscriptions/access-github#what-is-the-visual-studio-subscription-with-github-enterprise-setup-process) in Microsoft Docs. -1. An organization owner must invite the subscriber to the organization on {% data variables.product.product_location %} from step 1. The subscriber can accept the invitation with an existing user account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. After the subscriber joins the organization, the subscriber becomes an enterprise member. For more information, see "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)." +1. An organization owner must invite the subscriber to the organization on {% data variables.product.product_location %} from step 1. The subscriber can accept the invitation with an existing personal account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. After the subscriber joins the organization, the subscriber becomes an enterprise member. For more information, see "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)." {% tip %} **Tips**: - While not required, we recommend that the organization owner sends an invitation to the same email address used for the subscriber's User Primary Name (UPN). When the email address on {% data variables.product.product_location %} matches the subscriber's UPN, you can ensure that another enterprise does not claim the subscriber's license. - - If the subscriber accepts the invitation to the organization with an existing user account on {% data variables.product.product_location %}, we recommend that the subscriber add the email address they use for {% data variables.product.prodname_vs %} to their user account on {% data variables.product.product_location %}. For more information, see "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account)." + - If the subscriber accepts the invitation to the organization with an existing personal account on {% data variables.product.product_location %}, we recommend that the subscriber add the email address they use for {% data variables.product.prodname_vs %} to their personal account on {% data variables.product.product_location %}. For more information, see "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account)." - If the organization owner must invite a large number of subscribers, a script may make the process faster. For more information, see [the sample PowerShell script](https://github.com/github/platform-samples/blob/master/api/powershell/invite_members_to_org.ps1) in the `github/platform-samples` repository. {% endtip %} diff --git a/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md b/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md index b74ec44276..6d56b1a16f 100644 --- a/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md +++ b/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md @@ -14,7 +14,7 @@ topics: - Organizations shortTitle: About organizations --- -To access an organization, each member must sign into their own personal user account. +To access an organization, each member must sign into their own personal account. Organization members can have different roles, such as *owner* or *billing manager*: diff --git a/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md b/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md index dc5cc32ab9..0d796111a2 100644 --- a/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md +++ b/content/billing/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md @@ -28,7 +28,7 @@ Before you start, make sure you know: You will use your personal account to set up the organization. You'll also need to sign in to this account to renew or make changes to your client's subscription in the future. -If you already have a personal {% data variables.product.prodname_dotcom %} user account, skip to [step 2](#step-2-create-the-organization). +If you already have a personal account on {% data variables.product.prodname_dotcom %}, skip to [step 2](#step-2-create-the-organization). 1. Go to the [Join GitHub](https://github.com/join) page. 2. Under "Create your personal account," type your username, email address, and password, then click **Create an account**. diff --git a/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md b/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md index 5d5ad5a63f..fd39437e0b 100644 --- a/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md +++ b/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md @@ -32,7 +32,7 @@ topics: You can enable {% data variables.product.prodname_dependabot_security_updates %} for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." -You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your user account or organization. For more information, see "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)" below. +You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your personal account or organization. For more information, see "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)" below. {% ifversion fpt or ghec %}{% data reusables.dependabot.dependabot-tos %}{% endif %} @@ -60,7 +60,8 @@ If security updates are not enabled for your repository and you don't know why, You can enable or disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository (see below). -You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." + +You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your personal account or organization. For more information, see "[Managing security and analysis settings for your personal account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% data variables.product.prodname_dependabot_security_updates %} require specific repository settings. For more information, see "[Supported repositories](#supported-repositories)." diff --git a/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md b/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md index c2cc636e94..c41d3a59c2 100644 --- a/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md +++ b/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md @@ -49,7 +49,7 @@ You specify how often to check each ecosystem for new versions in the configurat If you've enabled security updates, you'll sometimes see extra pull requests for security updates. These are triggered by a {% data variables.product.prodname_dependabot %} alert for a dependency on your default branch. {% data variables.product.prodname_dependabot %} automatically raises a pull request to update the vulnerable dependency. ## Supported repositories and ecosystems - + You can configure version updates for repositories that contain a dependency manifest or lock file for one of the supported package managers. For some package managers, you can also configure vendoring for dependencies. For more information, see "[Configuration options for the dependabot.yml file](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#vendor)." {% note %} diff --git a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md index f27ec9a63f..5fa2c487be 100644 --- a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md +++ b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md @@ -25,7 +25,7 @@ To give people instructions for reporting security vulnerabilities in your proje {% ifversion not ghae %} -You can create a default security policy for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." +You can create a default security policy for your organization or personal account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} {% tip %} diff --git a/content/code-security/getting-started/securing-your-repository.md b/content/code-security/getting-started/securing-your-repository.md index 1073b342f8..6ee9dc430b 100644 --- a/content/code-security/getting-started/securing-your-repository.md +++ b/content/code-security/getting-started/securing-your-repository.md @@ -75,7 +75,7 @@ For more information, see "[Exploring the dependencies of a repository](/code-se {% data reusables.dependabot.dependabot-alerts-beta %} {% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %} -For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies){% ifversion fpt or ghec %}" and "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}." +For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies){% ifversion fpt or ghec %}" and "[Managing security and analysis settings for your personal account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}." {% endif %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md index 3fd544a83e..39e38d3fd0 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md @@ -72,7 +72,7 @@ For public repositories, the dependents view shows how the repository is used by Repository administrators can enable or disable the dependency graph for private repositories. -You can also enable or disable the dependency graph for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +You can also enable or disable the dependency graph for all repositories owned by your personal account or organization. For more information, see "[Managing security and analysis settings for your personal account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/content/codespaces/codespaces-reference/understanding-billing-for-codespaces.md b/content/codespaces/codespaces-reference/understanding-billing-for-codespaces.md index 2a42315093..4f0af68d08 100644 --- a/content/codespaces/codespaces-reference/understanding-billing-for-codespaces.md +++ b/content/codespaces/codespaces-reference/understanding-billing-for-codespaces.md @@ -20,7 +20,7 @@ This article explains how billing works for your codespaces, and explains how yo ## Getting access to {% data variables.product.prodname_codespaces %} -Your organization's administrator might limit {% data variables.product.prodname_codespaces %} usage to only specific user accounts. To get access, you will need to contact your billing manager. For more information, see "[Managing access and security for your codespaces](/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces)." +Your organization's administrator might limit {% data variables.product.prodname_codespaces %} usage to only specific personal accounts. To get access, you will need to contact your billing manager. For more information, see "[Managing access and security for your codespaces](/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces)." ## How much it costs to use {% data variables.product.prodname_codespaces %} diff --git a/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/content/codespaces/developing-in-codespaces/creating-a-codespace.md index b41b5bb61b..1999ff8218 100644 --- a/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -114,7 +114,7 @@ gh codespace create -r owner/repo -b branch -m ma Replace `owner/repo` with the repository identifier. Replace `branch` with the name of the branch, or the full SHA hash of the commit, that you want to be initially checked out in the codespace. If you use the `-r` flag without the `b` flag, the codespace is created from the default branch. -Replace `machine-type` with a valid identifier for an available machine type. Identifiers are strings such as: `basicLinux32gb` and `standardLinux32gb`. The type of machines that are available depends on the repository, your user account, and your location. If you enter an invalid or unavailable machine type, the available types are shown in the error message. If you omit this flag and more than one machine type is available you will be prompted to choose one from a list. +Replace `machine-type` with a valid identifier for an available machine type. Identifiers are strings such as: `basicLinux32gb` and `standardLinux32gb`. The type of machines that are available depends on the repository, your personal account, and your location. If you enter an invalid or unavailable machine type, the available types are shown in the error message. If you omit this flag and more than one machine type is available you will be prompted to choose one from a list. For more information about this command, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_codespace_create). diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index c1fdb92445..54015b2d79 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -97,7 +97,7 @@ Git is available by default in your codespace and so you can rely on your existi ![Running git status in Codespaces Terminal](/assets/images/help/codespaces/git-status.png) -You can create a codespace from any branch, commit, or pull request in your project, or you can switch to a new or existing branch from within your active codespace. Because {% data variables.product.prodname_codespaces %} is designed to be ephemeral, you can use it as an isolated environment to experiment, check a teammate's pull request, or fix merge conflicts. You can create more than one codespace per repository or even per branch. However, each user account has a limit of 10 codespaces. If you've reached the limit and want to create a new codespace, you must delete a codespace first. +You can create a codespace from any branch, commit, or pull request in your project, or you can switch to a new or existing branch from within your active codespace. Because {% data variables.product.prodname_codespaces %} is designed to be ephemeral, you can use it as an isolated environment to experiment, check a teammate's pull request, or fix merge conflicts. You can create more than one codespace per repository or even per branch. However, each personal account has a limit of 10 codespaces. If you've reached the limit and want to create a new codespace, you must delete a codespace first. {% note %} diff --git a/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md b/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md index a1b2320eda..61573bcf1d 100644 --- a/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md +++ b/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md @@ -22,7 +22,7 @@ shortTitle: Encrypted secrets ## About encrypted secrets for {% data variables.product.prodname_codespaces %} -You can add encrypted secrets to your user account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as encrypted secrets. +You can add encrypted secrets to your personal account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as encrypted secrets. - Personal access tokens to cloud services - Service principals diff --git a/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index 79263ebfd3..e6624666c1 100644 --- a/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -15,11 +15,11 @@ redirect_from: -When you enable access and security for a repository owned by your user account, any codespaces that are created for that repository will have read permissions to all other repositories you own. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository the codespace was opened for or specific repositories. You should only enable access and security for repositories you trust. +When you enable access and security for a repository owned by your personal account, any codespaces that are created for that repository will have read permissions to all other repositories you own. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository the codespace was opened for or specific repositories. You should only enable access and security for repositories you trust. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.codespaces-tab %} -1. Under "Access and security", select the setting you want for your user account. +1. Under "Access and security", select the setting you want for your personal account. ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) 1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md b/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md index a647961657..98962e8c8a 100644 --- a/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md +++ b/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md @@ -16,7 +16,7 @@ topics: ## About security logs for {% data variables.product.prodname_codespaces %} -When you perform an action related to {% data variables.product.prodname_codespaces %} in repositories owned by your user account, you can review the actions in the security log. For information about accessing the log, see "[Reviewing your security log](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)." +When you perform an action related to {% data variables.product.prodname_codespaces %} in repositories owned by your personal account, you can review the actions in the security log. For information about accessing the log, see "[Reviewing your security log](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)." ![security log with Codespaces information](/assets/images/help/settings/codespaces-audit-log.png) diff --git a/content/codespaces/prebuilding-your-codespaces/about-codespaces-prebuilds.md b/content/codespaces/prebuilding-your-codespaces/about-codespaces-prebuilds.md index 1449eb0c34..2ea55b3d1d 100644 --- a/content/codespaces/prebuilding-your-codespaces/about-codespaces-prebuilds.md +++ b/content/codespaces/prebuilding-your-codespaces/about-codespaces-prebuilds.md @@ -16,7 +16,7 @@ product: '{% data reusables.gated-features.codespaces %}' Prebuilding your codespaces allows you to be more productive and access your codespace faster, regardless of the size and complexity of your project. This is because any source code, editor extensions, project dependencies, commands, and configurations have already been downloaded, installed, and applied before you create a codespace for your project. Think of a prebuild as a "ready-to-go" template for a codespace. -Whenever you push changes to your repository, {% data variables.product.prodname_codespaces %} uses {% data variables.product.prodname_actions %} to automatically update your prebuilds. +By default, whenever you push changes to your repository, {% data variables.product.prodname_codespaces %} uses {% data variables.product.prodname_actions %} to automatically update your prebuilds. When prebuilds are available for a particular branch of a repository, and for your region, you'll see the "{% octicon "zap" aria-label="The zap icon" %} Prebuild ready" label in the machine type dialog box that's displayed when you create a codespace and multiple machine types are available. @@ -30,9 +30,9 @@ Use of codespaces created using prebuilds is charged at the same rate as regular ## About pushing changes to prebuild-enabled branches -Each push to a branch that has a prebuild configuration results in a {% data variables.product.prodname_dotcom %}-managed Actions workflow run to update the prebuild template. The prebuild workflow has a concurrency limit of one workflow run at a time for a given prebuild configuration, unless changes were made that affect the dev container configuration for the associated repository. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project)." If a run is already in progress, the workflow run that was queued most recently queued will run next, after the current run completes. +By default, each push to a branch that has a prebuild configuration results in a {% data variables.product.prodname_dotcom %}-managed Actions workflow run to update the prebuild template. The prebuild workflow has a concurrency limit of one workflow run at a time for a given prebuild configuration, unless changes were made that affect the dev container configuration for the associated repository. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/configuring-codespaces-for-your-project)." If a run is already in progress, the workflow run that was queued most recently queued will run next, after the current run completes. -This means that if there are very frequent pushes to your repository, prebuild creation will occur at least as often as it takes to run the prebuild workflow. That is, if your workflow run typically takes one hour to complete, prebuilds will be created for your repository roughly hourly, if the run succeeds, or more often if there were pushes that change the dev container on the branch. +With the prebuild template set to be updated on each push, it means that if there are very frequent pushes to your repository, prebuild template updates will occur at least as often as it takes to run the prebuild workflow. That is, if your workflow run typically takes one hour to complete, prebuilds will be created for your repository roughly hourly, if the run succeeds, or more often if there were pushes that change the dev container configuration on the branch. For example, let's imagine 5 pushes are made, in quick succession, against a branch that has a prebuild configuration. In this situation: diff --git a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 32ed69a742..68895358ed 100644 --- a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -58,6 +58,14 @@ Before you can configure prebuilds for your project the following must be true: {% endnote %} +1. Choose how you want to automatically trigger updates of the prebuild template. + + * **Every push** (the default setting) - With this setting, prebuild configurations will be updated on every push made to the given branch. This will ensure that codespaces generated from a prebuild template always contain the latest codespace configuration, including any recently added or updated dependencies. + * **On configuration change** - With this setting, prebuild configurations will be updated every time associated configuration files for a given repo and branch are updated. This ensures that changes to the dev container configuration files for the repository are used when a codespace is generated from a prebuild template. The Actions workflow that updates the prebuild template will run less often, so this option will use fewer Actions minutes. However, this option will not guarantee that codespaces always include recently added or updated dependencies, so these may have to be added or updated manually after a codespace has been created. + * **Scheduled** - With this setting, you can have your prebuild configurations update on a custom schedule that's defined by you. This can reduce consumption of Actions minutes, and reduce the amount of time during which prebuilds are unavailable because they are being updated. However, with this option, codespaces may be created that do not use the latest dev container configuration changes. + + ![The prebuild trigger options](/assets/images/help/codespaces/prebuilds-triggers.png) + 1. Click **Create**. The prebuild configuration is listed on the {% data variables.product.prodname_codespaces %} page of your repository settings. A {% data variables.product.prodname_actions %} workflow is queued and then run to create prebuild templates, based on the branch you selected, in the regions you specified. diff --git a/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md b/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md index 27e2c823c0..229db25ffc 100644 --- a/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md +++ b/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md @@ -16,14 +16,18 @@ miniTocMaxHeadingLevel: 3 ## Checking, changing, and deleting your prebuild configurations -The prebuilds that you configure are created and updated using a {% data variables.product.prodname_actions %} workflow, managed by the {% data variables.product.prodname_codespaces %} service. +The prebuilds that you configure for a repository are created and updated using a {% data variables.product.prodname_actions %} workflow, managed by the {% data variables.product.prodname_codespaces %} service. -The workflow is triggered by these events: +Depending on the settings in a prebuild configuration, the workflow to update the prebuild template may be triggered by these events: * Creating or updating the prebuild configuration * Pushing a commit or a pull request to a branch that's configured to have prebuilds +* Changing any of the dev container configuration files +* A schedule that you've defined in the prebuild configuration * Manually triggering the workflow +The settings in the prebuild configuration determine which events automatically trigger an update of the prebuild template. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)." + People with admin access to a repository can check the progress of prebuilds, edit, and delete prebuild configurations. ### Viewing the progress of prebuilds diff --git a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md index 16a6369822..dfbd2ddd5c 100644 --- a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md +++ b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md @@ -42,15 +42,15 @@ cat /workspaces/.codespaces/shared/environment-variables.json | jq '.ACTION_NAME You may notice that sometimes, when you create a new codespace from a prebuild-enabled branch, the "{% octicon "zap" aria-label="The zap icon" %} Prebuild Ready" label is not displayed in the dialog box for choosing a machine type. This means that prebuilds are not currently available. -Each time you push to a prebuild-enabled branch, the prebuild template is updated. If the push involves a change to the dev container then, while the update is in progress, the "{% octicon "zap" aria-label="The zap icon" %} Prebuild Ready" label is removed from the machine types dialog box. During this time you can still create codespaces without a prebuild template. +By default, each time you push to a prebuild-enabled branch, the prebuild template is updated. If the push involves a change to the dev container then, while the update is in progress, the "{% octicon "zap" aria-label="The zap icon" %} Prebuild Ready" label is removed from the machine types dialog box. During this time you can still create codespaces without a prebuild template. If required, you can reduce the occasions on which prebuilds are unavailable for a repository by setting the prebuild template to be updated only when you make a change to your dev container configuration files, or only on a custom schedule. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)." -If your branch is not specifically enabled for prebuilds it may still benefit from prebuilds if it was branched from a prebuild-enabled branch. However, if the dev container is changed on your branch, so that it's not the same as the dev container on the base branch, prebuilds will no longer be available on your branch. +If your branch is not specifically enabled for prebuilds it may still benefit from prebuilds if it was branched from a prebuild-enabled branch. However, if the dev container configuration is changed on your branch, so that it's not the same as the dev container configuration on the base branch, prebuilds will no longer be available on your branch. Here are things to check if the "{% octicon "zap" aria-label="The zap icon" %} Prebuild Ready" label is not displayed for a particular branch: * Confirm that a prebuild configuration exists for this branch. If you’re not a repository administrator, you'll need to reach out to one to confirm this. * Confirm that the prebuild configuration includes your region. -* Check whether a change to the dev container configuration was pushed to the prebuild-enabled branch recently. If so, you will have to wait until the prebuild workflow run for this push completes before prebuilds are available again. +* Check whether a change to the dev container configuration was pushed to the prebuild-enabled branch recently. If so, you will typically have to wait until the prebuild workflow run for this push completes before prebuilds are available again. * If no configuration changes were recently made, go to the **Actions** tab of your repository, click **{% octicon "codespaces" aria-label="The Codespaces icon" %} {% data variables.product.prodname_codespaces %} Prebuilds** in the workflows list, and check that prebuild workflow runs for the branch are succeeding. If latest runs of a workflow failed, and one or more of these failed runs contained changes to the dev container, then there will be no available prebuilds for the associated branch. ## Further reading diff --git a/content/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account.md b/content/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account.md index ac9f0f370a..79394cfd3f 100644 --- a/content/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account.md +++ b/content/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account.md @@ -1,10 +1,10 @@ --- title: Limiting interactions for your user account -intro: You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your user account. +intro: You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your personal account. versions: fpt: '*' ghec: '*' -permissions: Anyone can limit interactions for their own user account. +permissions: Anyone can limit interactions for their own personal account. redirect_from: - /github/building-a-strong-community/limiting-interactions-for-your-user-account topics: @@ -14,7 +14,7 @@ shortTitle: Limit interactions in account ## About temporary interaction limits -Limiting interactions for your user account enables temporary interaction limits for all public repositories owned by your user account. {% data reusables.community.interaction-limits-restrictions %} +Limiting interactions for your personal account enables temporary interaction limits for all public repositories owned by your personal account. {% data reusables.community.interaction-limits-restrictions %} {% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your public repositories. @@ -24,7 +24,7 @@ When you enable user-wide activity limitations, you can't enable or disable inte You can also block users. For more information, see "[Blocking a user from your personal account](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account)." -## Limiting interactions for your user account +## Limiting interactions for your personal account {% data reusables.user-settings.access_settings %} 1. In the "Access" section of the sidebar, select **{% octicon "report" aria-label="The report icon" %} Moderation** then click **Interaction limits**. diff --git a/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md b/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md index e23d0a7e19..57e36e46c3 100644 --- a/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md +++ b/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization.md @@ -43,6 +43,6 @@ Organization owners and moderators can also block users for a specific amount of ## Further reading - "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" - "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)" -- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)" +- "[Permission levels for a personal account repository](/articles/permission-levels-for-a-user-account-repository)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" - "[Managing moderators in your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-moderators-in-your-organization)" \ No newline at end of file diff --git a/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md b/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md index 4377c81757..b7f1a32c09 100644 --- a/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md +++ b/content/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository.md @@ -22,7 +22,7 @@ shortTitle: Limit interactions in repo {% data reusables.community.types-of-interaction-limits %} -You can also enable activity limitations on all repositories owned by your user account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your user account](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)." +You can also enable activity limitations on all repositories owned by your personal account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your personal account](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)." ## Limiting interactions in your repository @@ -35,6 +35,6 @@ You can also enable activity limitations on all repositories owned by your user ## Further reading - "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)" - "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)" -- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)" +- "[Permission levels for a personal account repository](/articles/permission-levels-for-a-user-account-repository)" - "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" - "[Managing moderators in your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-moderators-in-your-organization)" \ No newline at end of file diff --git a/content/communities/moderating-comments-and-conversations/locking-conversations.md b/content/communities/moderating-comments-and-conversations/locking-conversations.md index 139698140a..075d1d08b7 100644 --- a/content/communities/moderating-comments-and-conversations/locking-conversations.md +++ b/content/communities/moderating-comments-and-conversations/locking-conversations.md @@ -19,7 +19,7 @@ Locking a conversation creates a timeline event that is visible to anyone with r ![Anonymized timeline event for a locked conversation](/assets/images/help/issues/anonymized-timeline-entry-for-locked-conversation.png) -While a conversation is locked, only [people with write access](/articles/repository-permission-levels-for-an-organization/) and [repository owners and collaborators](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-user-account) can add, hide, and delete comments. +While a conversation is locked, only [people with write access](/articles/repository-permission-levels-for-an-organization/) and [repository owners and collaborators](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-personal-account) can add, hide, and delete comments. To search for locked conversations in a repository that is not archived, you can use the search qualifiers `is:locked` and `archived:false`. Conversations are automatically locked in archived repositories. For more information, see "[Searching issues and pull requests](/search-github/searching-on-github/searching-issues-and-pull-requests#search-based-on-whether-a-conversation-is-locked)." diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md index 039e74f09d..d28ca05c98 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md @@ -21,7 +21,7 @@ Before adopting a code of conduct for your project: You can add a code of conduct to your project by using a template or manually creating a custom code of conduct. Your code of conduct will be available either way, but "Code of conduct" will only be marked as complete in your repository's community profile if you use a template. If you use a code of conduct written by another person or organization, be sure to follow any attribution guidelines from the source. For more information about community profiles, see "[About community profiles for public repositories](//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." -You can create a default code of conduct for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." +You can create a default code of conduct for your organization or personal account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." ## Adding a code of conduct using a template diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md index 9c2be605cd..0a84290ba4 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md @@ -19,7 +19,7 @@ To direct people to specific support resources, you can add a SUPPORT file to yo {% ifversion fpt or ghes or ghec %} -You can create default support resources for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." +You can create default support resources for your organization or personal account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 8af25cd06b..7aa12315fe 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -29,7 +29,7 @@ Default files are not included in clones, packages, or downloads of individual r ## Supported file types -You can create defaults in your organization{% ifversion fpt or ghes or ghec %} or user account{% endif %} for the following community health files: +You can create defaults in your organization{% ifversion fpt or ghes or ghec %} or personal account{% endif %} for the following community health files: Community health file | Description --- | ---{% ifversion fpt or ghec %} @@ -45,7 +45,7 @@ You cannot create a default license file. License files must be added to individ ## Creating a repository for default files {% data reusables.repositories.create_new %} -2. Use the **Owner** drop-down menu, and select the organization{% ifversion fpt or ghes or ghec %} or user account{% endif %} you want to create default files for. +2. Use the **Owner** drop-down menu, and select the organization{% ifversion fpt or ghes or ghec %} or personal account{% endif %} you want to create default files for. ![Owner drop-down menu](/assets/images/help/repository/create-repository-owner.png) 3. Type **.github** as the name for your repository, and an optional description. ![Create repository field](/assets/images/help/repository/default-file-repository-name.png) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index c5bb1df6a6..63d9b8c36f 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -27,7 +27,7 @@ For both owners and contributors, contribution guidelines save time and hassle c {% ifversion fpt or ghes or ghec %} -You can create default contribution guidelines for your organization{% ifversion fpt or ghes or ghec %} or user account{% endif %}. For more information, see "[Creating a default community health file](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." +You can create default contribution guidelines for your organization{% ifversion fpt or ghes or ghec %} or personal account{% endif %}. For more information, see "[Creating a default community health file](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md index d4e7edbcba..f7d69d6de4 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md @@ -18,7 +18,7 @@ After you create issue and pull request templates in your repository, contributo {% ifversion fpt or ghes or ghec %} -You can create default issue and pull request templates for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." +You can create default issue and pull request templates for your organization or personal account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md index 49d32339eb..de8907e0f6 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md @@ -20,7 +20,7 @@ You can create a *PULL_REQUEST_TEMPLATE/* subdirectory in any of the supported f {% ifversion fpt or ghes or ghec %} -You can create default pull request templates for your organization{% ifversion fpt or ghes or ghec %} or user account{% endif %}. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." +You can create default pull request templates for your organization{% ifversion fpt or ghes or ghec %} or personal account{% endif %}. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md index 4b99a9e2f9..c0382ad5a9 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md @@ -183,7 +183,7 @@ body: attributes: label: Bug prevalence description: "How often do you or others encounter this bug?" - placeholder: "Example: Whenever I visit the user account page (1-2 times a week)" + placeholder: "Example: Whenever I visit the personal account page (1-2 times a week)" validations: required: true ``` diff --git a/content/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md b/content/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md index 42d6f8bf47..6a1c839f23 100644 --- a/content/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md +++ b/content/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md @@ -45,7 +45,7 @@ Follow these steps to implement the GitHub App Manifest flow: ### 1. You redirect people to GitHub to create a new GitHub App -To redirect people to create a new GitHub App, [provide a link](#examples) for them to click that sends a `POST` request to `https://github.com/settings/apps/new` for a user account or `https://github.com/organizations/ORGANIZATION/settings/apps/new` for an organization account, replacing `ORGANIZATION` with the name of the organization account where the app will be created. +To redirect people to create a new GitHub App, [provide a link](#examples) for them to click that sends a `POST` request to `https://github.com/settings/apps/new` for a personal account or `https://github.com/organizations/ORGANIZATION/settings/apps/new` for an organization account, replacing `ORGANIZATION` with the name of the organization account where the app will be created. You must include the [GitHub App Manifest parameters](#github-app-manifest-parameters) as a JSON-encoded string in a parameter called `manifest`. You can also include a `state` [parameter](#parameters) for additional security. @@ -82,7 +82,7 @@ Name | Type | Description #### Examples -This example uses a form on a web page with a button that triggers the `POST` request for a user account: +This example uses a form on a web page with a button that triggers the `POST` request for a personal account: ```html
diff --git a/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md b/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md index 2f2596db90..2015f794aa 100644 --- a/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md +++ b/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md @@ -17,7 +17,7 @@ shortTitle: App creation query parameters You can add query parameters to these URLs to preselect the configuration of a {% data variables.product.prodname_github_app %} on a personal or organization account: -* **User account:** `{% data variables.product.oauth_host_code %}/settings/apps/new` +* **Personal account:** `{% data variables.product.oauth_host_code %}/settings/apps/new` * **Organization account:** `{% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new` The person creating the app can edit the preselected values from the {% data variables.product.prodname_github_app %} registration page, before submitting the app. If you do not include required parameters in the URL query string, like `name`, the person creating the app will need to input a value before submitting the app. diff --git a/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md b/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md index 1c874a6fcb..1dff469f06 100644 --- a/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md +++ b/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md @@ -148,7 +148,7 @@ If a user revokes their authorization of a GitHub App, the app will receive the ## User-level permissions -You can add user-level permissions to your GitHub App to access user resources, such as user emails, that are granted by individual users as part of the [user authorization flow](#identifying-users-on-your-site). User-level permissions differ from [repository and organization-level permissions](/rest/reference/permissions-required-for-github-apps), which are granted at the time of installation on an organization or user account. +You can add user-level permissions to your GitHub App to access user resources, such as user emails, that are granted by individual users as part of the [user authorization flow](#identifying-users-on-your-site). User-level permissions differ from [repository and organization-level permissions](/rest/reference/permissions-required-for-github-apps), which are granted at the time of installation on an organization or personal account. You can select user-level permissions from within your GitHub App's settings in the **User permissions** section of the **Permissions & webhooks** page. For more information on selecting permissions, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)." diff --git a/content/developers/apps/getting-started-with-apps/about-apps.md b/content/developers/apps/getting-started-with-apps/about-apps.md index d60e0d8400..eec4a49f78 100644 --- a/content/developers/apps/getting-started-with-apps/about-apps.md +++ b/content/developers/apps/getting-started-with-apps/about-apps.md @@ -27,7 +27,7 @@ For a walkthrough of the process of building a {% data variables.product.prodnam {% data variables.product.prodname_github_apps %} are first-class actors within GitHub. A {% data variables.product.prodname_github_app %} acts on its own behalf, taking actions via the API directly using its own identity, which means you don't need to maintain a bot or service account as a separate user. -{% data variables.product.prodname_github_apps %} can be installed directly on organizations and user accounts and granted access to specific repositories. They come with built-in webhooks and narrow, specific permissions. When you set up your {% data variables.product.prodname_github_app %}, you can select the repositories you want it to access. For example, you can set up an app called `MyGitHub` that writes issues in the `octocat` repository and _only_ the `octocat` repository. To install a {% data variables.product.prodname_github_app %}, you must be an organization owner or have admin permissions in a repository. +{% data variables.product.prodname_github_apps %} can be installed directly on organizations and personal accounts and granted access to specific repositories. They come with built-in webhooks and narrow, specific permissions. When you set up your {% data variables.product.prodname_github_app %}, you can select the repositories you want it to access. For example, you can set up an app called `MyGitHub` that writes issues in the `octocat` repository and _only_ the `octocat` repository. To install a {% data variables.product.prodname_github_app %}, you must be an organization owner or have admin permissions in a repository. {% data reusables.apps.app_manager_role %} @@ -84,7 +84,7 @@ Keep these ideas in mind when using personal access tokens: * You can perform one-off cURL requests. * You can run personal scripts. * Don't set up a script for your whole team or company to use. -* Don't set up a shared user account to act as a bot user.{% ifversion fpt or ghes > 3.2 or ghae-issue-4374 or ghec %} +* Don't set up a shared personal account to act as a bot user.{% ifversion fpt or ghes > 3.2 or ghae-issue-4374 or ghec %} * Do set an expiration for your personal access tokens, to help keep your information secure.{% endif %} ## Determining which integration to build diff --git a/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md b/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md index 6006aba79c..bb591962c4 100644 --- a/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md +++ b/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md @@ -102,7 +102,7 @@ Unlike OAuth apps, GitHub Apps have targeted permissions that allow them to requ ## Machine vs. bot accounts -Machine user accounts are OAuth-based user accounts that segregate automated systems using GitHub's user system. +Machine user accounts are OAuth-based personal accounts that segregate automated systems using GitHub's user system. Bot accounts are specific to GitHub Apps and are built into every GitHub App. diff --git a/content/developers/apps/managing-github-apps/installing-github-apps.md b/content/developers/apps/managing-github-apps/installing-github-apps.md index ec1cd9e4a8..ec7dd57188 100644 --- a/content/developers/apps/managing-github-apps/installing-github-apps.md +++ b/content/developers/apps/managing-github-apps/installing-github-apps.md @@ -24,7 +24,7 @@ Once you create a private GitHub App, you can install it on one of your org or u 1. From the [GitHub Apps settings page](https://github.com/settings/apps), select your app. 2. In the left sidebar, click **Install App**. -3. Click **Install** next to the organization or user account containing the correct repository. +3. Click **Install** next to the organization or personal account containing the correct repository. 4. Install the app on all repositories or select repositories. ![App installation permissions](/assets/images/install_permissions.png) 5. Once installed, you will see configuration options for the app on your selected account. You can make changes here, or repeat the previous steps to install the app on another account. diff --git a/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md b/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md index 2955f8e8c0..491cea03f2 100644 --- a/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md +++ b/content/developers/apps/managing-github-apps/making-a-github-app-public-or-private.md @@ -25,7 +25,7 @@ Public installation flows have a landing page to enable other people besides the ## Private installation flow -Private installation flows allow only the owner of a GitHub App to install it. Limited information about the GitHub App will still exist on a public page, but the **Install** button will only be available to organization administrators or the user account if the GitHub App is owned by an individual account. {% ifversion fpt or ghes > 3.1 or ghae or ghec %}Private {% else %}Private (also known as internal){% endif %} GitHub Apps can only be installed on the user or organization account of the owner. +Private installation flows allow only the owner of a GitHub App to install it. Limited information about the GitHub App will still exist on a public page, but the **Install** button will only be available to organization administrators or the personal account if the GitHub App is owned by an individual account. {% ifversion fpt or ghes > 3.1 or ghae or ghec %}Private {% else %}Private (also known as internal){% endif %} GitHub Apps can only be installed on the user or organization account of the owner. ## Changing who can install your GitHub App diff --git a/content/developers/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization.md b/content/developers/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization.md index d7dc0c4266..1e12274398 100644 --- a/content/developers/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization.md +++ b/content/developers/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization.md @@ -14,7 +14,7 @@ Publisher verification ensures that {% data variables.product.prodname_dotcom %} Once your organization has been verified, you can publish paid plans for your app. For information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)." -To offer paid plans for your app, the app must be owned by an organization and you must have owner permissions in the organization. If your app is currently owned by a user account, you'll need to transfer the ownership of the app to an organization. For more information, see "[Transferring ownership of a GitHub App](/developers/apps/transferring-ownership-of-a-github-app)" or "[Transferring ownership of an OAuth App](/developers/apps/transferring-ownership-of-an-oauth-app)." +To offer paid plans for your app, the app must be owned by an organization and you must have owner permissions in the organization. If your app is currently owned by a personal account, you'll need to transfer the ownership of the app to an organization. For more information, see "[Transferring ownership of a GitHub App](/developers/apps/transferring-ownership-of-a-github-app)" or "[Transferring ownership of an OAuth App](/developers/apps/transferring-ownership-of-an-oauth-app)." ## Requesting publisher verification diff --git a/content/developers/webhooks-and-events/events/github-event-types.md b/content/developers/webhooks-and-events/events/github-event-types.md index e231c58afb..1f69c168a8 100644 --- a/content/developers/webhooks-and-events/events/github-event-types.md +++ b/content/developers/webhooks-and-events/events/github-event-types.md @@ -35,7 +35,7 @@ The event objects returned from the Events API endpoints have the same structure | `actor.avatar_url` | The URL of the actor's profile image. | | `repo` | The repository object where the event occurred. | | `repo.id` | The unique identifier of the repository. | -| `repo.name` | The name of the repository, which includes the owner and repository name. For example, `octocat/hello-world` is the name of the `hello-world` repository owned by the `octocat` user account. | +| `repo.name` | The name of the repository, which includes the owner and repository name. For example, `octocat/hello-world` is the name of the `hello-world` repository owned by the `octocat` personal account. | | `repo.url` | The REST API URL used to retrieve the repository object, which includes additional repository information. | | `payload` | The event payload object is unique to the event type. See the event type below for the event API `payload` object. | diff --git a/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md b/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md index 1470bba1bc..848ae45182 100644 --- a/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md +++ b/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md @@ -9,19 +9,34 @@ versions: ## About {% data variables.product.prodname_discussions %} -With {% data variables.product.prodname_discussions %}, the community for your project can create and participate in conversations within the project's repository. Discussions empower a project's maintainers, contributors, and visitors to gather and accomplish the following goals in a central location, without third-party tools. +With {% data variables.product.prodname_discussions %}, the community for your project can create and participate in conversations within the project's repository or organization. Discussions empower a project's maintainers, contributors, and visitors to gather and accomplish the following goals in a central location, without third-party tools. - Share announcements and information, gather feedback, plan, and make decisions - Ask questions, discuss and answer the questions, and mark the discussions as answered +- Create polls to gauge community opinion - Foster an inviting atmosphere for visitors and contributors to discuss goals, development, administration, and workflows ![Discussions tab for a repository](/assets/images/help/discussions/hero.png) +You might use repository discussions to discuss topics that are specific to the repository. If your project spans multiple repositories, you might use organization discussions to discuss topics that aren't specific to a single repository in your organization. + You don't need to close a discussion like you close an issue or a pull request. -If a repository administrator or project maintainer enables {% data variables.product.prodname_discussions %} for a repository, anyone who visits the repository can create and participate in discussions for the repository. Repository administrators and project maintainers can manage discussions and discussion categories in a repository, and pin discussions to increase the visibility of the discussion. Moderators and collaborators can mark comments as answers, lock discussions, and convert issues to discussions. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +If a repository administrator or project maintainer enables {% data variables.product.prodname_discussions %} for a repository, anyone who visits the repository can create and participate in discussions for the repository. If an organization owner enables {% data variables.product.prodname_discussions %} for an organization, anyone who can view the source repository can create an organization discussion. -For more information about management of discussions for your repository, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)." +Repository administrators and project maintainers can manage discussions and discussion categories in a repository, and pin discussions to increase the visibility of the discussion. Moderators and collaborators can mark comments as answers, lock discussions, and convert issues to discussions. Similarly, for organization discussions, the role of a user in the source repository determines how a user can interact with organization discussions. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." + +For more information about management of discussions, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions)." + +## About polls + +You can create polls in the polls category to gauge interest in new ideas and project direction. Anyone with read access to your repository can create polls, vote in polls, and view their results. Logged out users can view the results of polls in public repositories. + +Polls require a question and at least two options. You can add a maximum of eight options and the options can contain a maximum of 128 characters. + +Voters cannot change their vote. Editing a poll will reset any votes that have already been cast. + +For more information on creating polls, see "[Creating a poll](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-poll)." ## About discussion organization @@ -33,7 +48,7 @@ For discussions with a question/answer format, an individual comment within the {% data reusables.discussions.about-announcement-format %} -For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." +For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)." {% data reusables.discussions.you-can-label-discussions %} @@ -43,9 +58,9 @@ As a community member or maintainer, start a discussion to ask a question or dis Participate in a discussion to ask and answer questions, provide feedback, and engage with the project's community. For more information, see "[Participating in a discussion](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion)." -You can spotlight discussions that contain important, useful, or exemplary conversations among members in the community. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#pinning-a-discussion)." +You can spotlight discussions that contain important, useful, or exemplary conversations among members in the community. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#pinning-a-discussion)." -{% data reusables.discussions.you-can-convert-an-issue %} For more information, see "[Moderating discussions in your repository](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)." +{% data reusables.discussions.you-can-convert-an-issue %} For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)." ## Sharing feedback diff --git a/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md b/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md index dbb1b2236e..8faf74df26 100644 --- a/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md +++ b/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md @@ -2,7 +2,7 @@ title: Collaborating with maintainers using discussions shortTitle: Collaborating with maintainers intro: 'You can contribute to the goals, plans, health, and community for a project on {% data variables.product.product_name %} by communicating with the maintainers of the project in a discussion.' -permissions: 'People with read access to a repository can start and participate in discussions in the repository. {% data reusables.enterprise-accounts.emu-permission-interact %}' +permissions: 'People with read access to a repository can start and participate in discussions and polls in the repository. People with read access to the source repository for organization discussions can start and participate in discussions and polls in the organization. {% data reusables.enterprise-accounts.emu-permission-interact %}' versions: fpt: '*' ghec: '*' @@ -11,11 +11,11 @@ versions: ## About collaboration with maintainers using {% data variables.product.prodname_discussions %} -{% data reusables.discussions.about-discussions %} If you use or contribute to a project, you can start a discussion to make suggestions and engage with maintainers and community members about your plans, questions, ideas, and feedback. For more information, see "[‎About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." +{% data reusables.discussions.about-discussions %} If you use or contribute to a project, you can start a discussion to make suggestions and engage with maintainers and community members about your plans, questions, ideas, and feedback. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." {% data reusables.discussions.about-categories-and-formats %} {% data reusables.discussions.about-announcement-format %} -Repository administrators and project maintainers can delete a discussion. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion)." +Repository administrators and project maintainers can delete a discussion in that repository. Similarly, administrators and maintainers of the source repository for an organization's discussions can delete a discussion in that organization. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#deleting-a-discussion)." {% data reusables.discussions.github-recognizes-members %} These members appear in a list of the most helpful contributors to the project's discussions. As your project grows, you can grant higher access permissions to active members of your community. For more information, see "[Granting higher permissions to top contributors](/discussions/guides/granting-higher-permissions-to-top-contributors)" @@ -25,17 +25,23 @@ For more information about participation in discussions, see "[Participating in ## Prerequisites -To collaborate with maintainers in discussions, a repository administrator or project maintainer must enable {% data variables.product.prodname_discussions %} for the repository. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for a repository](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)." +To collaborate with maintainers in repository discussions, a repository administrator or project maintainer must enable {% data variables.product.prodname_discussions %} for the repository. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for a repository](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)." + +To collaborate with maintainers in organization discussions, {% data variables.product.prodname_discussions %} must be enabled for the organization. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." ## Starting a discussion {% data reusables.discussions.starting-a-discussion %} +## Starting a poll + +{% data reusables.discussions.starting-a-poll %} + ## Filtering the list of discussions -You can search for discussions and filter the list of discussions in a repository. For more information, see "[Searching discussions](/search-github/searching-on-github/searching-discussions)." +You can search for discussions and filter the list of discussions in a repository or organization. For more information, see "[Searching discussions](/search-github/searching-on-github/searching-discussions)." -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} 1. In the **Search all discussions** field, type a search query. Optionally, to the right of the search field, click a button to further filter the results. ![Search bar and buttons for filtering discussions](/assets/images/help/discussions/search-and-filter-controls.png) @@ -44,7 +50,7 @@ You can search for discussions and filter the list of discussions in a repositor ## Converting an issue to a discussion -{% data reusables.discussions.you-can-convert-an-issue %} For more information, see "[Moderating discussions in your repository](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion#converting-an-issue-to-a-discussion)." +{% data reusables.discussions.you-can-convert-an-issue %} For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)." ## Further reading diff --git a/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md b/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md index 42b02a1dca..82e311ac13 100644 --- a/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md +++ b/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md @@ -1,7 +1,7 @@ --- title: Participating in a discussion intro: 'You can converse with the community and maintainers in a forum within the repository for a project on {% data variables.product.product_name %}.' -permissions: 'People with read access to a repository can participate in discussions in the repository. {% data reusables.enterprise-accounts.emu-permission-interact %}' +permissions: 'People with read access to a repository can participate in discussions and polls in the repository. People with read access to the source repository for organization discussions can participate in discussions and polls in that organization. {% data reusables.enterprise-accounts.emu-permission-interact %}' versions: fpt: '*' ghec: '*' @@ -13,20 +13,25 @@ shortTitle: Participate in discussion {% data reusables.discussions.about-discussions %} For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." -In addition to starting or viewing a discussion, you can comment in response to the original comment from the author of the discussion. You can also create a comment thread by replying to an individual comment that another community member made within the discussion, and react to comments with emoji. +In addition to starting or viewing discussions and polls, you can comment in response to the original comment from the author of the discussion. You can also create a comment thread by replying to an individual comment that another community member made within the discussion, and react to comments with emoji. You can block users and report disruptive content to maintain a safe and pleasant environment for yourself on {% data variables.product.product_name %}. For more information, see "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)." ## Prerequisites -{% data variables.product.prodname_discussions %} must be enabled for the repository for you to participate in a discussion in the repository. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for a repository](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)." +{% data variables.product.prodname_discussions %} must be enabled for the repository or organization for you to participate in a discussion in the repository or organization. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for a repository](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)" and "[Enabling or disabling GitHub Discussions for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." ## Creating a discussion {% data reusables.discussions.starting-a-discussion %} +## Creating a poll + +{% data reusables.discussions.starting-a-poll %} + ## Marking a comment as an answer Discussion authors and users with the triage role or greater for a repository can mark a comment as the answer to a discussion in the repository. +Similarly, discussion authors and users with the triage role or greater for the source repository for organization discussions can mark a comment as the answer to a discussion in the organization. {% data reusables.discussions.marking-a-comment-as-an-answer %} diff --git a/content/discussions/guides/best-practices-for-community-conversations-on-github.md b/content/discussions/guides/best-practices-for-community-conversations-on-github.md index 5a34df867d..8a88856db6 100644 --- a/content/discussions/guides/best-practices-for-community-conversations-on-github.md +++ b/content/discussions/guides/best-practices-for-community-conversations-on-github.md @@ -10,11 +10,11 @@ versions: ## Community conversations in {% data variables.product.prodname_discussions %} -Since {% data variables.product.prodname_discussions %} is an open forum, there is an opportunity to bring non-code collaboration into a project's repository and gather diverse feedback and ideas more quickly. You can help drive a productive conversation by: +Since {% data variables.product.prodname_discussions %} is an open forum, there is an opportunity to bring non-code collaboration into a project's repository or organization and gather diverse feedback and ideas more quickly. You can help drive a productive conversation in a number of ways. - Asking pointed questions and follow-up questions to garner specific feedback -- Capture a diverse experience and distill it down to main points -- Open an issue to take action based on the conversation, where applicable +- Capturing a diverse experience and distilling it down to main points +- Opening an issue to take action based on the conversation, where applicable For more information about opening an issue and cross-referencing a discussion, see "[Opening an issue from a comment](/github/managing-your-work-on-github/opening-an-issue-from-a-comment)." @@ -22,18 +22,19 @@ For more information about opening an issue and cross-referencing a discussion, You can create and participate in discussions, issues, and pull requests, depending on the type of conversation you'd like to have. -You can use {% data variables.product.prodname_discussions %} to discuss big picture ideas, brainstorm, and spike out a project's specific details before committing it to an issue, which can then be scoped. {% data variables.product.prodname_discussions %} is useful for teams if: +You can use {% data variables.product.prodname_discussions %} to discuss big picture ideas, brainstorm, and develop a project's specific details before committing it to an issue, which can then be scoped. {% data variables.product.prodname_discussions %} is useful for teams if: - You are in the discovery phase of a project and are still learning which direction your team wants to go in - You want to collect feedback from a wider community about a project - You want to keep bug fixes, feature requests, and general conversations separate +- You want to measure interest in new ideas and gauge community opinion using polls + +You might use repository discussions to discuss topics that are specific to the repository. If your project spans multiple repositories, you might use organization discussions to discuss topics that aren't specific to a single repository in your organization. Issues are useful for discussing specific details of a project such as bug reports and planned improvements. For more information, see "[About issues](/articles/about-issues)." Pull requests allow you to comment directly on proposed changes. For more information, see "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" and "[Commenting on a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." -{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." - ## Following contributing guidelines -Before you open a discussion, check to see if the repository has contributing guidelines. The CONTRIBUTING file includes information about how the repository maintainer would like you to contribute ideas to the project. +Before you open a discussion in an open source repository, check to see if the repository has contributing guidelines. The CONTRIBUTING file includes information about how the repository maintainer would like you to contribute ideas to the project. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." diff --git a/content/discussions/guides/finding-discussions-across-multiple-repositories.md b/content/discussions/guides/finding-your-discussions.md similarity index 87% rename from content/discussions/guides/finding-discussions-across-multiple-repositories.md rename to content/discussions/guides/finding-your-discussions.md index 19488b1f87..95d4edfba3 100644 --- a/content/discussions/guides/finding-discussions-across-multiple-repositories.md +++ b/content/discussions/guides/finding-your-discussions.md @@ -1,10 +1,12 @@ --- -title: Finding discussions across multiple repositories -intro: You can easily access every discussion you've created or participated in across multiple repositories. +title: Finding your discussions +intro: You can easily access every discussion you've created or participated in. versions: fpt: '*' ghec: '*' shortTitle: Find discussions +redirect_from: + - /discussions/guides/finding-discussions-across-multiple-repositories --- diff --git a/content/discussions/guides/granting-higher-permissions-to-top-contributors.md b/content/discussions/guides/granting-higher-permissions-to-top-contributors.md index 9bb4239fba..ca18f46d67 100644 --- a/content/discussions/guides/granting-higher-permissions-to-top-contributors.md +++ b/content/discussions/guides/granting-higher-permissions-to-top-contributors.md @@ -14,13 +14,13 @@ The most helpful contributors for the past 30 days are highlighted on the {% dat ## Step 1: Audit your {% data variables.product.prodname_discussions %} top contributors -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} -1. Compare the list of contributors with their access permissions to see who qualifies to moderate the discussion. +1. Compare the list of contributors with their access permissions to the repository or, for organization discussions, to the source repository to see who qualifies to moderate the discussion. ## Step 2: Review permission levels for {% data variables.product.prodname_discussions %} -People with triage permissions for a repository can help moderate a project's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)." +People with triage permissions for a repository can help moderate a repository's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. Similarly, people with triage permissions for the source repository for organization discussions can moderate the organization's discussions. For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)." For more information about repository permission levels and {% data variables.product.prodname_discussions %}, see "[Repository permissions levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." diff --git a/content/discussions/guides/index.md b/content/discussions/guides/index.md index fdec249403..cdf7b5f101 100644 --- a/content/discussions/guides/index.md +++ b/content/discussions/guides/index.md @@ -7,7 +7,7 @@ versions: ghec: '*' children: - /best-practices-for-community-conversations-on-github - - /finding-discussions-across-multiple-repositories + - /finding-your-discussions - /granting-higher-permissions-to-top-contributors --- diff --git a/content/discussions/index.md b/content/discussions/index.md index d76f770704..feb1df7a42 100644 --- a/content/discussions/index.md +++ b/content/discussions/index.md @@ -18,9 +18,9 @@ featuredLinks: popular: - /discussions/guides/granting-higher-permissions-to-top-contributors - /discussions/guides/best-practices-for-community-conversations-on-github - - /discussions/guides/finding-discussions-across-multiple-repositories + - /discussions/guides/finding-your-discussions - /discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions - - /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository + - /discussions/managing-discussions-for-your-community/managing-categories-for-discussions changelog: label: discussions examples_source: data/product-examples/discussions/community-examples.yml diff --git a/content/discussions/managing-discussions-for-your-community/index.md b/content/discussions/managing-discussions-for-your-community/index.md index 6e403a6079..5f53936b7c 100644 --- a/content/discussions/managing-discussions-for-your-community/index.md +++ b/content/discussions/managing-discussions-for-your-community/index.md @@ -6,8 +6,8 @@ versions: fpt: '*' ghec: '*' children: - - /managing-discussions-in-your-repository - - /managing-categories-for-discussions-in-your-repository + - /managing-discussions + - /managing-categories-for-discussions - /moderating-discussions - /viewing-insights-for-your-discussions --- diff --git a/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md b/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md similarity index 79% rename from content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md rename to content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md index 536399aefb..876cbbefbe 100644 --- a/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md +++ b/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md @@ -1,11 +1,13 @@ --- -title: Managing categories for discussions in your repository -intro: 'You can categorize the discussions in your repository to organize conversations for your community members, and you can choose a format for each category.' -permissions: Repository administrators and people with write or greater access to a repository can manage categories for discussions in the repository. +title: Managing categories for discussions +intro: 'You can categorize discussions to organize conversations for your community members, and you can choose a format for each category.' +permissions: Repository administrators and people with write or greater access to a repository can manage categories for discussions in the repository. Repository administrators and people with write or greater access to the source repository for organization discussions can manage categories for discussions in the organization. versions: fpt: '*' ghec: '*' shortTitle: Manage categories +redirect_from: + - /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository --- @@ -24,12 +26,13 @@ Each category must have a unique name and emoji pairing, and can be accompanied | 📣 Announcements | Updates and news from project maintainers | Announcement | | #️⃣ General | Anything and everything relevant to the project | Open-ended discussion | |💡 Ideas | Ideas to change or improve the project | Open-ended discussion | +| 🗳 Polls | Polls with multiple options for the community to vote for and discuss | Polls | | 🙏 Q&A | Questions for the community to answer, with a question/answer format | Question and Answer | | 🙌 Show and tell | Creations, experiments, or tests relevant to the project | Open-ended discussion | ## Creating a category -{% data reusables.repositories.navigate-to-repo %} +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to create a category. {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.edit-categories %} 1. Click **New category**. @@ -43,7 +46,7 @@ Each category must have a unique name and emoji pairing, and can be accompanied You can edit a category to change the category's emoji, title, description, and discussion format. -{% data reusables.repositories.navigate-to-repo %} +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to create a category. {% data reusables.discussions.discussions-tab %} 1. To the right of a category in the list, click {% octicon "pencil" aria-label="The pencil icon" %}. ![Edit button to the right of category in list of categories for a repository](/assets/images/help/discussions/click-edit-for-category.png) @@ -56,7 +59,7 @@ You can edit a category to change the category's emoji, title, description, and When you delete a category, {% data variables.product.product_name %} will move all discussions in the deleted category to an existing category that you choose. -{% data reusables.repositories.navigate-to-repo %} +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to create a category. {% data reusables.discussions.discussions-tab %} 1. To the right of a category in the list, click {% octicon "trash" aria-label="The trash icon" %}. ![Trash button to the right of category in list of categories for a repository](/assets/images/help/discussions/click-delete-for-category.png) diff --git a/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md b/content/discussions/managing-discussions-for-your-community/managing-discussions.md similarity index 73% rename from content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md rename to content/discussions/managing-discussions-for-your-community/managing-discussions.md index 33c21edc67..b48293c83e 100644 --- a/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md +++ b/content/discussions/managing-discussions-for-your-community/managing-discussions.md @@ -1,11 +1,13 @@ --- -title: Managing discussions in your repository -intro: 'You can categorize, spotlight, transfer, or delete the discussions in a repository.' -permissions: Repository administrators and people with write or greater access to a repository can manage discussions in the repository. +title: Managing discussions +intro: 'You can categorize, spotlight, transfer, or delete the discussions.' +permissions: Repository administrators and people with write or greater access to a repository can manage discussions in the repository. Repository administrators and people with write or greater access to the source repository for organization discussions can manage discussions in the organization. versions: fpt: '*' ghec: '*' shortTitle: Manage discussions +redirect_from: + - /discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository --- @@ -13,7 +15,7 @@ shortTitle: Manage discussions {% data reusables.discussions.about-discussions %} For more information about discussions, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." -Organization owners can choose the permissions required to create a discussion for repositories owned by the organization. For more information, see "[Managing discussion creation for repositories in your organization](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)." +Organization owners can choose the permissions required to create a discussion in repositories owned by the organization. Similarly, to choose the permissions required to create an organization discussion, organization owners can change the permissions required in the source repository. For more information, see "[Managing discussion creation for repositories in your organization](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)." As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating a code of conduct or contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)," and "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)." @@ -27,11 +29,13 @@ For more information on facilitating a healthy discussion, see "[Moderating comm To manage discussions in a repository, {% data variables.product.prodname_discussions %} must be enabled for the repository. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for a repository](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)." +To manage discussions in an organization, {% data variables.product.prodname_discussions %} must be enabled for the organization. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." + ## Changing the category for a discussion -You can categorize discussions to help community members find related discussions. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." +You can categorize discussions to help community members find related discussions. For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)." -You can also move a discussion to a different category. +You can also move a discussion to a different category. It's not possible to move a discussion to or from the polls category. {% data reusables.repositories.navigate-to-repo %} {% data reusables.discussions.discussions-tab %} @@ -43,9 +47,9 @@ You can also move a discussion to a different category. ## Pinning a discussion -You can pin up to four important discussions above the list of discussions for the repository. +You can pin up to four important discussions above the list of discussions for the repository or organization. -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. In the right sidebar, click {% octicon "pin" aria-label="The pin icon" %} **Pin discussion**. @@ -57,9 +61,9 @@ You can pin up to four important discussions above the list of discussions for t ## Editing a pinned discussion -Editing a pinned discussion will not change the discussion's category. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." +Editing a pinned discussion will not change the discussion's category. For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)." -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. In the right sidebar, click {% octicon "pencil" aria-label="The pencil icon" %} **Edit pinned discussion**. @@ -71,7 +75,7 @@ Editing a pinned discussion will not change the discussion's category. For more ## Unpinning a discussion -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. In the right sidebar, click {% octicon "pin" aria-label="The pin icon" %} **Unpin discussion**. @@ -81,21 +85,21 @@ Editing a pinned discussion will not change the discussion's category. For more ## Transferring a discussion -To transfer a discussion, you must have permissions to create discussions in the repository where you want to transfer the discussion. You can only transfer discussions between repositories owned by the same user or organization account. You can't transfer a discussion from a private repository to a public repository. +To transfer a discussion, you must have permissions to create discussions in the repository where you want to transfer the discussion. If you want to transfer a discussion to an organization, you must have permissions to create discussions in the source repository for the organization's discussions. You can only transfer discussions between repositories owned by the same user or organization account. You can't transfer a discussion from a private repository to a public repository. -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. In the right sidebar, click {% octicon "arrow-right" aria-label="The right arrow icon" %} **Transfer discussion**. !["Transfer discussion" in right sidebar for discussion](/assets/images/help/discussions/click-transfer-discussion.png) -1. Select the **Choose a repository** drop-down, and click the repository you want to transfer the discussion to. +1. Select the **Choose a repository** drop-down, and click the repository you want to transfer the discussion to. If you want to transfer a discussion to an organization, choose the source repository for the organization's discussions. !["Choose a repository" drop-down, "Find a repository" search field, and repository in list](/assets/images/help/discussions/use-choose-a-repository-drop-down.png) 1. Click **Transfer discussion**. !["Transfer discussion" button](/assets/images/help/discussions/click-transfer-discussion-button.png) ## Deleting a discussion -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. In the right sidebar, click {% octicon "trash" aria-label="The trash arrow icon" %} **Delete discussion**. @@ -107,7 +111,7 @@ To transfer a discussion, you must have permissions to create discussions in the You can convert all issues with the same label to discussions in bulk. Future issues with this label will also automatically convert to the discussion and category you configure. -{% data reusables.repositories.navigate-to-repo %} +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or, for organization discussions, the source repository. {% data reusables.repositories.sidebar-issues %} {% data reusables.project-management.labels %} 1. Next to the label you want to convert to issues, click **Convert issues**. diff --git a/content/discussions/managing-discussions-for-your-community/moderating-discussions.md b/content/discussions/managing-discussions-for-your-community/moderating-discussions.md index c9d780d806..415b5ce3d3 100644 --- a/content/discussions/managing-discussions-for-your-community/moderating-discussions.md +++ b/content/discussions/managing-discussions-for-your-community/moderating-discussions.md @@ -1,7 +1,7 @@ --- title: Moderating discussions intro: 'You can promote healthy collaboration by marking comments as answers, locking or unlocking discussions, converting issues to discussions, and editing or deleting comments, discussions, and categories that don''t align with your community''s code of conduct.' -permissions: People with triage access to a repository can moderate discussions in the repository. +permissions: People with triage access to a repository can moderate discussions in the repository. People with triage access to the source repository for organization discussions can moderate discussions in the organization. versions: fpt: '*' ghec: '*' @@ -10,7 +10,7 @@ versions: ## About moderating discussions -{% data reusables.discussions.about-discussions %} If you have triage permissions for a repository, you can help moderate a project's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. +{% data reusables.discussions.about-discussions %} If you have triage permissions for a repository, you can help moderate a repository's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. Similarly, if you have triage permission for the source repository for organization discussions, you can moderate discussions for that organization. ## Marking a comment as an answer @@ -18,9 +18,9 @@ versions: ## Locking discussions -It's appropriate to lock a conversation when the entire conversation is not constructive or violates your community's code of conduct or {% data variables.product.prodname_dotcom %}'s [Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines). You can also lock a conversation to prevent comments on a discussion you want to use as an announcement to the community. When you lock a conversation, people with write access to the repository will still be able to comment on the discussion. +It's appropriate to lock a conversation when the entire conversation is not constructive or violates your community's code of conduct or {% data variables.product.prodname_dotcom %}'s [Community Guidelines](/free-pro-team@latest/github/site-policy/github-community-guidelines). You can also lock a conversation to prevent comments on a discussion you want to use as an announcement to the community. When you lock a conversation, people with write access to the repository, or source repository for organization discussions, will still be able to comment on the discussion. -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} 1. In the list of discussions, click the discussion you want to lock. ![Lock discussion](/assets/images/help/discussions/unanswered-discussion.png) @@ -30,9 +30,9 @@ It's appropriate to lock a conversation when the entire conversation is not cons ## Converting an issue to a discussion -When you convert an issue to a discussion, the discussion is automatically created using the content from the issue. People with write access to a repository can bulk convert issues based on labels. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)." +When you convert an issue to a discussion, the discussion is automatically created using the content from the issue. People with write access to a repository, or source repository for organization discussions, can bulk convert issues based on labels. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions)." -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.repositories.sidebar-issues %} 1. In the list of issues, click the issue you'd like to convert. 1. In the right margin of an issue, click **Convert to discussion**. diff --git a/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md b/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md index 36ab2d3a43..97de8f825f 100644 --- a/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md +++ b/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md @@ -1,7 +1,7 @@ --- title: Viewing insights for your discussions intro: 'Discussions insights provide data about your discussions'' activity, views, and contributors.' -permissions: Repository administrators and people with maintain access to a repository can view the discussions insights dashboard. +permissions: Repository administrators and people with maintain access to a repository can view the insights dashboard for discussions in that repository. Repository administrators and people with maintain access to the source repository for organization discussions can view the insights dashboard for discussions in that organization. versions: fpt: '*' ghec: '*' @@ -12,7 +12,7 @@ shortTitle: View discussions insights ## About the discussions insights dashboard -You can use discussions insights to help understand the contribution activity, page views, and growth of your repository's discussions community. +You can use discussions insights to help understand the contribution activity, page views, and growth of your discussions community. - **Contribution activity** shows the count of total contributions to discussions, issues, and pull requests. - **Discussions page views** shows the total page views for discussions, segmented by logged in versus anonymous viewers. - **Discussions daily contributors** shows the daily count of unique users who have reacted, upvoted, marked an answer, commented, or posted in the selected time period. @@ -28,7 +28,7 @@ You can use discussions insights to help understand the contribution activity, p ## Viewing discussions insights -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.navigate-to-repo %} For organization discussions, navigate to the main page of the source repository. {% data reusables.repositories.accessing-repository-graphs %} 3. In the left sidebar, click **Community**. ![Screenshot of the "Community" tab in left sidebar](/assets/images/help/graphs/graphs-sidebar-community-tab.png) diff --git a/content/discussions/quickstart.md b/content/discussions/quickstart.md index 7919bdedc7..cb54d02901 100644 --- a/content/discussions/quickstart.md +++ b/content/discussions/quickstart.md @@ -1,6 +1,6 @@ --- title: Quickstart for GitHub Discussions -intro: 'Enable {% data variables.product.prodname_discussions %} on an existing repository and start conversations with your community.' +intro: 'Enable {% data variables.product.prodname_discussions %} on an existing repository or organization and start conversations with your community.' allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -31,34 +31,50 @@ When you first enable {% data variables.product.prodname_discussions %}, you wil 1. Click **Start discussion**. !["Start discussion" button](/assets/images/help/discussions/new-discussion-start-discussion-button.png) +## Enabling {% data variables.product.prodname_discussions %} on your organization + +Organization owners can enable {% data variables.product.prodname_discussions %} for their organization. + +{% data reusables.discussions.about-organization-discussions %} + +{% data reusables.discussions.enabling-or-disabling-github-discussions-for-your-organization %} + ## Welcoming contributions to your discussions -You can welcome your community and introduce a new way to communicate in a repository by creating a welcome post and pinning the post to your {% data variables.product.prodname_discussions %} page. Pinning and locking discussions helps people know that a post is meant as an announcement. You can use announcements as a way to link people to more resources and offer guidance for opening discussions in your community. For more information about pinning a discussion, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#pinning-a-discussion)." +You can welcome your community and introduce a new way to communicate in a repository or organization by creating a welcome post and pinning the post to your {% data variables.product.prodname_discussions %} page. Pinning and locking discussions helps people know that a post is meant as an announcement. You can use announcements as a way to link people to more resources and offer guidance for opening discussions in your community. For more information about pinning a discussion, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#pinning-a-discussion)." ## Setting up community guidelines for contributors -You can set contributing guidelines to encourage collaborators to have meaningful, useful conversations that are relevant to the repository. You can also update the repository's README to communicate expectations on when collaborators should open an issue or discussion. +For repository discussions, you can set contributing guidelines to encourage collaborators to have meaningful, useful conversations that are relevant to the repository. You can also update the repository's README to communicate expectations on when collaborators should open an issue or discussion. For more information about providing guidelines for your project, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." -For more information about providing guidelines for your project, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." +For organization discussions, you share information about how to engage with your organization by creating an organization profile README. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)." ## Creating a new discussion -Any authenticated user who can view a repository can create a discussion. +Any authenticated user who can view the repository can create a discussion in that repository. Similarly, since organization discussions are based on a source repository, any authenticated user who can view the source repository can create a discussion in that organization. {% data reusables.discussions.starting-a-discussion %} +## Creating a new poll + +Any authenticated user who can view a repository can create a poll. Similarly, since organization discussions are based on a source repository, any authenticated user who can view the source repository can create a poll in that organization. + +{% data reusables.discussions.starting-a-poll %} + ## Organizing discussions -Repository owners and people with write access can create new categories to keep discussions organized. Collaborators participating and creating new discussions can group discussions into the most relevant existing categories. Discussions can also be recategorized after they are created. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." +Repository owners and people with write access to the repository can create new categories to keep discussions organized. Similarly, since organization discussions are based on a source repository, repository owners and people with write access to the source repository can create new categories for organization discussions. + +Collaborators participating and creating new discussions can group discussions into the most relevant existing categories. Discussions can also be recategorized after they are created. For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)." {% data reusables.discussions.you-can-label-discussions %} ## Promoting healthy conversations -People with write permissions for a repository can help surface important conversations by pinning discussions, deleting discussions that are no longer useful or are damaging to the community, and transferring discussions to more relevant repositories owned by the organization. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)." +People with write permissions for the repository, or for the source repository for organization discussions, can help surface important conversations by pinning discussions, deleting discussions that are no longer useful or are damaging to the community, and transferring discussions to more relevant repositories owned by the organization. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions)." -People with triage permissions for a repository can help moderate a project's discussions by marking comments as answers, locking discussions that are no longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)." +People with triage permissions for the repository, or for the source repository for organization discussions, can help moderate a project's discussions by marking comments as answers, locking discussions that are no longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)." ## Next steps diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/apply-for-a-student-developer-pack.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/apply-for-a-student-developer-pack.md index 9c0f53a543..e6a19442b0 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/apply-for-a-student-developer-pack.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/apply-for-a-student-developer-pack.md @@ -17,7 +17,7 @@ shortTitle: Apply for a student pack To be eligible for the {% data variables.product.prodname_student_pack %}, you must: - Be currently enrolled in a degree or diploma granting course of study such as a high school, secondary school, college, university, homeschool, or similar educational institution - Have a verifiable school-issued email address or upload documents that prove your current student status -- Have a [{% data variables.product.prodname_dotcom %} user account](/articles/signing-up-for-a-new-github-account) +- Have a [{% data variables.product.prodname_dotcom %} personal account](/articles/signing-up-for-a-new-github-account) - Be at least 13 years old Documents that prove your current student status include a picture of your school ID with current enrollment date, class schedule, transcript, and affiliation or enrollment verification letter. @@ -26,7 +26,7 @@ During your tenure as a student, you may be prompted to periodically re-verify y {% note %} -**Note:** You cannot transfer academic discounts from one account to another. If you have more than one account you want to apply the discount to, consider [merging](/articles/merging-multiple-user-accounts) your user accounts and [renaming](/articles/changing-your-github-username) the retained account if desired. +**Note:** You cannot transfer academic discounts from one account to another. If you have more than one account you want to apply the discount to, consider [merging](/articles/merging-multiple-user-accounts) your personal accounts and [renaming](/articles/changing-your-github-username) the retained account if desired. {% endnote %} diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md index 3249d81ea8..8584d0b696 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md @@ -50,10 +50,10 @@ If your academic email address was already used to request a {% data variables.p {% endnote %} -If you have more than one personal user account, you must merge your accounts. To retain the discount, keep the account that was granted the discount. You can rename the retained account and keep your contribution history by adding all your email addresses to the retained account. +If you have more than one personal account, you must merge your accounts. To retain the discount, keep the account that was granted the discount. You can rename the retained account and keep your contribution history by adding all your email addresses to the retained account. For more information, see: -- "[Merging multiple user accounts](/articles/merging-multiple-user-accounts)" +- "[Merging multiple personal accounts](/articles/merging-multiple-user-accounts)" - "[Changing your {% data variables.product.prodname_dotcom %} username](/articles/changing-your-github-username)" - "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/articles/adding-an-email-address-to-your-github-account)" diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research/apply-for-an-educator-or-researcher-discount.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research/apply-for-an-educator-or-researcher-discount.md index 1e4b285c61..ad6b8e8772 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research/apply-for-an-educator-or-researcher-discount.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research/apply-for-an-educator-or-researcher-discount.md @@ -20,7 +20,7 @@ shortTitle: Apply for a discount {% data reusables.education.educator-requirements %} -For more information about user accounts on {% data variables.product.product_name %}, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/github/getting-started-with-github/signing-up-for-a-new-github-account)." +For more information about personal accounts on {% data variables.product.product_name %}, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/github/getting-started-with-github/signing-up-for-a-new-github-account)." ## Applying for an educator or researcher discount diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 831cf0d516..025e73446e 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -22,6 +22,8 @@ You can decide how many teams one assignment can have, and how many members each For a video demonstration of the creation of a group assignment, see "[Basics of setting up {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom)." +{% data reusables.classroom.reuse-assignment-link %} + ## Prerequisites {% data reusables.classroom.assignments-classroom-prerequisite %} diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md index 5ac3169b63..03de7b168b 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md @@ -13,6 +13,8 @@ You can use a template repository on {% data variables.product.product_name %} a To use the template repository for your assignment, the template repository must be owned by your organization, or the visibility of the template repository must be public. +You can reuse an existing assignment, even if it uses a template repository, in any other classroom that you have admin access to, including classrooms in a different organization. For more information, see "[Reuse an assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." + ## Further reading - "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md index 668edee705..58d41b99bb 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md @@ -19,6 +19,8 @@ shortTitle: Individual assignment For a video demonstration of the creation of an individual assignment, see "[Basics of setting up {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom)." +{% data reusables.classroom.reuse-assignment-link %} + ## Prerequisites {% data reusables.classroom.assignments-classroom-prerequisite %} diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md index e1fbee6bfe..6965aa9d05 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md @@ -11,6 +11,7 @@ children: - /use-the-git-and-github-starter-assignment - /create-an-individual-assignment - /create-a-group-assignment + - /reuse-an-assignment - /create-an-assignment-from-a-template-repository - /leave-feedback-with-pull-requests - /use-autograding diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md index 9175d083e1..b15272fbcf 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md @@ -21,15 +21,17 @@ redirect_from: After you create a classroom, {% data variables.product.prodname_classroom %} will prompt you to invite teaching assistants (TAs) and admins to the classroom. Each classroom can have one or more admins. Admins can be teachers, TAs, or any other course administrator who you'd like to have control over your classrooms on {% data variables.product.prodname_classroom %}. -Invite TAs and admins to your classroom by inviting the user accounts on {% data variables.product.product_name %} to your organization as organization owners and sharing the URL for your classroom. Organization owners can administer any classroom for the organization. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" and "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)." +Invite TAs and admins to your classroom by inviting the personal accounts on {% data variables.product.product_name %} to your organization as organization owners and sharing the URL for your classroom. Organization owners can administer any classroom for the organization. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" and "[Inviting users to join your organization](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)." -When you're done using a classroom, you can archive the classroom and refer to the classroom, roster, and assignments later, or you can delete the classroom if you no longer need the classroom. +When you're done using a classroom, you can archive the classroom and refer to the classroom, roster, and assignments later, or you can delete the classroom if you no longer need the classroom. + +{% data reusables.classroom.reuse-assignment-link %} ## About classroom rosters Each classroom has a roster. A roster is a list of identifiers for the students who participate in your course. -When you first share the URL for an assignment with a student, the student must sign into {% data variables.product.product_name %} with a user account to link the user account to an identifier for the classroom. After the student links a user account, you can see the associated user account in the roster. You can also see when the student accepts or submits an assignment. +When you first share the URL for an assignment with a student, the student must sign into {% data variables.product.product_name %} with a personal account to link the personal account to an identifier for the classroom. After the student links a personal account, you can see the associated personal account in the roster. You can also see when the student accepts or submits an assignment. ![Classroom roster](/assets/images/help/classroom/roster-hero.png) @@ -46,7 +48,7 @@ You must authorize the OAuth app for {% data variables.product.prodname_classroo !["New classroom" button](/assets/images/help/classroom/click-new-classroom-button.png) {% data reusables.classroom.guide-create-new-classroom %} -After you create a classroom, you can begin creating assignments for students. For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)," "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," or "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)." +After you create a classroom, you can begin creating assignments for students. For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)," "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)," or "[Reuse an assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." ## Creating a roster for your classroom diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md new file mode 100644 index 0000000000..0a5e72968b --- /dev/null +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md @@ -0,0 +1,37 @@ +--- +title: Reuse an assignment +intro: You can reuse an existing assignment in more than one classroom, including classrooms in a different organization. +versions: + fpt: '*' +permissions: 'Organization owners who are admins for a classroom can reuse assignments from a classroom. {% data reusables.classroom.classroom-admins-link %}' +shortTitle: Reuse an assignment +--- +## About reusing assignments + +You can reuse an existing individual or group assignment in any other classroom you have access to, including classrooms in a different organization. If you choose to reuse an assignment, {% data variables.product.prodname_classroom %} will copy the assignment to the classroom you choose. If the assignment uses a template repository and you choose to reuse it in a classroom from a different organization, {% data variables.product.prodname_classroom %} will create a copy of the repository and its contents in the target organization. + +The copied assignment includes assignment details such as the name, source repository, autograding test, and preferred editor. You can edit the assignment after it has been copied to make changes. You cannot make changes to the preferred editor. + +## Reusing an assignment + +1. Sign into {% data variables.product.prodname_classroom_with_url %}. +1. Navigate to the classroom that has the assignment that you want to reuse. + + ![Classroom in list of classrooms for an organization](/assets/images/help/classroom/click-classroom-in-list.png) + +1. In the list of assignments, click the assignment you want to reuse. + + ![Assignment in list of assignments for an classroom](/assets/images/help/classroom/click-assignment-in-list.png) + +1. Select the **{% octicon "pencil" aria-label="The pencil icon" %} Edit** dropdown menu in the top right of the page, then click **{% octicon "sync" aria-label="The sync icon" %} Reuse assignment**. + + ![Reuse assignment button](/assets/images/help/classroom/reuse-assignment-button.png) + +1. In "Reuse assignment" modal, use the **Choose an organization** dropdown menu to select the organization you want the assignment to be in. Then use the **Choose a classroom** dropdown menu to select the classroom within that organization that you want to copy the assignment to. + + ![Reuse assignment modal](/assets/images/help/classroom/reuse-assignment-modal.png) + +1. Click **Create assignment**. +1. The assignment is copied to the selected classroom, and a confirmation message is shown. If you chose to reuse an assignment with a template repository, the copying process may take a few minutes to complete, and you may need to refresh the page to see the completed message. + + ![Completed message for reused assignment](/assets/images/help/classroom/reuse-assignment-completed-message.png) diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md index 2c15d8e107..baf493a93b 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md @@ -96,7 +96,7 @@ The Git & {% data variables.product.company_short %} starter assignment is only ## Next steps -- Make additional assignments customized to your course. For more information, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" and "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)." +- Make additional assignments customized to your course. For more information, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)," and "[Reuse an assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." ## Further reading diff --git a/content/education/quickstart.md b/content/education/quickstart.md index 0f62423daf..598ff4a2d6 100644 --- a/content/education/quickstart.md +++ b/content/education/quickstart.md @@ -21,12 +21,12 @@ In this guide, you'll get started with {% data variables.product.product_name %} ## Creating accounts on {% data variables.product.product_name %} -First, you'll need to create a free user account on {% data variables.product.product_name %}. +First, you'll need to create a free personal account on {% data variables.product.product_name %}. {% data reusables.accounts.create-account %} -1. Follow the prompts to create your free user account. +1. Follow the prompts to create your free personal account. -After you create your user account, create a free organization account. You'll use this organization account to create and manage classrooms {% data variables.product.prodname_classroom %}. +After you create your personal account, create a free organization account. You'll use this organization account to create and manage classrooms {% data variables.product.prodname_classroom %}. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.organizations %} @@ -55,11 +55,11 @@ Next, you'll sign up for discounts on services from {% data variables.product.co ## Set up {% data variables.product.prodname_classroom %} -With your user account and organization account, you're ready to get started with {% data variables.product.prodname_classroom %}. {% data variables.product.prodname_classroom %} is free to use. You can track and manage assignments, grade work automatically, and provide feedback to your students. +With your personal account and organization account, you're ready to get started with {% data variables.product.prodname_classroom %}. {% data variables.product.prodname_classroom %} is free to use. You can track and manage assignments, grade work automatically, and provide feedback to your students. {% data reusables.classroom.sign-into-github-classroom %} -1. To authorize {% data variables.product.prodname_classroom %} to access your user account on {% data variables.product.prodname_dotcom %}, review the information, then click **Authorize {% data variables.product.prodname_classroom %}**. - !["Authorize {% data variables.product.prodname_classroom %}" button for user account](/assets/images/help/classroom/setup-click-authorize-github-classroom.png) +1. To authorize {% data variables.product.prodname_classroom %} to access your personal account on {% data variables.product.prodname_dotcom %}, review the information, then click **Authorize {% data variables.product.prodname_classroom %}**. + !["Authorize {% data variables.product.prodname_classroom %}" button for personal account](/assets/images/help/classroom/setup-click-authorize-github-classroom.png) 1. Review the information. To authorize {% data variables.product.prodname_classroom %} to access your organization account on {% data variables.product.prodname_dotcom %}, click **Grant**. !["Grant" button for organization](/assets/images/help/classroom/setup-click-grant.png) diff --git a/content/get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account.md b/content/get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account.md index 3fc2ff532c..9fd2dcdd3f 100644 --- a/content/get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account.md +++ b/content/get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account.md @@ -8,7 +8,7 @@ redirect_from: versions: fpt: '*' ghec: '*' -shortTitle: Install app user account +shortTitle: Install app personal account --- {% data reusables.marketplace.marketplace-apps-only %} diff --git a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-git-repository-using-the-command-line.md b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-git-repository-using-the-command-line.md index dcfd6ea284..1ded6370dc 100644 --- a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-git-repository-using-the-command-line.md +++ b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-git-repository-using-the-command-line.md @@ -23,7 +23,7 @@ For purposes of demonstration, we'll use: - An external account named **extuser** - An external Git host named `https://external-host.com` -- A {% data variables.product.product_name %} personal user account named **ghuser** +- A {% data variables.product.product_name %} personal account named **ghuser** - A repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} named **repo.git** {% endtip %} diff --git a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer.md b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer.md index 60255b9dc3..972d56f73e 100644 --- a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer.md +++ b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer.md @@ -17,7 +17,7 @@ shortTitle: Use GitHub Importer {% endtip %} -If you'd like to match the commits in your repository to the authors' GitHub user accounts during the import, make sure every contributor to your repository has a GitHub account before you begin the import. +If you'd like to match the commits in your repository to the authors' GitHub personal accounts during the import, make sure every contributor to your repository has a GitHub account before you begin the import. {% data reusables.repositories.repo-size-limit %} @@ -25,7 +25,7 @@ If you'd like to match the commits in your repository to the authors' GitHub use ![Import repository option in new repository menu](/assets/images/help/importer/import-repository.png) 2. Under "Your old repository's clone URL", type the URL of the project you want to import. ![Text field for URL of imported repository](/assets/images/help/importer/import-url.png) -3. Choose your user account or an organization to own the repository, then type a name for the repository on GitHub. +3. Choose your personal account or an organization to own the repository, then type a name for the repository on GitHub. ![Repository owner menu and repository name field](/assets/images/help/importer/import-repo-owner-name.png) 4. Specify whether the new repository should be *public* or *private*. For more information, see "[Setting repository visibility](/articles/setting-repository-visibility)." ![Public or private repository radio buttons](/assets/images/help/importer/import-public-or-private.png) diff --git a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/source-code-migration-tools.md b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/source-code-migration-tools.md index 15e228f2e0..91550203c2 100644 --- a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/source-code-migration-tools.md +++ b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/source-code-migration-tools.md @@ -21,7 +21,7 @@ We recommend using [GitHub Importer](/articles/about-github-importer) to import ## Importing from Subversion -In a typical Subversion environment, multiple projects are stored in a single root repository. On GitHub, each of these projects will usually map to a separate Git repository for a user account or organization. We suggest importing each part of your Subversion repository to a separate GitHub repository if: +In a typical Subversion environment, multiple projects are stored in a single root repository. On GitHub, each of these projects will usually map to a separate Git repository for a personal account or organization. We suggest importing each part of your Subversion repository to a separate GitHub repository if: * Collaborators need to check out or commit to that part of the project separately from the other parts * You want different parts to have their own access permissions 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 1c3d381166..1d26d1d63c 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 @@ -25,9 +25,9 @@ shortTitle: Access permissions Roles work differently for different types of accounts. For more information about accounts, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)." -## Personal user accounts +## Personal accounts -A repository owned by a user account has two permission levels: the *repository owner* and *collaborators*. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)." +A repository owned by a personal account has two permission levels: the *repository owner* and *collaborators*. For more information, see "[Permission levels for a personal account repository](/articles/permission-levels-for-a-user-account-repository)." ## Organization accounts @@ -47,7 +47,7 @@ For more information about permissions for enterprise accounts, see [the {% data *Enterprise owners* have ultimate power over the enterprise account and can take every action in the enterprise account.{% ifversion ghec or ghes %} *Billing managers* can manage your enterprise account's billing settings.{% endif %} Members and outside collaborators of organizations owned by your enterprise account are automatically members of the enterprise account, although they have no access to the enterprise account itself or its settings. For more information, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)." {% ifversion ghec %} -If an enterprise uses {% data variables.product.prodname_emus %}, members are provisioned as new user accounts on {% data variables.product.prodname_dotcom %} and are fully managed by the identity provider. The {% data variables.product.prodname_managed_users %} have read-only access to repositories that are not a part of their enterprise and cannot interact with users that are not also members of the enterprise. Within the organizations owned by the enterprise, the {% data variables.product.prodname_managed_users %} can be granted the same granular access levels available for regular organizations. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." +If an enterprise uses {% data variables.product.prodname_emus %}, members are provisioned as new personal accounts on {% data variables.product.prodname_dotcom %} and are fully managed by the identity provider. The {% data variables.product.prodname_managed_users %} have read-only access to repositories that are not a part of their enterprise and cannot interact with users that are not also members of the enterprise. Within the organizations owned by the enterprise, the {% data variables.product.prodname_managed_users %} can be granted the same granular access levels available for regular organizations. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." {% endif %} {% endif %} diff --git a/content/get-started/learning-about-github/faq-about-changes-to-githubs-plans.md b/content/get-started/learning-about-github/faq-about-changes-to-githubs-plans.md index ec47a91e73..f763b1fd4a 100644 --- a/content/get-started/learning-about-github/faq-about-changes-to-githubs-plans.md +++ b/content/get-started/learning-about-github/faq-about-changes-to-githubs-plans.md @@ -27,11 +27,11 @@ GitHub announced the following plans and pricing changes: ## How can I upgrade my plan? -To upgrade your user account's plan, see "[Upgrading your personal account's subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-personal-accounts-subscription)." To upgrade your organization's plan, see "[Upgrading your organization's subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-organizations-subscription)." +To upgrade your personal account's plan, see "[Upgrading your personal account's subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-personal-accounts-subscription)." To upgrade your organization's plan, see "[Upgrading your organization's subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-organizations-subscription)." ## How can I downgrade my plan? -To downgrade your user account's plan, see "[Downgrading your user account's subscription](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription#downgrading-your-user-accounts-subscription)." To downgrade your organization's plan, see "[Downgrading your organization's subscription](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription#downgrading-your-organizations-subscription)." +To downgrade your personal account's plan, see "[Downgrading your personal account's subscription](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription#downgrading-your-personal-accounts-subscription)." To downgrade your organization's plan, see "[Downgrading your organization's subscription](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription#downgrading-your-organizations-subscription)." ## If I downgrade from GitHub Team or a Legacy plan to GitHub Free, what features will I lose? - Required reviewers in private repositories diff --git a/content/get-started/learning-about-github/githubs-products.md b/content/get-started/learning-about-github/githubs-products.md index 7e8c4f4452..1c949f3ab3 100644 --- a/content/get-started/learning-about-github/githubs-products.md +++ b/content/get-started/learning-about-github/githubs-products.md @@ -20,17 +20,17 @@ topics: --- ## About {% data variables.product.prodname_dotcom %}'s products -{% data variables.product.prodname_dotcom %} offers free and paid products for storing and collaborating on code. Some products apply only to user accounts, while other plans apply only to organization and enterprise accounts. For more information about accounts, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)." +{% data variables.product.prodname_dotcom %} offers free and paid products for storing and collaborating on code. Some products apply only to personal accounts, while other plans apply only to organization and enterprise accounts. For more information about accounts, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)." You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %} When you read {% data variables.product.prodname_docs %}, make sure to select the version that reflects your product. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." -## {% data variables.product.prodname_free_user %} for user accounts +## {% data variables.product.prodname_free_user %} for personal accounts -With {% data variables.product.prodname_free_team %} for user accounts, you can work with unlimited collaborators on unlimited public repositories with a full feature set, and on unlimited private repositories with a limited feature set. +With {% data variables.product.prodname_free_team %} for personal accounts, you can work with unlimited collaborators on unlimited public repositories with a full feature set, and on unlimited private repositories with a limited feature set. -With {% data variables.product.prodname_free_user %}, your user account includes: +With {% data variables.product.prodname_free_user %}, your personal account includes: - {% data variables.product.prodname_gcf %} - {% data variables.product.prodname_dependabot_alerts %} - Two-factor authentication enforcement @@ -39,7 +39,7 @@ With {% data variables.product.prodname_free_user %}, your user account includes ## {% data variables.product.prodname_pro %} -In addition to the features available with {% data variables.product.prodname_free_user %} for user accounts, {% data variables.product.prodname_pro %} includes: +In addition to the features available with {% data variables.product.prodname_free_user %} for personal accounts, {% data variables.product.prodname_pro %} includes: - {% data variables.contact.github_support %} via email - 3,000 {% data variables.product.prodname_actions %} minutes - 2GB {% data variables.product.prodname_registry %} storage @@ -57,7 +57,7 @@ In addition to the features available with {% data variables.product.prodname_fr With {% data variables.product.prodname_free_team %} for organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. -In addition to the features available with {% data variables.product.prodname_free_user %} for user accounts, {% data variables.product.prodname_free_team %} for organizations includes: +In addition to the features available with {% data variables.product.prodname_free_user %} for personal accounts, {% data variables.product.prodname_free_team %} for organizations includes: - {% data variables.product.prodname_gcf %} - Team discussions - Team access controls for managing groups diff --git a/content/get-started/learning-about-github/types-of-github-accounts.md b/content/get-started/learning-about-github/types-of-github-accounts.md index 6be3c73075..15df67a422 100644 --- a/content/get-started/learning-about-github/types-of-github-accounts.md +++ b/content/get-started/learning-about-github/types-of-github-accounts.md @@ -46,7 +46,7 @@ Your personal account can own resources such as repositories, packages, and proj {% endtip %} {% ifversion fpt or ghec %} -Most people will use one personal account for all their work on {% data variables.product.prodname_dotcom_the_website %}, including both open source projects and paid employment. If you're currently using more than one personal account that you created for yourself, we suggest combining the accounts. For more information, see "[Merging multiple user accounts](/articles/merging-multiple-user-accounts)." +Most people will use one personal account for all their work on {% data variables.product.prodname_dotcom_the_website %}, including both open source projects and paid employment. If you're currently using more than one personal account that you created for yourself, we suggest combining the accounts. For more information, see "[Merging multiple personal accounts](/articles/merging-multiple-user-accounts)." {% endif %} ## Organization accounts @@ -57,7 +57,7 @@ Like personal accounts, organizations can own resources such as repositories, pa The personal accounts within an organization can be given different roles in the organization, which grant different levels of access to the organization and its data. All members can collaborate with each other in repositories and projects, but only organization owners and security managers can manage the settings for the organization and control access to the organization's data with sophisticated security and administrative features. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" and "[Keeping your organization secure](/organizations/keeping-your-organization-secure)." -![Diagram showing that users must sign in to their personal user account to access an organization's resources](/assets/images/help/overview/sign-in-pattern.png) +![Diagram showing that users must sign in to their personal account to access an organization's resources](/assets/images/help/overview/sign-in-pattern.png) {% ifversion fpt or ghec %} Even if you're a member of an organization that uses SAML single sign-on, you will still sign into your own personal account on {% data variables.product.prodname_dotcom_the_website %}, and that personal account will be linked to your identity in your organization's identity provider (IdP). For more information, see "[About authentication with SAML single sign-on](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation{% else %}."{% endif %} diff --git a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md index 79fd497876..109eb89028 100644 --- a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md +++ b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md @@ -21,7 +21,7 @@ The main difference between the products is that {% data variables.product.prodn With {% data variables.product.prodname_ghe_cloud %}, you have the option of using {% data variables.product.prodname_emus %}. {% data reusables.enterprise-accounts.emu-short-summary %} -If you choose to let your members create and manage their own user accounts instead, there are two types of accounts you can use with {% data variables.product.prodname_ghe_cloud %}: +If you choose to let your members create and manage their own personal accounts instead, there are two types of accounts you can use with {% data variables.product.prodname_ghe_cloud %}: - A single organization account - An enterprise account that contains multiple organizations 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 27e6ee5e6a..9a128d919c 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -8,15 +8,15 @@ versions: This guide will walk you through setting up, configuring and managing your {% data variables.product.prodname_team %} account as an organization owner. ## Part 1: Configuring your account on {% data variables.product.product_location %} -As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. +As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a personal account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. ### 1. About organizations Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)." ### 2. Creating an organization and signing up for {% data variables.product.prodname_team %} -Before creating an organization, you will need to create a user account or log in to your existing account on {% data variables.product.product_location %}. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)." +Before creating an organization, you will need to create a personal account or log in to your existing account on {% data variables.product.product_location %}. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)." -Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." +Once your personal account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." ### 3. Managing billing for an organization You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)." diff --git a/content/get-started/onboarding/getting-started-with-your-github-account.md b/content/get-started/onboarding/getting-started-with-your-github-account.md index 245a75c61f..fb8cf05ac1 100644 --- a/content/get-started/onboarding/getting-started-with-your-github-account.md +++ b/content/get-started/onboarding/getting-started-with-your-github-account.md @@ -1,6 +1,6 @@ --- title: Getting started with your GitHub account -intro: 'With a user account on {% data variables.product.prodname_dotcom %}, you can import or create repositories, collaborate with others, and connect with the {% data variables.product.prodname_dotcom %} community.' +intro: 'With a personal account on {% data variables.product.prodname_dotcom %}, you can import or create repositories, collaborate with others, and connect with the {% data variables.product.prodname_dotcom %} community.' versions: fpt: '*' ghes: '*' @@ -20,7 +20,7 @@ The first steps in starting with {% data variables.product.product_name %} are t The first steps in starting with {% data variables.product.product_name %} are to access your account and view your profile. {% endif %} -{% ifversion fpt or ghec %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif %} Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. +{% ifversion fpt or ghec %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif %} Every person who uses {% data variables.product.product_name %} has their own personal account, which can be part of multiple organizations and teams. Your personal account is your identity on {% data variables.product.product_location %} and represents you as an individual. {% ifversion fpt or ghec %} ### 1. Creating an account @@ -97,7 +97,7 @@ Any number of people can work together in repositories across {% data variables. ### 1. Working with repositories #### Creating a repository -A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." +A repository is like a folder for your project. You can have any number of public and private repositories in your personal account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." @@ -112,7 +112,7 @@ If you have existing projects you'd like to move over to {% data variables.produ ### 3. Managing collaborators and permissions You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)." -You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)." +You are the owner of any repository you create in your personal account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see "[Permission levels for a personal account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)." ### 4. Managing repository settings As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see "[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." diff --git a/content/get-started/quickstart/create-a-repo.md b/content/get-started/quickstart/create-a-repo.md index bd5cc70f15..8dec044d9a 100644 --- a/content/get-started/quickstart/create-a-repo.md +++ b/content/get-started/quickstart/create-a-repo.md @@ -59,7 +59,7 @@ Congratulations! You've successfully created your first repository, and initiali {% data reusables.cli.cli-learn-more %} 1. In the command line, navigate to the directory where you would like to create a local clone of your new project. -2. To create a repository for your project, use the `gh repo create` subcommand. When prompted, select **Create a new repository on GitHub from scratch** and enter the name of your new project. If you want your project to belong to an organization instead of to your user account, specify the organization name and project name with `organization-name/project-name`. +2. To create a repository for your project, use the `gh repo create` subcommand. When prompted, select **Create a new repository on GitHub from scratch** and enter the name of your new project. If you want your project to belong to an organization instead of to your personal account, specify the organization name and project name with `organization-name/project-name`. 3. Follow the interactive prompts. To clone the repository locally, confirm yes when asked if you would like to clone the remote project directory. 4. Alternatively, to skip the prompts supply the repository name and a visibility flag (`--public`, `--private`, or `--internal`). For example, `gh repo create project-name --public`. To clone the repository locally, pass the `--clone` flag. For more information about possible arguments, see the [GitHub CLI manual](https://cli.github.com/manual/gh_repo_create). diff --git a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md index d0491e93f6..c1765c669b 100644 --- a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md +++ b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md @@ -45,7 +45,7 @@ For more information, see "[About identity and access management with SAML singl ## Setting up your trial of {% data variables.product.prodname_ghe_cloud %} -Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be signed into a user account. If you don't already have a user account on {% data variables.product.prodname_dotcom_the_website %}, you must create one. For more information, see "Signing up for a new {% data variables.product.prodname_dotcom %} account." +Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be signed into a personal account. If you don't already have a personal account on {% data variables.product.prodname_dotcom_the_website %}, you must create one. For more information, see "Signing up for a new {% data variables.product.prodname_dotcom %} account." 1. Navigate to [{% data variables.product.prodname_dotcom %} for enterprises](https://github.com/enterprise). 1. Click **Start a free trial**. diff --git a/content/get-started/signing-up-for-github/signing-up-for-a-new-github-account.md b/content/get-started/signing-up-for-github/signing-up-for-a-new-github-account.md index 5b23ef648f..fbf8f42c88 100644 --- a/content/get-started/signing-up-for-github/signing-up-for-a-new-github-account.md +++ b/content/get-started/signing-up-for-github/signing-up-for-a-new-github-account.md @@ -1,7 +1,7 @@ --- title: Signing up for a new GitHub account shortTitle: Sign up for a new GitHub account -intro: '{% data variables.product.company_short %} offers user accounts for individuals and organizations for teams of people working together.' +intro: '{% data variables.product.company_short %} offers personal accounts for individuals and organizations for teams of people working together.' redirect_from: - /articles/signing-up-for-a-new-github-account - /github/getting-started-with-github/signing-up-for-a-new-github-account diff --git a/content/get-started/using-github/exploring-early-access-releases-with-feature-preview.md b/content/get-started/using-github/exploring-early-access-releases-with-feature-preview.md index 3b8bdfe7b5..be4d105c07 100644 --- a/content/get-started/using-github/exploring-early-access-releases-with-feature-preview.md +++ b/content/get-started/using-github/exploring-early-access-releases-with-feature-preview.md @@ -1,6 +1,6 @@ --- title: Exploring early access releases with feature preview -intro: You can use feature preview to see products or features that are available in beta and to enable or disable each feature for your user account. +intro: You can use feature preview to see products or features that are available in beta and to enable or disable each feature for your personal account. redirect_from: - /articles/exploring-early-access-releases-with-feature-preview - /github/getting-started-with-github/exploring-early-access-releases-with-feature-preview diff --git a/content/get-started/using-github/github-command-palette.md b/content/get-started/using-github/github-command-palette.md index d4310ff5a6..293ae6772c 100644 --- a/content/get-started/using-github/github-command-palette.md +++ b/content/get-started/using-github/github-command-palette.md @@ -14,7 +14,7 @@ You can navigate, search, and run commands on {% data variables.product.product_ ### Fast navigation -When you open the command palette, the suggestions are optimized to give you easy access from anywhere in a repository, user account, or organization to top-level pages like the Issues page. If the location you want isn't listed, start entering the name or number for the location to refine the suggestions. +When you open the command palette, the suggestions are optimized to give you easy access from anywhere in a repository, personal account, or organization to top-level pages like the Issues page. If the location you want isn't listed, start entering the name or number for the location to refine the suggestions. ![Command palette repository suggestions](/assets/images/help/command-palette/command-palette-navigation-repo-default.png) @@ -192,10 +192,10 @@ These commands are available only when you open the command palette from a discu | Command | Behavior| | :- | :- | -|`Delete discussion...`|Permanently delete the discussion. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion)." +|`Delete discussion...`|Permanently delete the discussion. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#deleting-a-discussion)." |`Edit discussion body`|Open the main body of the discussion ready for editing. |`Subscribe`/`unsubscribe`|Opt in or out of notifications for additions to the discussion. For more information, see "[About notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." -|`Transfer discussion...`|Move the discussion to a different repository. For more information, see "[Managing discussions in your repository](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#transferring-a-discussion)." +|`Transfer discussion...`|Move the discussion to a different repository. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#transferring-a-discussion)." ### Issue commands diff --git a/content/get-started/using-github/github-mobile.md b/content/get-started/using-github/github-mobile.md index 7ba35d45a2..e99da062ad 100644 --- a/content/get-started/using-github/github-mobile.md +++ b/content/get-started/using-github/github-mobile.md @@ -35,7 +35,7 @@ To install {% data variables.product.prodname_mobile %} for Android or iOS, see ## Managing accounts -You can be simultaneously signed into mobile with one user account on {% data variables.product.prodname_dotcom_the_website %} and one user account on {% data variables.product.prodname_ghe_server %}. For more information about our different products, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products)." +You can be simultaneously signed into mobile with one personal account on {% data variables.product.prodname_dotcom_the_website %} and one personal account on {% data variables.product.prodname_ghe_server %}. For more information about our different products, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products)." {% data reusables.mobile.push-notifications-on-ghes %} @@ -47,15 +47,15 @@ You must install {% data variables.product.prodname_mobile %} 1.4 or later on yo To use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, {% data variables.product.product_location %} must be version 3.0 or greater, and your enterprise owner must enable mobile support for your enterprise. For more information, see {% ifversion ghes %}"[Release notes](/enterprise-server/admin/release-notes)" and {% endif %}"[Managing {% data variables.product.prodname_mobile %} for your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} -During the beta for {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, you must be signed in with a user account on {% data variables.product.prodname_dotcom_the_website %}. +During the beta for {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, you must be signed in with a personal account on {% data variables.product.prodname_dotcom_the_website %}. ### Adding, switching, or signing out of accounts -You can sign into mobile with a user account on {% data variables.product.prodname_ghe_server %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap {% octicon "plus" aria-label="The plus icon" %} **Add Enterprise Account**. Follow the prompts to sign in. +You can sign into mobile with a personal account on {% data variables.product.prodname_ghe_server %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap {% octicon "plus" aria-label="The plus icon" %} **Add Enterprise Account**. Follow the prompts to sign in. -After you sign into mobile with a user account on {% data variables.product.prodname_ghe_server %}, you can switch between the account and your account on {% data variables.product.prodname_dotcom_the_website %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap the account you want to switch to. +After you sign into mobile with a personal account on {% data variables.product.prodname_ghe_server %}, you can switch between the account and your account on {% data variables.product.prodname_dotcom_the_website %}. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, then tap the account you want to switch to. -If you no longer need to access data for your user account on {% data variables.product.prodname_ghe_server %} from {% data variables.product.prodname_mobile %}, you can sign out of the account. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, swipe left on the account to sign out of, then tap **Sign out**. +If you no longer need to access data for your personal account on {% data variables.product.prodname_ghe_server %} from {% data variables.product.prodname_mobile %}, you can sign out of the account. At the bottom of the app, long-press {% octicon "person" aria-label="The person icon" %} **Profile**, swipe left on the account to sign out of, then tap **Sign out**. ## Supported languages for {% data variables.product.prodname_mobile %} diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md b/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md index 8069f9a67c..3196401bf7 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md @@ -50,7 +50,7 @@ Look! You can see my backticks. ## Syntax highlighting - + You can add an optional language identifier to enable syntax highlighting in your fenced code block. diff --git a/content/get-started/writing-on-github/working-with-saved-replies/about-saved-replies.md b/content/get-started/writing-on-github/working-with-saved-replies/about-saved-replies.md index 2ae1a14606..9769484549 100644 --- a/content/get-started/writing-on-github/working-with-saved-replies/about-saved-replies.md +++ b/content/get-started/writing-on-github/working-with-saved-replies/about-saved-replies.md @@ -15,7 +15,7 @@ versions: Saved replies allow you to create a reusable response to issues and pull requests. Save time by creating a saved reply for the responses you use most frequently. -Once you've added a saved reply, it can be used in both issues and pull requests. Saved replies are tied to your user account. Once they're created, you'll be able to use them across repositories and organizations. +Once you've added a saved reply, it can be used in both issues and pull requests. Saved replies are tied to your personal account. Once they're created, you'll be able to use them across repositories and organizations. You can create a maximum of 100 saved replies. If you've reached the maximum limit, you can delete saved replies that you no longer use or edit existing saved replies. diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md index 4dbbbda931..c75fb54ace 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md @@ -20,7 +20,7 @@ When you close a project board, any configured workflow automation will pause by If you reopen a project board, you have the option to *sync* automation, which updates the position of the cards on the board according to the automation settings configured for the board. For more information, see "[Reopening a closed project board](/articles/reopening-a-closed-project-board)" or "[About automation for project boards](/articles/about-automation-for-project-boards)." -1. Navigate to the list of project boards in your repository or organization, or owned by your user account. +1. Navigate to the list of project boards in your repository or organization, or owned by your personal account. 2. In the projects list, next to the project board you want to close, click {% octicon "chevron-down" aria-label="The chevron icon" %}. ![Chevron icon to the right of the project board's name](/assets/images/help/projects/project-list-action-chevron.png) 3. Click **Close**. diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md index af06039252..1c5c663bc8 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md @@ -1,6 +1,6 @@ --- title: Linking a repository to a project board -intro: You can link a repository to your organization's or user account's project board. +intro: You can link a repository to your organization's or personal account's project board. redirect_from: - /github/managing-your-work-on-github/managing-project-boards/linking-a-repository-to-a-project-board - /articles/linking-a-repository-to-a-project-board @@ -16,7 +16,7 @@ shortTitle: Link repository to board --- {% data reusables.projects.project_boards_old %} -Anyone with write permissions to a project board can link repositories owned by that organization or user account to the project board. For more information, see "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization/)" or "[Permission levels for user-owned project boards](/articles/permission-levels-for-user-owned-project-boards/)." +Anyone with write permissions to a project board can link repositories owned by that organization or personal account to the project board. For more information, see "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization/)" or "[Permission levels for user-owned project boards](/articles/permission-levels-for-user-owned-project-boards/)." {% data reusables.project-management.link-repos-to-project-board %} You can add issues and pull requests from any unlinked repositories by typing the issue or pull request URL in a card. For more information, see "[Adding issues and pull requests to a project board](/articles/adding-issues-and-pull-requests-to-a-project-board)." diff --git a/content/issues/tracking-your-work-with-issues/deleting-an-issue.md b/content/issues/tracking-your-work-with-issues/deleting-an-issue.md index a23f051cf7..441d30b631 100644 --- a/content/issues/tracking-your-work-with-issues/deleting-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/deleting-an-issue.md @@ -14,7 +14,7 @@ versions: topics: - Pull requests --- -You can only delete issues in a repository owned by your user account. You cannot delete issues in a repository owned by another user account, even if you are a collaborator there. +You can only delete issues in a repository owned by your personal account. You cannot delete issues in a repository owned by another personal account, even if you are a collaborator there. To delete an issue in a repository owned by an organization, an organization owner must enable deleting an issue for the organization's repositories, and you must have admin or owner permissions in the repository. For more information, see "[Allowing people to delete issues in your organization](/articles/allowing-people-to-delete-issues-in-your-organization)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." diff --git a/content/organizations/collaborating-with-your-team/about-team-discussions.md b/content/organizations/collaborating-with-your-team/about-team-discussions.md index 92530700df..04845b1e72 100644 --- a/content/organizations/collaborating-with-your-team/about-team-discussions.md +++ b/content/organizations/collaborating-with-your-team/about-team-discussions.md @@ -42,6 +42,14 @@ To turn off notifications for team discussions, you can unsubscribe to a specifi For more information, see {% ifversion fpt or ghae or ghes or ghec %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Subscribing to and unsubscribing from notifications](/github/receiving-notifications-about-activity-on-github/subscribing-to-and-unsubscribing-from-notifications){% endif %}" and "[Nested teams](/articles/about-teams/#nested-teams)." +{% ifversion fpt or ghec %} + +## Organization discussions + +You can also use organization discussions to facilitate conversations across your organization. For more information, see "[Enabling or disabling GitHub Discussions for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." + +{% endif %} + ## Further reading - "[Quickstart for communicating on {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/quickstart-for-communicating-on-github)" diff --git a/content/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization.md b/content/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization.md index 770c8fe053..b14cd58d67 100644 --- a/content/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization.md @@ -29,7 +29,7 @@ An organization owner can restrict the ability to invite collaborators. For more {% endif %} {% ifversion ghes %} -Before you can add someone as an outside collaborator on a repository, the person must have a user account on {% data variables.product.product_location %}. If your enterprise uses an external authentication system such as SAML or LDAP, the person you want to add must sign in through that system to create an account. If the person does not have access to the authentication system and built-in authentication is enabled for your enterprise, a site admin can create a user account for the person. For more information, see "[Using built-in authentication](/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-built-in-authentication#inviting-users)." +Before you can add someone as an outside collaborator on a repository, the person must have a personal account on {% data variables.product.product_location %}. If your enterprise uses an external authentication system such as SAML or LDAP, the person you want to add must sign in through that system to create an account. If the person does not have access to the authentication system and built-in authentication is enabled for your enterprise, a site admin can create a personal account for the person. For more information, see "[Using built-in authentication](/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-built-in-authentication#inviting-users)." {% endif %} {% ifversion not ghae %} diff --git a/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md b/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md index 1e53639563..e683bc0f10 100644 --- a/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md +++ b/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md @@ -136,15 +136,15 @@ Some of the features listed below are limited to organizations using {% data var | Display a sponsor button (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") | | | | | **X** |{% endif %} | Create autolink references to external resources, like Jira or Zendesk (see "[Configuring autolinks to reference external resources](/articles/configuring-autolinks-to-reference-external-resources)") | | | | | **X** |{% ifversion fpt or ghec %} | [Enable {% data variables.product.prodname_discussions %}](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository) in a repository | | | | **X** | **X** | -| [Create and edit categories](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository) for {% data variables.product.prodname_discussions %} | | | | **X** | **X** | -| [Move a discussion to a different category](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) | | | **X** | **X** | **X** | -| [Transfer a discussion](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) to a new repository| | | **X** | **X** | **X** | -| [Manage pinned discussions](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) | | | **X** | **X** | **X** | -| [Convert issues to discussions in bulk](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) | | | **X** | **X** | **X** | +| [Create and edit categories](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions) for {% data variables.product.prodname_discussions %} | | | | **X** | **X** | +| [Move a discussion to a different category](/discussions/managing-discussions-for-your-community/managing-discussions) | | | **X** | **X** | **X** | +| [Transfer a discussion](/discussions/managing-discussions-for-your-community/managing-discussions) to a new repository| | | **X** | **X** | **X** | +| [Manage pinned discussions](/discussions/managing-discussions-for-your-community/managing-discussions) | | | **X** | **X** | **X** | +| [Convert issues to discussions in bulk](/discussions/managing-discussions-for-your-community/managing-discussions) | | | **X** | **X** | **X** | | [Lock and unlock discussions](/discussions/managing-discussions-for-your-community/moderating-discussions) | | **X** | **X** | **X** | **X** | | [Individually convert issues to discussions](/discussions/managing-discussions-for-your-community/moderating-discussions) | | **X** | **X** | **X** | **X** | | [Create new discussions and comment on existing discussions](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion) | **X** | **X** | **X** | **X** | **X** | -| [Delete a discussion](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion) | | **X** | | **X** | **X** |{% endif %}{% ifversion fpt or ghec %} +| [Delete a discussion](/discussions/managing-discussions-for-your-community/managing-discussions#deleting-a-discussion) | | **X** | | **X** | **X** |{% endif %}{% ifversion fpt or ghec %} | Create [codespaces](/codespaces/about-codespaces) | | | **X** | **X** | **X** |{% endif %} ### Access requirements for security features diff --git a/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md b/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md index fcbc84c3ef..df0d9f4de7 100644 --- a/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md +++ b/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md @@ -1,6 +1,6 @@ --- title: Can I create accounts for people in my organization? -intro: 'While you can add users to an organization you''ve created, you can''t create personal user accounts on behalf of another person.' +intro: 'While you can add users to an organization you''ve created, you can''t create personal accounts on behalf of another person.' redirect_from: - /articles/can-i-create-accounts-for-those-in-my-organization - /articles/can-i-create-accounts-for-people-in-my-organization @@ -14,18 +14,18 @@ topics: shortTitle: Create accounts for people --- -## About user accounts +## About personal accounts -Because you access an organization by logging in to a user account, each of your team members needs to create their own user account. After you have usernames for each person you'd like to add to your organization, you can add the users to teams. +Because you access an organization by logging in to a personal account, each of your team members needs to create their own personal account. After you have usernames for each person you'd like to add to your organization, you can add the users to teams. {% ifversion fpt or ghec %} -{% ifversion fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %}{% else %}You{% endif %} can use SAML single sign-on to centrally manage the access that user accounts have to the organization's resources through an identity provider (IdP). For more information, see "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +{% ifversion fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %}{% else %}You{% endif %} can use SAML single sign-on to centrally manage the access that personal accounts have to the organization's resources through an identity provider (IdP). For more information, see "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} You can also consider {% data variables.product.prodname_emus %}. {% data reusables.enterprise-accounts.emu-short-summary %} {% endif %} ## Adding users to your organization -1. Provide each person instructions to [create a user account](/articles/signing-up-for-a-new-github-account). +1. Provide each person instructions to [create a personal account](/articles/signing-up-for-a-new-github-account). 2. Ask for the username of each person you want to give organization membership to. 3. [Invite the new personal accounts to join](/articles/inviting-users-to-join-your-organization) your organization. Use [organization roles](/articles/permission-levels-for-an-organization) and [repository permissions](/articles/repository-permission-levels-for-an-organization) to limit the access of each account. diff --git a/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md b/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md index c303abd963..8c989dfce9 100644 --- a/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md +++ b/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md @@ -1,6 +1,6 @@ --- title: Converting an organization into a user -intro: 'It''s not possible to convert an organization into a personal user account, but you can create a new user account and transfer the organization''s repositories to it.' +intro: 'It''s not possible to convert an organization into a personal account, but you can create a new personal account and transfer the organization''s repositories to it.' redirect_from: - /articles/converting-an-organization-into-a-user - /github/setting-up-and-managing-organizations-and-teams/converting-an-organization-into-a-user @@ -22,10 +22,10 @@ shortTitle: Convert organization to user {% endnote %} -1. [Sign up](/articles/signing-up-for-a-new-github-account) for a new GitHub user account. +1. [Sign up](/articles/signing-up-for-a-new-github-account) for a new account on GitHub. 2. [Have the user's role changed to an owner](/articles/changing-a-person-s-role-to-owner). -3. {% data variables.product.signin_link %} to the new user account. -4. [Transfer each organization repository](/articles/how-to-transfer-a-repository) to the new user account. +3. {% data variables.product.signin_link %} to the new personal account. +4. [Transfer each organization repository](/articles/how-to-transfer-a-repository) to the new personal account. 5. [Rename the organization](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username) to make the current username available. 6. [Rename the user](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username) to the organization's name. 7. [Delete the organization](/organizations/managing-organization-settings/deleting-an-organization-account). @@ -33,10 +33,10 @@ shortTitle: Convert organization to user {% else %} -1. Sign up for a new GitHub Enterprise user account. +1. Sign up for a new GitHub Enterprise personal account. 2. [Have the user's role changed to an owner](/articles/changing-a-person-s-role-to-owner). -3. {% data variables.product.signin_link %} to the new user account. -4. [Transfer each organization repository](/articles/how-to-transfer-a-repository) to the new user account. +3. {% data variables.product.signin_link %} to the new personal account. +4. [Transfer each organization repository](/articles/how-to-transfer-a-repository) to the new personal account. 5. [Delete the organization](/articles/deleting-an-organization-account). 6. [Rename the user](/articles/changing-your-github-username) to the organization's name. diff --git a/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md new file mode 100644 index 0000000000..fddfc4e34c --- /dev/null +++ b/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -0,0 +1,27 @@ +--- +title: Enabling or disabling GitHub Discussions for an organization +intro: "You can use {% data variables.product.prodname_discussions %} in a organization as a place for your organization to have conversations that aren't specific to a single repository within your organization." +permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' +versions: + fpt: '*' + ghec: '*' +topics: + - Organizations +shortTitle: Organization discussions +--- + +## About organization discussions + +{% data reusables.discussions.about-organization-discussions %} + +You can also manage repository discussions. For more information, see "[Enabling or disabling GitHub Discussions for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository)" and "[Managing discussion creation for repositories in your organization](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)." + +## Enabling or disabling {% data variables.product.prodname_discussions %} for your organization + +{% data reusables.discussions.enabling-or-disabling-github-discussions-for-your-organization %} +1. To disable discussions, under "Discussions", unselect **Enable discussions for this organization**. + +## Further reading + +- "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" +- "[Managing discussions for your community](/discussions/managing-discussions-for-your-community)" diff --git a/content/organizations/managing-organization-settings/index.md b/content/organizations/managing-organization-settings/index.md index 22425868a8..bc6d67da79 100644 --- a/content/organizations/managing-organization-settings/index.md +++ b/content/organizations/managing-organization-settings/index.md @@ -25,6 +25,7 @@ children: - /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization - /setting-permissions-for-adding-outside-collaborators - /allowing-people-to-delete-issues-in-your-organization + - /enabling-or-disabling-github-discussions-for-an-organization - /managing-discussion-creation-for-repositories-in-your-organization - /setting-team-creation-permissions-in-your-organization - /managing-scheduled-reminders-for-your-organization diff --git a/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md b/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md index 0e4d88206a..a42c17544f 100644 --- a/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md @@ -10,7 +10,7 @@ versions: topics: - Organizations - Teams -shortTitle: Manage discussion creation +shortTitle: Manage repository discussions --- @@ -30,3 +30,4 @@ By default, organization members with read access can create discussions if a re - "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" - "[Managing discussions for your community](/discussions/managing-discussions-for-your-community)" +- "[Enabling or disabling GitHub Discussions for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)" diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md index e87bf93da5..79be133139 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md @@ -14,7 +14,7 @@ shortTitle: Enforce SAML single sign-on ## About enforcement of SAML SSO for your organization -When you enable SAML SSO, {% data variables.product.prodname_dotcom %} will prompt members who visit the organization's resources on {% data variables.product.prodname_dotcom_the_website %} to authenticate on your IdP, which links the member's user account to an identity on the IdP. Members can still access the organization's resources before authentication with your IdP. +When you enable SAML SSO, {% data variables.product.prodname_dotcom %} will prompt members who visit the organization's resources on {% data variables.product.prodname_dotcom_the_website %} to authenticate on your IdP, which links the member's personal account to an identity on the IdP. Members can still access the organization's resources before authentication with your IdP. ![Banner with prompt to authenticate via SAML SSO to access organization](/assets/images/help/saml/sso-has-been-enabled.png) diff --git a/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md b/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md index ff81228bf5..9bab3ac5d7 100644 --- a/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md +++ b/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md @@ -47,7 +47,7 @@ To manage repository access for any {% data variables.product.prodname_dotcom %} After you connect a team to an IdP group, team synchronization will add each member of the IdP group to the corresponding team on {% data variables.product.product_name %} only if: - The person is a member of the organization on {% data variables.product.product_name %}. -- The person has already logged in with their user account on {% data variables.product.product_name %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. +- The person has already logged in with their personal account on {% data variables.product.product_name %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. - The person's SSO identity is a member of the IdP group. Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.product_name %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/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)" and "[Viewing and managing a user's SAML access to your enterprise](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." diff --git a/content/organizations/restricting-access-to-your-organizations-data/index.md b/content/organizations/restricting-access-to-your-organizations-data/index.md index 7f390f693f..0aa5344884 100644 --- a/content/organizations/restricting-access-to-your-organizations-data/index.md +++ b/content/organizations/restricting-access-to-your-organizations-data/index.md @@ -1,6 +1,6 @@ --- title: Restricting access to your organization's data -intro: '{% data variables.product.prodname_oauth_app %} access restrictions allow organization owners to restrict an untrusted app''s access to the organization''s data. Organization members can then use {% data variables.product.prodname_oauth_apps %} for their personal user accounts while keeping organization data safe.' +intro: '{% data variables.product.prodname_oauth_app %} access restrictions allow organization owners to restrict an untrusted app''s access to the organization''s data. Organization members can then use {% data variables.product.prodname_oauth_apps %} for their personal accounts while keeping organization data safe.' redirect_from: - /articles/restricting-access-to-your-organization-s-data - /articles/restricting-access-to-your-organizations-data diff --git a/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/content/packages/learn-github-packages/about-permissions-for-github-packages.md index 4205f11706..f1315c0ce6 100644 --- a/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -43,7 +43,7 @@ For more information, see "[Configuring a package's access control and visibilit ## About scopes and permissions for package registries -To use or manage a package hosted by a package registry, you must use a token with the appropriate scope, and your user account must have appropriate permissions. +To use or manage a package hosted by a package registry, you must use a token with the appropriate scope, and your personal account must have appropriate permissions. For example: - To download and install packages from a repository, your token must have the `read:packages` scope, and your user account must have read permission. diff --git a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 293248895a..646dc654f3 100644 --- a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -23,12 +23,12 @@ For more information about permissions for repository-scoped packages, packages- ## Configuring access to container images for your personal account -If you have admin permissions to a container image that's owned by a user account, you can assign read, write, or admin roles to other users. For more information about these permission roles, see "[Visibility and access permissions for container images](#visibility-and-access-permissions-for-container-images)." +If you have admin permissions to a container image that's owned by a personal account, you can assign read, write, or admin roles to other users. For more information about these permission roles, see "[Visibility and access permissions for container images](#visibility-and-access-permissions-for-container-images)." If your package is private or internal and owned by an organization, then you can only give access to other organization members or teams. {% data reusables.package_registry.package-settings-from-user-level %} -1. On the package settings page, click **Invite teams or people** and enter the name, username, or email of the person you want to give access. Teams cannot be given access to a container image owned by a user account. +1. On the package settings page, click **Invite teams or people** and enter the name, username, or email of the person you want to give access. Teams cannot be given access to a container image owned by a personal account. ![Container access invite button](/assets/images/help/package-registry/container-access-invite.png) 1. Next to the username or team name, use the "Role" drop-down menu to select a desired permission level. ![Container access options](/assets/images/help/package-registry/container-access-control-options.png) diff --git a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index 5c3da7dcb8..24d07b2f9f 100644 --- a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -196,7 +196,7 @@ For example, if you have a deleted RubyGems package named `octo-package` that wa {% ifversion fpt or ghec %} To restore a deleted package, you must also meet one of these permission requirements: - For repository-scoped packages: You have admin permissions to the repository that owns the deleted package.{% ifversion fpt or ghec %} - - For user-account scoped packages: Your user account owns the deleted package. + - For user-account scoped packages: Your personal account owns the deleted package. - For organization-scoped packages: You have admin permissions to the deleted package in the organization that owns the package.{% endif %} {% endif %} @@ -226,7 +226,7 @@ To review who can restore a package in an organization, see "[Required permissio ### Restoring a user-account scoped package -You can restore a deleted package through your user account settings, if the package was in one of your repositories or scoped to your user account. For more information, see "[Required permissions](#required-permissions-to-delete-or-restore-a-package)." +You can restore a deleted package through your personal account settings, if the package was in one of your repositories or scoped to your personal account. For more information, see "[Required permissions](#required-permissions-to-delete-or-restore-a-package)." {% data reusables.user-settings.access_settings %} 2. On the left, click **Packages**. diff --git a/content/packages/learn-github-packages/introduction-to-github-packages.md b/content/packages/learn-github-packages/introduction-to-github-packages.md index 2f92adc46d..1ffeed2655 100644 --- a/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -58,7 +58,7 @@ For more information, see "[About permissions for {% data variables.product.prod {% endif %} ## Supported clients and formats - + {% data variables.product.prodname_registry %} uses the native package tooling commands you're already familiar with to publish and install package versions. ### Support for package registries diff --git a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index d0f1a2c013..7fcf4bb332 100644 --- a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -51,7 +51,7 @@ When you enable GitHub Actions, GitHub installs a GitHub App on your repository. {% ifversion fpt or ghec %} ## About permissions and package access for {% data variables.product.prodname_container_registry %} -The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal user account and you can customize access to each of your containers separately from repository permissions. +The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal account and you can customize access to each of your containers separately from repository permissions. All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." diff --git a/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md b/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md index b5b1def21b..171022b7e2 100644 --- a/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md +++ b/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md @@ -30,7 +30,7 @@ After your Docker images have been migrated to the {% data variables.product.pro The {% data variables.product.prodname_container_registry %} is optimized to support some of the unique needs of containers. With the {% data variables.product.prodname_container_registry %} you can: -- Store container images within your organization and user account, or connect them to a repository. +- Store container images within your organization and personal account, or connect them to a repository. - Choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. - Access public container images anonymously. diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md index cd835bf35f..b46d62fb81 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md @@ -43,7 +43,7 @@ dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB To authenticate to {% data variables.product.prodname_registry %} with the `dotnet` command-line interface (CLI), create a *nuget.config* file in your project directory specifying {% data variables.product.prodname_registry %} as a source under `packageSources` for the `dotnet` CLI client. You must replace: -- `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}. +- `USERNAME` with the name of your personal account on {% data variables.product.prodname_dotcom %}. - `TOKEN` with your personal access token. - `OWNER` with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes or ghae %} - `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages.md index 3a73d0fcc1..6c0cb23014 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages.md @@ -12,7 +12,7 @@ shortTitle: Verify a custom domain ## About domain verification for GitHub Pages -When you verify your custom domain for your user account or organization, only repositories owned by your user account or organization may be used to publish a {% data variables.product.prodname_pages %} site to the verified custom domain or the domain's immediate subdomains. +When you verify your custom domain for your personal account or organization, only repositories owned by your personal account or organization may be used to publish a {% data variables.product.prodname_pages %} site to the verified custom domain or the domain's immediate subdomains. Verifying your domain stops other GitHub users from taking over your custom domain and using it to publish their own {% data variables.product.prodname_pages %} site. Domain takeovers can happen when you delete your repository, when your billing plan is downgraded, or after any other change which unlinks the custom domain or disables {% data variables.product.prodname_pages %} while the domain remains configured for {% data variables.product.prodname_pages %} and is not verified. diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index 72814d0494..c08cce16f8 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -42,7 +42,7 @@ Organization owners can disable the publication of {% data variables.product.pro There are three types of {% data variables.product.prodname_pages %} sites: project, user, and organization. Project sites are connected to a specific project hosted on {% data variables.product.product_name %}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. -To publish a user site, you must create a repository owned by your user account that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://.github.io` or `http(s)://.github.io`.{% elsif ghae %}User and organization sites are available at `http(s)://pages./` or `http(s)://pages./`.{% endif %} +To publish a user site, you must create a repository owned by your personal account that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://.github.io` or `http(s)://.github.io`.{% elsif ghae %}User and organization sites are available at `http(s)://pages./` or `http(s)://pages./`.{% endif %} The source files for a project site are stored in the same repository as their project. {% ifversion fpt or ghec %}Unless you're using a custom domain, project sites are available at `http(s)://.github.io/` or `http(s)://.github.io/`.{% elsif ghae %}Project sites are available at `http(s)://pages.///` or `http(s)://pages.///`.{% endif %} @@ -54,7 +54,7 @@ If you publish your site privately, the URL for your site will be different. For For more information about how custom domains affect the URL for your site, see "[About custom domains and {% data variables.product.prodname_pages %}](/articles/about-custom-domains-and-github-pages)." {% endif %} -You can only create one user or organization site for each account on {% data variables.product.product_name %}. Project sites, whether owned by an organization or a user account, are unlimited. +You can only create one user or organization site for each account on {% data variables.product.product_name %}. Project sites, whether owned by an organization or a personal account, are unlimited. {% ifversion ghes %} The URL where your site is available depends on whether subdomain isolation is enabled for {% data variables.product.product_location %}. @@ -63,7 +63,7 @@ The URL where your site is available depends on whether subdomain isolation is e | ------------ | --------------------------- | ---------------------------- | User | `http(s)://pages./` | `http(s):///pages/` | Organization | `http(s)://pages./` | `http(s):///pages/` | -Project site owned by user account | `http(s)://pages.///` | `http(s):///pages///` +Project site owned by personal account | `http(s)://pages.///` | `http(s):///pages///` Project site owned by organization account | `http(s)://pages.///` | `http(s):///pages///` For more information, see "[Enabling subdomain isolation](/enterprise/{{ currentVersion }}/admin/installation/enabling-subdomain-isolation)" or contact your site administrator. diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md index 2e1c7f916a..4ce18de40c 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md @@ -16,6 +16,7 @@ topics: - Pull requests shortTitle: Request a PR review --- + Repositories belong to a personal account (a single individual owner) or an organization account (a shared account with numerous collaborators or maintainers). For more information, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)." Owners and collaborators on a repository owned by a personal account can assign pull request reviews. Organization members with triage permissions can also assign a reviewer for a pull request. To assign a reviewer to a pull request, you will need write access to the repository. For more information about repository access, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." If you have write access, you can assign anyone who has read access to the repository as a reviewer. diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md index 4c60cd9648..50b8fb10c6 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -1,12 +1,12 @@ --- title: Allowing changes to a pull request branch created from a fork -intro: 'For greater collaboration, you can allow commits on branches you''ve created from forks owned by your user account.' +intro: 'For greater collaboration, you can allow commits on branches you''ve created from forks owned by your personal account.' redirect_from: - /github/collaborating-with-issues-and-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork - /articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork - /github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork - /github/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork -permissions: People with push access to the upstream repository of a fork owned by a user account can commit to the forked branches. +permissions: People with push access to the upstream repository of a fork owned by a personal account can commit to the forked branches. versions: fpt: '*' ghes: '*' diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index 2a067051d5..746627d43f 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -66,7 +66,7 @@ If a private repository is made public and then deleted, its private forks will -If the policy for your enterprise permits forking, any fork of an internal repository will be private. If you change the visibility of an internal repository, any fork owned by an organization or user account will remain private. +If the policy for your enterprise permits forking, any fork of an internal repository will be private. If you change the visibility of an internal repository, any fork owned by an organization or personal account will remain private. ### Deleting the internal repository diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index c8625b4888..251a1f2449 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -181,7 +181,7 @@ By default, {% data variables.product.product_name %} blocks force pushes on all Enabling force pushes will not override any other branch protection rules. For example, if a branch requires a linear commit history, you cannot force push merge commits to that branch. -{% ifversion ghes or ghae %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[Blocking force pushes to repositories owned by a user account or organization](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)." +{% ifversion ghes or ghae %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[Blocking force pushes to repositories owned by a personal account or organization](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)." If a site administrator has blocked force pushes to the default branch only, you can still enable force pushes for any other protected branch.{% endif %} diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md index 57a56440e4..2569058c58 100644 --- a/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -26,10 +26,10 @@ You can own repositories individually, or you can share ownership of repositorie You can restrict who has access to a repository by choosing the repository's visibility. For more information, see "[About repository visibility](#about-repository-visibility)." -For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a personal account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." {% ifversion fpt or ghec %} -With {% data variables.product.prodname_free_team %} for user accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} +With {% data variables.product.prodname_free_team %} for personal accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} {% else %} Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories. {% endif %} @@ -52,7 +52,7 @@ When you create a repository, you can choose to make the repository public or pr {% elsif ghae %} -When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal. +When you create a repository owned by your personal account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal. {% endif %} @@ -90,7 +90,7 @@ All enterprise members have read permissions to the internal repository, but int {% data reusables.repositories.internal-repo-default %} -Any member of the enterprise can fork any internal repository owned by an organization in the enterprise. The forked repository will belong to the member's user account, and the visibility of the fork will be private. If a user is removed from all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically. +Any member of the enterprise can fork any internal repository owned by an organization in the enterprise. The forked repository will belong to the member's personal account, and the visibility of the fork will be private. If a user is removed from all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically. {% endif %} ## Limits for viewing content and diffs in a repository 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 61e9830a7a..33fc1cbfe5 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 @@ -15,7 +15,7 @@ topics: shortTitle: Restore deleted repository --- {% ifversion fpt or ghec %} -Anyone can restore deleted repositories that were owned by their own user account. Organization owners can restore deleted repositories that were owned by the organization. +Anyone can restore deleted repositories that were owned by their own personal account. Organization owners can restore deleted repositories that were owned by the organization. ## About repository restoration @@ -27,7 +27,7 @@ It can take up to an hour after a repository is deleted before that repository i Restoring a repository will not restore release attachments or team permissions. Issues that are restored will not be labeled. -## Restoring a deleted repository that was owned by a user account +## Restoring a deleted repository that was owned by a personal account {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.repo-tab %} diff --git a/content/repositories/creating-and-managing-repositories/transferring-a-repository.md b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md index b909b7a8aa..626ea8eefa 100644 --- a/content/repositories/creating-and-managing-repositories/transferring-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -27,7 +27,7 @@ topics: When you transfer a repository to a new owner, they can immediately administer the repository's contents, issues, pull requests, releases, project boards, and settings. Prerequisites for repository transfers: -- When you transfer a repository that you own to another user account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. If the new owner doesn't accept the transfer within one day, the invitation will expire.{% endif %} +- When you transfer a repository that you own to another personal account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. If the new owner doesn't accept the transfer within one day, the invitation will expire.{% endif %} - To transfer a repository that you own to an organization, you must have permission to create a repository in the target organization. - The target account must not have a repository with the same name, or a fork in the same network. - The original owner of the repository is added as a collaborator on the transferred repository. Other collaborators to the transferred repository remain intact.{% ifversion ghec or ghes or ghae %} @@ -42,8 +42,8 @@ When you transfer a repository, its issues, pull requests, wiki, stars, and watc - If the transferred repository is a fork, then it remains associated with the upstream repository. - If the transferred repository has any forks, then those forks will remain associated with the repository after the transfer is complete. -- If the transferred repository uses {% data variables.large_files.product_name_long %}, all {% data variables.large_files.product_name_short %} objects are automatically moved. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. For more information on adding storage for user accounts, see "[Upgrading {% data variables.large_files.product_name_long %}](/articles/upgrading-git-large-file-storage)."{% endif %} -- When a repository is transferred between two user accounts, issue assignments are left intact. When you transfer a repository from a user account to an organization, issues assigned to members in the organization remain intact, and all other issue assignees are cleared. Only owners in the organization are allowed to create new issue assignments. When you transfer a repository from an organization to a user account, only issues assigned to the repository's owner are kept, and all other issue assignees are removed. +- If the transferred repository uses {% data variables.large_files.product_name_long %}, all {% data variables.large_files.product_name_short %} objects are automatically moved. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. For more information on adding storage for personal accounts, see "[Upgrading {% data variables.large_files.product_name_long %}](/articles/upgrading-git-large-file-storage)."{% endif %} +- When a repository is transferred between two personal accounts, issue assignments are left intact. When you transfer a repository from a personal account to an organization, issues assigned to members in the organization remain intact, and all other issue assignees are cleared. Only owners in the organization are allowed to create new issue assignments. When you transfer a repository from an organization to a personal account, only issues assigned to the repository's owner are kept, and all other issue assignees are removed. - If the transferred repository contains a {% data variables.product.prodname_pages %} site, then links to the Git repository on the Web and through Git activity are redirected. However, we don't redirect {% data variables.product.prodname_pages %} associated with the repository. - All links to the previous repository location are automatically redirected to the new location. When you use `git clone`, `git fetch`, or `git push` on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line: @@ -51,7 +51,7 @@ When you transfer a repository, its issues, pull requests, wiki, stars, and watc $ git remote set-url origin new_url ``` -- When you transfer a repository from an organization to a user account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a user account. For more information about repository permission levels, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)."{% ifversion fpt or ghec %} +- When you transfer a repository from an organization to a personal account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a personal account. For more information about repository permission levels, see "[Permission levels for a personal account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)."{% ifversion fpt or ghec %} - Sponsors who have access to the repository through a sponsorship tier may be affected. For more information, see "[Adding a repository to a sponsorship tier](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier)".{% endif %} For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." @@ -62,9 +62,9 @@ To transfer repositories to an organization, you must have repository creation p Once a repository is transferred to an organization, the organization's default repository permission settings and default membership privileges will apply to the transferred repository. -## Transferring a repository owned by your user account +## Transferring a repository owned by your personal account -You can transfer your repository to any user account that accepts your repository transfer. When a repository is transferred between two user accounts, the original repository owner and collaborators are automatically added as collaborators to the new repository. +You can transfer your repository to any personal account that accepts your repository transfer. When a repository is transferred between two personal accounts, the original repository owner and collaborators are automatically added as collaborators to the new repository. {% ifversion fpt or ghec %}If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, before transferring the repository, you may want to remove or update your DNS records to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %} @@ -74,9 +74,9 @@ You can transfer your repository to any user account that accepts your repositor ## Transferring a repository owned by your organization -If you have owner permissions in an organization or admin permissions to one of its repositories, you can transfer a repository owned by your organization to your user account or to another organization. +If you have owner permissions in an organization or admin permissions to one of its repositories, you can transfer a repository owned by your organization to your personal account or to another organization. -1. Sign into your user account that has admin or owner permissions in the organization that owns the repository. +1. Sign into your personal account that has admin or owner permissions in the organization that owns the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.transfer-repository-steps %} diff --git a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md index 9bfbc3a98d..c76f0712c9 100644 --- a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md +++ b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md @@ -119,7 +119,7 @@ Make sure that you have access to the repository in one of these ways: In rare circumstances, you may not have the proper SSH access to a repository. -You should ensure that the SSH key you are using is attached to your {% data variables.product.product_name %} user account. You can check this by typing +You should ensure that the SSH key you are using is attached to your personal account on {% data variables.product.product_name %}. You can check this by typing the following into the command line: ```shell diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md index fd139c7805..4e99b0c7c3 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md @@ -57,7 +57,7 @@ custom: ["https://www.paypal.me/octocat", octocat.com] {% endnote %} -You can create a default sponsor button for your organization or user account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." +You can create a default sponsor button for your organization or personal account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% note %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md index 29eb1f04f8..94d032b062 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md @@ -19,6 +19,8 @@ shortTitle: Discussions {% data reusables.discussions.enabling-or-disabling-github-discussions-for-your-repository %} 1. To disable discussions, under "Features", unselect **Discussions**. +You can also use organization discussions to facilitate conversations that span multiple repositories in your organization. For more information, see "[Enabling or disabling GitHub Discussions for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." + ## Further reading - "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md index c7332d933e..307eec05cf 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md @@ -24,7 +24,7 @@ This overview can help you audit access to your repository, onboard or off-board {% data reusables.organizations.mixed-roles-warning %} -For more information about repository roles, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." +For more information about repository roles, see "[Permission levels for a personal account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." ![Access management overview](/assets/images/help/repository/manage-access-overview.png) diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index 96c2ccfa4b..3e7da4146c 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -23,7 +23,7 @@ Organization owners can restrict the ability to change repository visibility to {% ifversion ghec %} -Members of an {% data variables.product.prodname_emu_enterprise %} can only set the visibility of repositories owned by their user account to private, and repositories in their enterprise's organizations can only be private or internal. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." +Members of an {% data variables.product.prodname_emu_enterprise %} can only set the visibility of repositories owned by their personal account to private, and repositories in their enterprise's organizations can only be private or internal. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." {% endif %} @@ -51,7 +51,7 @@ We recommend reviewing the following caveats before you change the visibility of {%- endif %} {%- ifversion fpt %} -* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)." +* If you're using {% data variables.product.prodname_free_user %} for personal accounts or organizations, some features won't be available in the repository after you change the visibility to private. Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products) and "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)." {%- endif %} {%- ifversion fpt or ghec %} diff --git a/content/repositories/working-with-files/managing-files/creating-new-files.md b/content/repositories/working-with-files/managing-files/creating-new-files.md index ab6df4bca0..7c08d30086 100644 --- a/content/repositories/working-with-files/managing-files/creating-new-files.md +++ b/content/repositories/working-with-files/managing-files/creating-new-files.md @@ -15,7 +15,7 @@ topics: --- When creating a file on {% data variables.product.product_name %}, consider the following: -- If you try to create a new file in a repository that you don’t have access to, we will fork the project to your user account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. +- If you try to create a new file in a repository that you don’t have access to, we will fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. - File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, [create and commit the files locally, then push them to the repository on {% data variables.product.product_name %}](/articles/adding-a-file-to-a-repository-using-the-command-line). {% data reusables.repositories.sensitive-info-warning %} diff --git a/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md b/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md index 736e8afecd..b8b61ab8c5 100644 --- a/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md +++ b/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md @@ -21,7 +21,7 @@ shortTitle: Delete files You can delete an individual file in your repository{% ifversion fpt or ghes or ghec %} or an entire directory, including all the files in the directory{% endif %}. -If you try to delete a file{% ifversion fpt or ghes or ghec %} or directory{% endif %} in a repository that you don’t have write permissions to, we'll fork the project to your user account and help you send a pull request to the original repository after you commit your change. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." +If you try to delete a file{% ifversion fpt or ghes or ghec %} or directory{% endif %} in a repository that you don’t have write permissions to, we'll fork the project to your personal account and help you send a pull request to the original repository after you commit your change. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." If the file{% ifversion fpt or ghes or ghec %} or directory{% endif %} you deleted contains sensitive data, the data will still be available in the repository's Git history. To completely remove the file from {% data variables.product.product_name %}, you must remove the file from your repository's history. For more information, see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)." diff --git a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md index 04611a377b..fc6581d184 100644 --- a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md +++ b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md @@ -25,7 +25,7 @@ In addition to changing the file location, you can also [update the contents of **Tips**: -- If you try to move a file in a repository that you don’t have access to, we'll fork the project to your user account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. +- If you try to move a file in a repository that you don’t have access to, we'll fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. - Some files, such as images, require that you move them from the command line. For more information, see "[Moving a file to a new location using the command line](/articles/moving-a-file-to-a-new-location-using-the-command-line)". - {% data reusables.repositories.protected-branches-block-web-edits-uploads %} diff --git a/content/repositories/working-with-files/managing-files/renaming-a-file.md b/content/repositories/working-with-files/managing-files/renaming-a-file.md index 3eed3e628b..66bf319c27 100644 --- a/content/repositories/working-with-files/managing-files/renaming-a-file.md +++ b/content/repositories/working-with-files/managing-files/renaming-a-file.md @@ -25,7 +25,7 @@ Renaming a file also gives you the opportunity to [move the file to a new locati **Tips**: -- If you try to rename a file in a repository that you don’t have access to, we will fork the project to your user account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. +- If you try to rename a file in a repository that you don’t have access to, we will fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. - File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, create and commit the files locally and then push them to the repository. - Some files, such as images, require that you rename them from the command line. For more information, see "[Renaming a file using the command line](/articles/renaming-a-file-using-the-command-line)." diff --git a/content/rest/overview/permissions-required-for-github-apps.md b/content/rest/overview/permissions-required-for-github-apps.md index cfcd1ace6c..dde4169724 100644 --- a/content/rest/overview/permissions-required-for-github-apps.md +++ b/content/rest/overview/permissions-required-for-github-apps.md @@ -281,6 +281,11 @@ _Traffic_ - [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) - [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) +{% ifversion fpt %} +### Permission on "codespaces" + +- [`GET /repos/:owner/:repo/codespaces/machines`](/rest/reference/codespaces#list-available-machine-types-for-a-repository) +{% endif %} ### Permission on "contents" - [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (:read) diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index a90a918200..1f7b2c54ac 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -365,7 +365,7 @@ Additionally, the Search API has dedicated limits. For more information, see "[S {% data reusables.rest-api.always-check-your-limit %} -### Requests from user accounts +### Requests from personal accounts Direct API requests that you authenticate with a personal access token are user-to-server requests. An OAuth App or GitHub App can also make a user-to-server request on your behalf after you authorize the app. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)," "[Authorizing OAuth Apps](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)," and "[Authorizing GitHub Apps](/authentication/keeping-your-account-and-data-secure/authorizing-github-apps)." diff --git a/content/search-github/searching-on-github/searching-code.md b/content/search-github/searching-on-github/searching-code.md index 55ec61e72c..ebd3d61ac8 100644 --- a/content/search-github/searching-on-github/searching-code.md +++ b/content/search-github/searching-on-github/searching-code.md @@ -69,7 +69,6 @@ You can use the `path` qualifier to search for source code that appears at a spe | path:PATH/TO/DIRECTORY | [**`console path:app/public language:javascript`**](https://github.com/search?q=console+path%3A%22app%2Fpublic%22+language%3Ajavascript&type=Code) matches JavaScript files with the word "console" in the app/public directory, or in any of its subdirectories (even if they reside in app/public/js/form-validators). ## Search by language - You can search for code based on what language it's written in. The `language` qualifier can be the language name or alias. For a full list of supported languages with their names and aliases, see the [github/linguist repository](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). diff --git a/content/search-github/searching-on-github/searching-users.md b/content/search-github/searching-on-github/searching-users.md index 7971a54a1a..d8e45c6f6d 100644 --- a/content/search-github/searching-on-github/searching-users.md +++ b/content/search-github/searching-on-github/searching-users.md @@ -67,7 +67,7 @@ Using the `language` qualifier you can search for users based on the languages o | language:LANGUAGE | [**language:javascript location:russia**](https://github.com/search?q=language%3Ajavascript+location%3Arussia&type=Users) matches users in Russia with a majority of their repositories written in JavaScript. | | [**jenny language:javascript in:fullname**](https://github.com/search?q=jenny+language%3Ajavascript+in%3Afullname&type=Users) matches users with JavaScript repositories whose full name contains the word "jenny." -## Search by when a user account was created +## Search by when a personal account was created You can filter users based on when they joined {% data variables.product.product_name %} with the `created` qualifier. This takes a date as its parameter. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} diff --git a/content/site-policy/github-terms/github-community-guidelines.md b/content/site-policy/github-terms/github-community-guidelines.md index 9f614d8ffb..cbca920b27 100644 --- a/content/site-policy/github-terms/github-community-guidelines.md +++ b/content/site-policy/github-terms/github-community-guidelines.md @@ -39,7 +39,7 @@ While some disagreements can be resolved with direct, respectful communication b * **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](/articles/setting-guidelines-for-repository-contributors/), or [dedicated code of conduct](/articles/adding-a-code-of-conduct-to-your-project/). You can find additional information on building communities [here](/communities). -* **Moderate Comments** - Users with [write-access privileges](/articles/repository-permission-levels-for-an-organization/) for a repository can [edit, delete, or hide anyone's comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments) on commits, pull requests, and issues. Anyone with read access to a repository can view a comment's edit history. Comment authors and people with write access to a repository can also delete sensitive information from a [comment's edit history](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment). Moderating your projects can feel like a big task if there is a lot of activity, but you can [add collaborators](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository#collaborator-access-for-a-repository-owned-by-a-user-account) to assist you in managing your community. +* **Moderate Comments** - Users with [write-access privileges](/articles/repository-permission-levels-for-an-organization/) for a repository can [edit, delete, or hide anyone's comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments) on commits, pull requests, and issues. Anyone with read access to a repository can view a comment's edit history. Comment authors and people with write access to a repository can also delete sensitive information from a [comment's edit history](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment). Moderating your projects can feel like a big task if there is a lot of activity, but you can [add collaborators](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository#collaborator-access-for-a-repository-owned-by-a-personal-account) to assist you in managing your community. * **Lock Conversations**  - If a discussion in an issue, pull request, or commit gets out of hand, off topic, or violates your project’s code of conduct or GitHub’s policies, owners, collaborators, and anyone else with write access can put a temporary or permanent [lock](/articles/locking-conversations/) on the conversation. 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 97d3f55bd4..469adbe87f 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](/articles/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 user 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](/articles/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-sponsors-additional-terms.md b/content/site-policy/github-terms/github-sponsors-additional-terms.md index 5153d9edd7..4fd8b40898 100644 --- a/content/site-policy/github-terms/github-sponsors-additional-terms.md +++ b/content/site-policy/github-terms/github-sponsors-additional-terms.md @@ -60,7 +60,7 @@ The GitHub Sponsors Matching Fund aims to encourage the community that participa #### 2.2.1. Matching Fund Terms. Eligibility for the GitHub Sponsors Matching Fund is evaluated on a case-by-case basis and is subject to the following limitations: -* You must have a GitHub account, be accepted into the Program as an individual, and be actively contributing to OSS. Please note, GitHub does not allow operating more than one free user account. As such, matching is available on an individual basis and will not be approved across multiple accounts. +* You must have a GitHub account, be accepted into the Program as an individual, and be actively contributing to OSS. Please note, GitHub does not allow operating more than one free personal account. As such, matching is available on an individual basis and will not be approved across multiple accounts. * Your use of GitHub and your Sponsored Developer Account must be, based on our determination, in our sole discretion, in accordance with the GitHub Sponsors mission to expand the opportunities to contribute to open source that upholds the [GitHub Community Guidelines](/github/site-policy/github-community-guidelines). 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 d2df318edd..1d590bf587 100644 --- a/content/site-policy/github-terms/github-terms-of-service.md +++ b/content/site-policy/github-terms/github-terms-of-service.md @@ -46,7 +46,7 @@ Effective date: November 16, 2020 ## A. Definitions **Short version:** *We use these basic terms throughout the agreement, and they have specific meanings. You should know what we mean when we use each of the terms. There's not going to be a test on it, but it's still useful information.* -1. An "Account" represents your legal relationship with GitHub. A “User Account” represents an individual User’s authorization to log in to and use the Service and serves as a User’s identity on GitHub. “Organizations” are shared workspaces that may be associated with a single entity or with one or more Users where multiple Users can collaborate across many projects at once. A User Account can be a member of any number of Organizations. +1. An "Account" represents your legal relationship with GitHub. A “Personal Account” represents an individual User’s authorization to log in to and use the Service and serves as a User’s identity on GitHub. “Organizations” are shared workspaces that may be associated with a single entity or with one or more Users where multiple Users can collaborate across many projects at once. A Personal Account can be a member of any number of Organizations. 2. The “Agreement” refers, collectively, to all the terms, conditions, notices contained or referenced in this document (the “Terms of Service” or the "Terms") and all other operating rules, policies (including the GitHub Privacy Statement, available at [github.com/site/privacy](https://github.com/site/privacy)) and procedures that we may publish from time to time on the Website. Most of our site policies are available at [docs.github.com/categories/site-policy](/categories/site-policy). 3. "Beta Previews" mean software, services, or features identified as alpha, beta, preview, early access, or evaluation, or words or phrases with similar meanings. 4. “Content” refers to content featured or displayed through the Website, including without limitation code, text, data, articles, images, photographs, graphics, software, applications, packages, designs, features, and other materials that are available on the Website or otherwise available through the Service. "Content" also includes Services. “User-Generated Content” is Content, written or otherwise, created or uploaded by our Users. "Your Content" is Content that you create or own. @@ -56,26 +56,26 @@ Effective date: November 16, 2020 8. The “Website” refers to GitHub’s website located at [github.com](https://github.com/), and all content, services, and products provided by GitHub at or through the Website. It also refers to GitHub-owned subdomains of github.com, such as [education.github.com](https://education.github.com/) and [pages.github.com](https://pages.github.com/). These Terms also govern GitHub’s conference websites, such as [githubuniverse.com](https://githubuniverse.com/), and product websites, such as [atom.io](https://atom.io/). Occasionally, websites owned by GitHub may provide different or additional terms of service. If those additional terms conflict with this Agreement, the more specific terms apply to the relevant page or service. ## B. Account Terms -**Short version:** *User Accounts and Organizations have different administrative controls; a human must create your Account; you must be 13 or over; you must provide a valid email address; and you may not have more than one free Account. You alone are responsible for your Account and anything that happens while you are signed in to or using your Account. You are responsible for keeping your Account secure.* +**Short version:** *Personal Accounts and Organizations have different administrative controls; a human must create your Account; you must be 13 or over; you must provide a valid email address; and you may not have more than one free Account. You alone are responsible for your Account and anything that happens while you are signed in to or using your Account. You are responsible for keeping your Account secure.* ### 1. Account Controls -- Users. Subject to these Terms, you retain ultimate administrative control over your User Account and the Content within it. +- Users. Subject to these Terms, you retain ultimate administrative control over your Personal Account and the Content within it. -- Organizations. The "owner" of an Organization that was created under these Terms has ultimate administrative control over that Organization and the Content within it. Within the Service, an owner can manage User access to the Organization’s data and projects. An Organization may have multiple owners, but there must be at least one User Account designated as an owner of an Organization. If you are the owner of an Organization under these Terms, we consider you responsible for the actions that are performed on or through that Organization. +- Organizations. The "owner" of an Organization that was created under these Terms has ultimate administrative control over that Organization and the Content within it. Within the Service, an owner can manage User access to the Organization’s data and projects. An Organization may have multiple owners, but there must be at least one Personal Account designated as an owner of an Organization. If you are the owner of an Organization under these Terms, we consider you responsible for the actions that are performed on or through that Organization. ### 2. Required Information You must provide a valid email address in order to complete the signup process. Any other information requested, such as your real name, is optional, unless you are accepting these terms on behalf of a legal entity (in which case we need more information about the legal entity) or if you opt for a [paid Account](#k-payment), in which case additional information will be necessary for billing purposes. ### 3. Account Requirements -We have a few simple rules for User Accounts on GitHub's Service. +We have a few simple rules for Personal Accounts on GitHub's Service. - You must be a human to create an Account. Accounts registered by "bots" or other automated methods are not permitted. We do permit machine accounts: -- A machine account is an Account set up by an individual human who accepts the Terms on behalf of the Account, provides a valid email address, and is responsible for its actions. A machine account is used exclusively for performing automated tasks. Multiple users may direct the actions of a machine account, but the owner of the Account is ultimately responsible for the machine's actions. You may maintain no more than one free machine account in addition to your free User Account. +- A machine account is an Account set up by an individual human who accepts the Terms on behalf of the Account, provides a valid email address, and is responsible for its actions. A machine account is used exclusively for performing automated tasks. Multiple users may direct the actions of a machine account, but the owner of the Account is ultimately responsible for the machine's actions. You may maintain no more than one free machine account in addition to your free Personal Account. - One person or legal entity may maintain no more than one free Account (if you choose to control a machine account as well, that's fine, but it can only be used for running a machine). - You must be age 13 or older. While we are thrilled to see brilliant young coders get excited by learning to program, we must comply with United States law. GitHub does not target our Service to children under 13, and we do not permit any Users under 13 on our Service. If we learn of any User under the age of 13, we will [terminate that User’s Account immediately](#l-cancellation-and-termination). If you are a resident of a country outside the United States, your country’s minimum age may be older; in such a case, you are responsible for complying with your country’s laws. -- Your login may only be used by one person — i.e., a single login may not be shared by multiple people. A paid Organization may only provide access to as many User Accounts as your subscription allows. +- Your login may only be used by one person — i.e., a single login may not be shared by multiple people. A paid Organization may only provide access to as many Personal Accounts as your subscription allows. - You may not use GitHub in violation of export control or sanctions laws of the United States or any other applicable jurisdiction. You may not use GitHub if you are or are working on behalf of a [Specially Designated National (SDN)](https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx) or a person subject to similar blocking or denied party prohibitions administered by a U.S. government agency. GitHub may allow persons in certain sanctioned countries or territories to access certain GitHub services pursuant to U.S. government authorizations. For more information, please see our [Export Controls policy](/articles/github-and-export-controls). -### 4. User Account Security +### 4. Account Security You are responsible for keeping your Account secure while you use our Service. We offer tools such as two-factor authentication to help you maintain your Account's security, but the content of your Account and its security are up to you. - You are responsible for all content posted and activity that occurs under your Account (even when content is posted by others who have Accounts under your Account). - You are responsible for maintaining the security of your Account and password. GitHub cannot and will not be liable for any loss or damage from your failure to comply with this security obligation. diff --git a/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md b/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md index 512e2202ea..5126f665b2 100644 --- a/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md +++ b/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md @@ -180,7 +180,7 @@ Please note that the information available will vary from case to case. Some of **With a court order *or* a search warrant** — We will not disclose account access logs unless compelled to do so by either (i) a court order issued under 18 U.S.C. Section 2703(d), upon a showing of specific and articulable facts showing that there are reasonable grounds to believe that the information sought is relevant and material to an ongoing criminal investigation; or (ii) a search warrant issued under the procedures described in the Federal Rules of Criminal Procedure or equivalent state warrant procedures, upon a showing of probable cause. -In addition to the non-public user account information listed above, we can provide account access logs in response to a court order or search warrant, which may include: +In addition to the non-public account information listed above, we can provide account access logs in response to a court order or search warrant, which may include: - Any logs which would reveal a user's movements over a period of time - Account or private repository settings (for example, which users have certain permissions, etc.) @@ -189,8 +189,8 @@ In addition to the non-public user account information listed above, we can prov - **Only with a search warrant** — -We will not disclose the private contents of any user account unless compelled to do so under a search warrant issued under the procedures described in the Federal Rules of Criminal Procedure or equivalent state warrant procedures upon a showing of probable cause. -In addition to the non-public user account information and account access logs mentioned above, we will also provide private user account contents in response to a search warrant, which may include: +We will not disclose the private contents of any account unless compelled to do so under a search warrant issued under the procedures described in the Federal Rules of Criminal Procedure or equivalent state warrant procedures upon a showing of probable cause. +In addition to the non-public account information and account access logs mentioned above, we will also provide private account contents in response to a search warrant, which may include: - Contents of secret Gists - Source code or other content in private repositories diff --git a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md index cd0c2c94d4..4918a84824 100644 --- a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md +++ b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md @@ -19,7 +19,7 @@ topics: {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." {% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." diff --git a/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md b/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md index e3f60e1e4d..2355bc4e52 100644 --- a/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md +++ b/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md @@ -46,7 +46,7 @@ You can check if contributors you've benefited from have {% data variables.produ ## Search for a specific project or contributor -At https://github.com/sponsors/community, you can search by ecosystem, most used, recently updated, and more. You can filter search results for your personal user account or for organizations that you're a member of. +At https://github.com/sponsors/community, you can search by ecosystem, most used, recently updated, and more. You can filter search results for your personal account or for organizations that you're a member of. ## Next steps diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md index 1340fb5162..0fb3ae74fb 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md @@ -16,7 +16,7 @@ shortTitle: Open source contributors ## Joining {% data variables.product.prodname_sponsors %} -{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." {% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." @@ -28,7 +28,7 @@ You can set a goal for your sponsorships. For more information, see "[Managing y ## Sponsorship tiers -{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)." +{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)." It's best to set up a range of different sponsorship options, including monthly and one-time tiers, to make it easy for anyone to support your work. In particular, one-time payments allow people to reward your efforts without worrying about whether their finances will support a regular payment schedule. diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md index 7800e3ad4c..014189a89d 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md @@ -17,7 +17,7 @@ topics: Your sponsors can choose whether they receive email updates about your work. For more information, see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)." -For sponsored developer accounts, the update will come from your user account's primary email address. If you've enabled email address privacy on your user account, the update will come from `noreply@github.com` instead. For sponsored organizations, the update will come from the organization's `noreply@github.com` email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)." +For sponsored developer accounts, the update will come from your personal account's primary email address. If you've enabled email address privacy on your personal account, the update will come from `noreply@github.com` instead. For sponsored organizations, the update will come from the organization's `noreply@github.com` email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)." ## Contacting your sponsors diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md index 22c177cd5d..678bb87e0a 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md @@ -16,7 +16,7 @@ shortTitle: Manage payouts ## About payouts from {% data variables.product.prodname_sponsors %} -You can only manage your payouts from {% data variables.product.prodname_sponsors %} if you are paid through Stripe Connect. If you are paid through ACH transfer or wire transfer for your sponsored user account, you will not see the **Payouts** tab on your sponsored open source contributor dashboard. Sponsored organizations can only use Stripe Connect for payouts. For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors#sponsorship-payouts)." +You can only manage your payouts from {% data variables.product.prodname_sponsors %} if you are paid through Stripe Connect. If you are paid through ACH transfer or wire transfer for your sponsored personal account, you will not see the **Payouts** tab on your sponsored open source contributor dashboard. Sponsored organizations can only use Stripe Connect for payouts. For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors#sponsorship-payouts)." {% data reusables.sponsors.payout-info %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md index c37bc47234..c59a2bbaa4 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md @@ -23,7 +23,7 @@ shortTitle: Set up for organization After you receive an invitation for your organization to join {% data variables.product.prodname_sponsors %}, you can complete the steps below to become a sponsored organization. -To join {% data variables.product.prodname_sponsors %} as an individual contributor outside an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." +To join {% data variables.product.prodname_sponsors %} as an individual contributor outside an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." {% data reusables.sponsors.navigate-to-github-sponsors %} {% data reusables.sponsors.view-eligible-accounts %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md index 85d5d3c43f..4de6703d5b 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md @@ -12,7 +12,7 @@ type: how_to topics: - User account - Sponsors profile -shortTitle: Set up for user account +shortTitle: Set up for personal account --- ## Joining {% data variables.product.prodname_sponsors %} @@ -22,7 +22,7 @@ shortTitle: Set up for user account To join {% data variables.product.prodname_sponsors %} as an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." {% data reusables.sponsors.navigate-to-github-sponsors %} -2. If you are an organization owner, you have more than one eligible account. Click **View your eligible accounts**, then in the list of accounts, find your user account. +2. If you are an organization owner, you have more than one eligible account. Click **View your eligible accounts**, then in the list of accounts, find your personal account. 3. Click **Join the waitlist**. {% data reusables.sponsors.contact-info %} {% data reusables.sponsors.accept-legal-terms %} 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 9cbcf53fce..c80c0cc92a 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 @@ -28,7 +28,7 @@ If you are a taxpayer in the United States, you must submit a [W-9](https://www. W-8 BEN and W-8 BEN-E tax forms help {% data variables.product.prodname_dotcom %} determine the beneficial owner of an amount subject to withholding. -If you are a taxpayer in any other region besides the United States, you must submit a [W-8 BEN](https://www.irs.gov/pub/irs-pdf/fw8ben.pdf) (individual) or [W-8 BEN-E](https://www.irs.gov/forms-pubs/about-form-w-8-ben-e) (company) form before you can publish your {% data variables.product.prodname_sponsors %} profile. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-tax-information)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization#submitting-your-tax-information)." {% data variables.product.prodname_dotcom %} will send you the appropriate forms, notify you when they are due, and give you a reasonable amount of time to complete and send in the forms. +If you are a taxpayer in any other region besides the United States, you must submit a [W-8 BEN](https://www.irs.gov/pub/irs-pdf/fw8ben.pdf) (individual) or [W-8 BEN-E](https://www.irs.gov/forms-pubs/about-form-w-8-ben-e) (company) form before you can publish your {% data variables.product.prodname_sponsors %} profile. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-tax-information)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization#submitting-your-tax-information)." {% data variables.product.prodname_dotcom %} will send you the appropriate forms, notify you when they are due, and give you a reasonable amount of time to complete and send in the forms. If you have been assigned an incorrect tax form, [contact {% data variables.product.prodname_dotcom %} Support](https://support.github.com/contact?form%5Bsubject%5D=GitHub%20Sponsors:%20tax%20form&tags=sponsors) to get reassigned the correct one for your situation. diff --git a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index 8fc9c947b9..fc50f62a12 100644 --- a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -9,7 +9,7 @@ redirect_from: versions: fpt: '*' ghec: '*' -permissions: Anyone can sponsor accounts on behalf of their own user account. Organization owners and billing managers can sponsor accounts on behalf of their organization. +permissions: Anyone can sponsor accounts on behalf of their own personal account. Organization owners and billing managers can sponsor accounts on behalf of their organization. type: how_to topics: - Open Source @@ -23,7 +23,7 @@ shortTitle: Sponsor a contributor {% data reusables.sponsors.sponsorship-details %} -You can sponsor an account on behalf of your user account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons. +You can sponsor an account on behalf of your personal account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons. - Sustaining specific libraries that your organization's work depends on - Investing in the ecosystem you rely on as a organization (such as blockchain) - Developing brand awareness as an organization that values open source @@ -41,7 +41,7 @@ You can choose whether to display your sponsorship publicly. One-time sponsorshi If the sponsored account retires your tier, the tier will remain in place for you until you choose a different tier or cancel your subscription. For more information, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)." -If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." +If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." {% data reusables.sponsors.sponsorships-not-tax-deductible %} diff --git a/contributing/search.md b/contributing/search.md index 4d534b54d2..273258bf88 100644 --- a/contributing/search.md +++ b/contributing/search.md @@ -135,3 +135,4 @@ Each record represents a section of a page. Sections are derived by splitting up - Our search querying has typo tolerance. Try spelling something wrong and see what you get! - Our search querying has lots of controls for customizing each index, so we can add weights to certain attributes and create rules like "title is more important than body", etc. But it works pretty well as-is without any configuration. - Our search querying has support for "advanced query syntax" for exact matching of quoted expressions and exclusion of words preceded by a `-` sign. This is off by default but we have it enabled in our browser client. The settings in the web interface can be overridden by the search endpoint. See [middleware/search.js]([middleware/search.js). +- When needed, the Docs Engineering team can commit updates to the search index, as long as the label `skip-index-check` is applied to the PR. \ No newline at end of file diff --git a/data/reusables/actions/permissions-statement-environment.md b/data/reusables/actions/permissions-statement-environment.md index 8dfdbb1403..f86dda9088 100644 --- a/data/reusables/actions/permissions-statement-environment.md +++ b/data/reusables/actions/permissions-statement-environment.md @@ -1 +1 @@ -To configure an environment in a user account repository, you must be the repository owner. To configure an environment in an organization repository, you must have `admin` access. +To configure an environment in a personal account repository, you must be the repository owner. To configure an environment in an organization repository, you must have `admin` access. diff --git a/data/reusables/actions/permissions-statement-secrets-environment.md b/data/reusables/actions/permissions-statement-secrets-environment.md index c9445ab95e..ddabde1537 100644 --- a/data/reusables/actions/permissions-statement-secrets-environment.md +++ b/data/reusables/actions/permissions-statement-secrets-environment.md @@ -1 +1 @@ -To create secrets for an environment in a user account repository, you must be the repository owner. To create secrets for an environment in an organization repository, you must have `admin` access. +To create secrets for an environment in a personal account repository, you must be the repository owner. To create secrets for an environment in an organization repository, you must have `admin` access. diff --git a/data/reusables/actions/permissions-statement-secrets-repository.md b/data/reusables/actions/permissions-statement-secrets-repository.md index 0333c71723..b69feeb4ee 100644 --- a/data/reusables/actions/permissions-statement-secrets-repository.md +++ b/data/reusables/actions/permissions-statement-secrets-repository.md @@ -1 +1 @@ -To create secrets for a user account repository, you must be the repository owner. To create secrets for an organization repository, you must have `admin` access. +To create secrets for a personal account repository, you must be the repository owner. To create secrets for an organization repository, you must have `admin` access. diff --git a/data/reusables/apps/settings-step.md b/data/reusables/apps/settings-step.md index 358b747dd1..69a2d5fb30 100644 --- a/data/reusables/apps/settings-step.md +++ b/data/reusables/apps/settings-step.md @@ -1,5 +1,5 @@ 1. Navigate to your account settings. - - For a {% data variables.product.prodname_github_app %} owned by a user account, in the upper-right corner of any page, click your profile photo, then click **Settings**. + - For a {% data variables.product.prodname_github_app %} owned by a personal account, in the upper-right corner of any page, click your profile photo, then click **Settings**. ![Settings icon in the user bar](/assets/images/settings/userbar-account-settings_post2dot12.png) - For a {% data variables.product.prodname_github_app %} owned by an organization, in the upper-right corner of any page, click your profile photo, then click **Your organizations**. Then, to the right of the organization, click **Settings**. ![Your organizations in the profile menu](/assets/images/help/profile/your-organizations.png) diff --git a/data/reusables/billing/license-statuses.md b/data/reusables/billing/license-statuses.md index d247635775..05810b4e30 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.product.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. +If your license includes {% data variables.product.prodname_vss_ghe %}, you can identify whether a personal 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 personal 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. -- Blank: There is no {% data variables.product.prodname_vs %} association to consider for the user account on {% data variables.product.prodname_dotcom_the_website %}. +- Blank: There is no {% data variables.product.prodname_vs %} association to consider for the personal account on {% data variables.product.prodname_dotcom_the_website %}. {% endif %} diff --git a/data/reusables/classroom/invitation-url-warning.md b/data/reusables/classroom/invitation-url-warning.md index f85e808ddc..bb315450ba 100644 --- a/data/reusables/classroom/invitation-url-warning.md +++ b/data/reusables/classroom/invitation-url-warning.md @@ -1,5 +1,5 @@ {% warning %} -**Warning**: Be careful where you share invitation URLs. Anyone with an invitation URL for an assignment can accept the invitation and associate a user account on {% data variables.product.product_name %} with an identifier in your roster. +**Warning**: Be careful where you share invitation URLs. Anyone with an invitation URL for an assignment can accept the invitation and associate a personal account on {% data variables.product.product_name %} with an identifier in your roster. {% endwarning %} diff --git a/data/reusables/classroom/reuse-assignment-link.md b/data/reusables/classroom/reuse-assignment-link.md new file mode 100644 index 0000000000..73b7419440 --- /dev/null +++ b/data/reusables/classroom/reuse-assignment-link.md @@ -0,0 +1 @@ +You can reuse an existing assignment in any other classroom you have admin access to, including classrooms in a different organization. For more information, see "[Reuse an assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." \ No newline at end of file diff --git a/data/reusables/codespaces/billing-for-prebuilds.md b/data/reusables/codespaces/billing-for-prebuilds.md index 06a3671163..c7c37eea5c 100644 --- a/data/reusables/codespaces/billing-for-prebuilds.md +++ b/data/reusables/codespaces/billing-for-prebuilds.md @@ -1,5 +1,7 @@ -A {% data variables.product.prodname_actions %} workflow is triggered every time you create or update a prebuild template, or push to a prebuild-enabled branch. As with other workflows, while prebuild workflows are running they will either consume some of the Actions minutes included with your account, if you have any, or they will incur charges for Actions minutes. For more information about pricing for Actions minutes, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." +By default, a {% data variables.product.prodname_actions %} workflow is triggered every time you create or update a prebuild template, or push to a prebuild-enabled branch. As with other workflows, while prebuild workflows are running they will either consume some of the Actions minutes included with your account, if you have any, or they will incur charges for Actions minutes. For more information about pricing for Actions minutes, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." -If you are an organization owner, you can track usage of prebuild workflows by downloading a {% data variables.product.prodname_actions %} usage report for your organization. You can identify workflow runs for prebuilds by filtering the CSV output to only include the workflow called "Create Codespaces Prebuilds." For more information, see "[Viewing your {% data variables.product.prodname_actions %} usage](/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage#viewing-github-actions-usage-for-your-organization)." +If you are an organization owner, you can track usage of prebuild workflows by downloading a {% data variables.product.prodname_actions %} usage report for your organization. You can identify workflow runs for prebuilds by filtering the CSV output to only include the workflow called "Create Codespaces Prebuilds." For more information, see "[Viewing your {% data variables.product.prodname_actions %} usage](/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage#viewing-github-actions-usage-for-your-organization)." + +To reduce consumption of Actions minutes, you can set a prebuild template to be updated only when you make a change to your dev container configuration files, or only on a custom schedule. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)." While {% data variables.product.prodname_codespaces %} prebuilds is in beta there is no charge for storage of templates. When prebuilds become generally available, you will be billed for storing prebuild templates for each prebuild configuration in each region selected for that configuration. diff --git a/data/reusables/codespaces/concurrent-codespace-limit.md b/data/reusables/codespaces/concurrent-codespace-limit.md index e1640735ac..d75ca3a9e8 100644 --- a/data/reusables/codespaces/concurrent-codespace-limit.md +++ b/data/reusables/codespaces/concurrent-codespace-limit.md @@ -1 +1 @@ -You can create more than one codespace per repository or even per branch. However, each user account has a limit of 10 codespaces. If you've reached the limit and want to create a new codespace, you must delete a codespace first. +You can create more than one codespace per repository or even per branch. However, each personal account has a limit of 10 codespaces. If you've reached the limit and want to create a new codespace, you must delete a codespace first. diff --git a/data/reusables/discussions/about-categories-and-formats.md b/data/reusables/discussions/about-categories-and-formats.md index 9f2a0c212a..866e92487b 100644 --- a/data/reusables/discussions/about-categories-and-formats.md +++ b/data/reusables/discussions/about-categories-and-formats.md @@ -1 +1 @@ -All discussions must be created in a category. People with maintain or admin permissions define the categories for a repository. Each category has a format: open-ended discussion, question and answer, or announcement. +All discussions must be created in a category. For repository discussions, people with maintain or admin permissions to the repository define the categories for discussions in that repository. For organization discussions, people with maintain or admin permissions to the source repository define the categories for discussions in that organization. Each category has a format: open-ended discussion, question and answer, or announcement. diff --git a/data/reusables/discussions/about-discussions.md b/data/reusables/discussions/about-discussions.md index 846f180578..2d6aa2eca4 100644 --- a/data/reusables/discussions/about-discussions.md +++ b/data/reusables/discussions/about-discussions.md @@ -1 +1 @@ -{% data variables.product.prodname_discussions %} is an open forum for conversation among maintainers and the community for a project on {% data variables.product.product_name %}. +{% data variables.product.prodname_discussions %} is an open forum for conversation among maintainers and the community for a repository or organization on {% data variables.product.product_name %}. diff --git a/data/reusables/discussions/about-organization-discussions.md b/data/reusables/discussions/about-organization-discussions.md new file mode 100644 index 0000000000..c9964a9b33 --- /dev/null +++ b/data/reusables/discussions/about-organization-discussions.md @@ -0,0 +1,5 @@ +When you enable organization discussions, you will choose a repository in the organization to be the source repository for your organization discussions. You can use an existing repository or create a repository specifically to hold your organization discussions. Discussions will appear both on the discussions page for the organization and on the discussion page for the source repository. + +Permission to participate in or manage discussion in your organization is based on permission in the source repository. For example, a user needs write permission to the source repository in order to delete an organization discussion. This is identical to how a user needs write permission in a repository in order to delete a repository discussion. + +You can change the source repository at any time. If you change the source repository, discussions are not transferred to the new source repository. diff --git a/data/reusables/discussions/discussions-tab.md b/data/reusables/discussions/discussions-tab.md index 777580a39a..fa12edfca9 100644 --- a/data/reusables/discussions/discussions-tab.md +++ b/data/reusables/discussions/discussions-tab.md @@ -1,2 +1,2 @@ -1. Under your repository name, click {% octicon "comment-discussion" aria-label="The discussion icon" %} **Discussions**. +1. Under your repository or organization name, click {% octicon "comment-discussion" aria-label="The discussion icon" %} **Discussions**. !["Discussions" tab for a repository](/assets/images/help/discussions/repository-discussions-tab.png) diff --git a/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md b/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md new file mode 100644 index 0000000000..131c0bbbcf --- /dev/null +++ b/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md @@ -0,0 +1,8 @@ +1. On {% data variables.product.product_location %}, navigate to the main page of your organization. +1. Under your organization name, click {% octicon "gear" aria-label="The gear icon" %} +**Settings**. +![Organization settings button](/assets/images/help/discussions/org-settings.png) +1. Under "Discussions", select **Enable discussions for this organization**. +1. Select a repository to use as the source repository for your organization discussions. + ![Settings to enable discussions for an organization](/assets/images/help/discussions/enable-org-discussions.png) +1. Click **Save**. diff --git a/data/reusables/discussions/marking-a-comment-as-an-answer.md b/data/reusables/discussions/marking-a-comment-as-an-answer.md index 2073ccb930..f82b4bf391 100644 --- a/data/reusables/discussions/marking-a-comment-as-an-answer.md +++ b/data/reusables/discussions/marking-a-comment-as-an-answer.md @@ -6,7 +6,7 @@ When you mark a question as an answer, {% data variables.product.product_name %} You can't mark a threaded comment in response to a comment as the answer to a discussion. You also can't mark a minimized comment as the answer to a discussion. -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} 1. In the list of discussions, click the unanswered discussion you want to mark as answered. ![Unanswered discussion](/assets/images/help/discussions/unanswered-discussion.png) diff --git a/data/reusables/discussions/navigate-to-repo-or-org.md b/data/reusables/discussions/navigate-to-repo-or-org.md new file mode 100644 index 0000000000..92670f998b --- /dev/null +++ b/data/reusables/discussions/navigate-to-repo-or-org.md @@ -0,0 +1 @@ +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization. diff --git a/data/reusables/discussions/repository-category-limit.md b/data/reusables/discussions/repository-category-limit.md index 293d3632b5..b1a8e50e1a 100644 --- a/data/reusables/discussions/repository-category-limit.md +++ b/data/reusables/discussions/repository-category-limit.md @@ -1 +1 @@ -Each repository can have up to 10 categories. +Each repository or organization can have up to 10 categories. diff --git a/data/reusables/discussions/starting-a-discussion.md b/data/reusables/discussions/starting-a-discussion.md index f4531e36de..3ef3f047d0 100644 --- a/data/reusables/discussions/starting-a-discussion.md +++ b/data/reusables/discussions/starting-a-discussion.md @@ -1,4 +1,4 @@ -{% data reusables.repositories.navigate-to-repo %} +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to start a discussion. {% data reusables.discussions.discussions-tab %} 1. Click **New discussion**. !["New discussion" button within the "Discussions" tab for a repository](/assets/images/help/discussions/new-discussion-button.png) diff --git a/data/reusables/discussions/starting-a-poll.md b/data/reusables/discussions/starting-a-poll.md new file mode 100644 index 0000000000..af4605cb0e --- /dev/null +++ b/data/reusables/discussions/starting-a-poll.md @@ -0,0 +1,16 @@ +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.discussions-tab %} +1. In the list of categories, click **Polls**. + ![Screenshot showing "Poll" category](/assets/images/help/discussions/poll-category.png) +1. On the right, click **Start poll**. + ![Screenshot showing the "Start poll" button](/assets/images/help/discussions/start-poll-button.png) +1. Type a title and optional body for your poll. + ![Screenshot showing text fields for title and body](/assets/images/help/discussions/new-poll-title-and-body-fields.png) +1. Type a question for your poll. + ![Screenshot showing text fields for the poll's question](/assets/images/help/discussions/new-poll-question.png) +1. Type at least two options for your poll. + ![Screenshot showing text fields for the poll's options](/assets/images/help/discussions/new-poll-options.png) +1. Optionally, to add a extra poll options, click **Add an option**. + ![Screenshot showing "Add an option" button](/assets/images/help/discussions/new-poll-add-option.png) +1. Click **Start poll**. + ![Screenshot showing the "Start poll" button](/assets/images/help/discussions/new-poll-start-poll-button.png) \ No newline at end of file diff --git a/data/reusables/dotcom_billing/coupon-expires.md b/data/reusables/dotcom_billing/coupon-expires.md index 71beb790aa..c8816bec29 100644 --- a/data/reusables/dotcom_billing/coupon-expires.md +++ b/data/reusables/dotcom_billing/coupon-expires.md @@ -1 +1 @@ -If you use a coupon to pay for a subscription, when the coupon expires, your payment method will be charged the full cost of your subscription. If you do not have a saved payment method, your account will be downgraded to {% data variables.product.prodname_free_user %} for user accounts or {% data variables.product.prodname_free_team %} for organizations. +If you use a coupon to pay for a subscription, when the coupon expires, your payment method will be charged the full cost of your subscription. If you do not have a saved payment method, your account will be downgraded to {% data variables.product.prodname_free_user %} for personal accounts or {% data variables.product.prodname_free_team %} for organizations. diff --git a/data/reusables/education/educator-requirements.md b/data/reusables/education/educator-requirements.md index b7a004744d..876d5663ed 100644 --- a/data/reusables/education/educator-requirements.md +++ b/data/reusables/education/educator-requirements.md @@ -3,4 +3,4 @@ To apply for an educator or researcher discount, you must meet the following req - Be an educator, faculty member, or researcher. - Have a verifiable school-issued email address. - Upload documents that prove your school affiliation. -- Have a user account on {% data variables.product.product_name %}. +- Have a personal account on {% data variables.product.product_name %}. diff --git a/data/reusables/marketplace/app-transfer-to-org-for-verification.md b/data/reusables/marketplace/app-transfer-to-org-for-verification.md index 0621a9e6e9..c11be27bb2 100644 --- a/data/reusables/marketplace/app-transfer-to-org-for-verification.md +++ b/data/reusables/marketplace/app-transfer-to-org-for-verification.md @@ -1 +1 @@ -If you want to sell an app that's owned by your user account, first you'll need to transfer the app to an organization, and then request verification for a listing created by the organization. +If you want to sell an app that's owned by your personal account, first you'll need to transfer the app to an organization, and then request verification for a listing created by the organization. diff --git a/data/reusables/notifications/auto-watch.md b/data/reusables/notifications/auto-watch.md index 0f9ffd41bb..91f4de98ef 100644 --- a/data/reusables/notifications/auto-watch.md +++ b/data/reusables/notifications/auto-watch.md @@ -1 +1 @@ -You automatically watch all repositories that you create and are owned by your user account. You can also choose to automatically watch all repositories that you have push access to, except forks. You can watch any other repository manually. +You automatically watch all repositories that you create and are owned by your personal account. You can also choose to automatically watch all repositories that you have push access to, except forks. You can watch any other repository manually. diff --git a/data/reusables/organizations/about-organizations.md b/data/reusables/organizations/about-organizations.md index eb7509598f..a9ea25d246 100644 --- a/data/reusables/organizations/about-organizations.md +++ b/data/reusables/organizations/about-organizations.md @@ -1 +1 @@ -Your team can collaborate on {% data variables.product.product_name %} by using an organization account. Each person that uses {% data variables.product.prodname_dotcom %} signs into a user account. Multiple user accounts can collaborate on shared projects by joining the same organization account, which owns the repositories. A subset of these user 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. +Your team can collaborate on {% data variables.product.product_name %} by using an organization account. Each person that uses {% data variables.product.prodname_dotcom %} signs into a personal account. Multiple personal accounts can collaborate on shared projects by joining the same organization account, which owns the repositories. 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/package_registry/package-settings-from-user-level.md b/data/reusables/package_registry/package-settings-from-user-level.md index 9dd9b5a074..777f19c916 100644 --- a/data/reusables/package_registry/package-settings-from-user-level.md +++ b/data/reusables/package_registry/package-settings-from-user-level.md @@ -1,4 +1,4 @@ -1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your user account. +1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your personal account. 2. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. ![Profile photo](/assets/images/help/profile/top_right_avatar.png) 3. On your profile page, in the top right, click **Packages**. diff --git a/data/reusables/package_registry/visibility-and-access-permissions.md b/data/reusables/package_registry/visibility-and-access-permissions.md index 59f3a620d8..f40d6ebf85 100644 --- a/data/reusables/package_registry/visibility-and-access-permissions.md +++ b/data/reusables/package_registry/visibility-and-access-permissions.md @@ -3,7 +3,7 @@ If you have admin permissions to a container image, you can set the access permi As an admin, you can also grant access permissions for a container image that are separate from the permissions you've set at the organization and repository levels. -For container images published and owned by a user account, you can give any person an access role. For container images published and owned by an organization, you can give any person or team in the organization an access role. +For container images published and owned by a personal account, you can give any person an access role. For container images published and owned by an organization, you can give any person or team in the organization an access role. | Permission | Access description | |------------|--------------------| diff --git a/data/reusables/pull_requests/large-search-workaround.md b/data/reusables/pull_requests/large-search-workaround.md index 2bc7bf2f1e..2b1d356cfd 100644 --- a/data/reusables/pull_requests/large-search-workaround.md +++ b/data/reusables/pull_requests/large-search-workaround.md @@ -1 +1 @@ -If you have access to pull requests in more than 10,000 repositories, you will need to limit your search to a specific organization, user account, or repository to see results. +If you have access to pull requests in more than 10,000 repositories, you will need to limit your search to a specific organization, personal account, or repository to see results. diff --git a/data/reusables/repositories/default-issue-templates.md b/data/reusables/repositories/default-issue-templates.md index f0eeada25f..e315eae12c 100644 --- a/data/reusables/repositories/default-issue-templates.md +++ b/data/reusables/repositories/default-issue-templates.md @@ -1,2 +1,2 @@ -You can create default issue templates{% ifversion fpt or ghes or ghae or ghec %} and a default configuration file for issue templates{% endif %} for your organization{% ifversion fpt or ghes or ghae or ghec %} or user account{% endif %}. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." +You can create default issue templates{% ifversion fpt or ghes or ghae or ghec %} and a default configuration file for issue templates{% endif %} for your organization{% ifversion fpt or ghes or ghae or ghec %} or personal account{% endif %}. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." diff --git a/data/reusables/repositories/deploy-keys-write-access.md b/data/reusables/repositories/deploy-keys-write-access.md index aaea66e9c3..624c4d5cdb 100644 --- a/data/reusables/repositories/deploy-keys-write-access.md +++ b/data/reusables/repositories/deploy-keys-write-access.md @@ -1 +1 @@ -Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" and "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)." +Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)" and "[Permission levels for a personal account repository](/articles/permission-levels-for-a-user-account-repository/)." diff --git a/data/reusables/repositories/deploy-keys.md b/data/reusables/repositories/deploy-keys.md index f906012060..3add1e1e4e 100644 --- a/data/reusables/repositories/deploy-keys.md +++ b/data/reusables/repositories/deploy-keys.md @@ -1 +1 @@ -You can launch projects from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} to your server by using a deploy key, which is an SSH key that grants access to a single repository. {% data variables.product.product_name %} attaches the public part of the key directly to your repository instead of a personal user account, and the private part of the key remains on your server. For more information, see "[Delivering deployments](/rest/guides/delivering-deployments)." +You can launch projects from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} to your server by using a deploy key, which is an SSH key that grants access to a single repository. {% data variables.product.product_name %} attaches the public part of the key directly to your repository instead of a personal account, and the private part of the key remains on your server. For more information, see "[Delivering deployments](/rest/guides/delivering-deployments)." diff --git a/data/reusables/repositories/you-can-fork.md b/data/reusables/repositories/you-can-fork.md index c90d62fd00..72ff6c2dbc 100644 --- a/data/reusables/repositories/you-can-fork.md +++ b/data/reusables/repositories/you-can-fork.md @@ -1,7 +1,7 @@ -{% ifversion ghae %}If the policies for your enterprise permit forking internal and private repositories, you{% else %}You{% endif %} can fork a repository to your user account or any organization where you have repository creation permissions. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +{% ifversion ghae %}If the policies for your enterprise permit forking internal and private repositories, you{% else %}You{% endif %} can fork a repository to your personal account or any organization where you have repository creation permissions. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." {% ifversion fpt or ghes or ghec %} -If you have access to a private repository and the owner permits forking, you can fork the repository to your user account or any organization on {% ifversion fpt or ghec %}{% data variables.product.prodname_team %}{% else %}{% data variables.product.product_location %}{% endif %} where you have repository creation permissions. {% ifversion fpt or ghec %}You cannot fork a private repository to an organization using {% data variables.product.prodname_free_team %}. For more information, see "[GitHub's products](/articles/githubs-products)."{% endif %} +If you have access to a private repository and the owner permits forking, you can fork the repository to your personal account or any organization on {% ifversion fpt or ghec %}{% data variables.product.prodname_team %}{% else %}{% data variables.product.product_location %}{% endif %} where you have repository creation permissions. {% ifversion fpt or ghec %}You cannot fork a private repository to an organization using {% data variables.product.prodname_free_team %}. For more information, see "[GitHub's products](/articles/githubs-products)."{% endif %} {% endif %} diff --git a/data/reusables/saml/saml-accounts.md b/data/reusables/saml/saml-accounts.md index b49d8a07cf..cfb5746ae3 100644 --- a/data/reusables/saml/saml-accounts.md +++ b/data/reusables/saml/saml-accounts.md @@ -1,4 +1,4 @@ -If you configure SAML SSO, members of your organization will continue to log into their user accounts on {% data variables.product.prodname_dotcom_the_website %}. When a member accesses non-public resources within your organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} redirects the member to your IdP to authenticate. After successful authentication, your IdP redirects the member back to {% data variables.product.prodname_dotcom %}, where the member can access your organization's resources. +If you configure SAML SSO, members of your organization will continue to log into their personal accounts on {% data variables.product.prodname_dotcom_the_website %}. When a member accesses non-public resources within your organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} redirects the member to your IdP to authenticate. After successful authentication, your IdP redirects the member back to {% data variables.product.prodname_dotcom %}, where the member can access your organization's resources. {% note %} diff --git a/data/reusables/search/required_login.md b/data/reusables/search/required_login.md index 6d8598a94a..f42f37507f 100644 --- a/data/reusables/search/required_login.md +++ b/data/reusables/search/required_login.md @@ -1 +1 @@ -You must be signed into a user account on {% data variables.product.product_name %} to search for code across all public repositories. +You must be signed into a personal account on {% data variables.product.product_name %} to search for code across all public repositories. diff --git a/data/reusables/sponsors/no-fees.md b/data/reusables/sponsors/no-fees.md index dd829bafdc..60384589c5 100644 --- a/data/reusables/sponsors/no-fees.md +++ b/data/reusables/sponsors/no-fees.md @@ -1 +1 @@ -{% data variables.product.prodname_sponsors %} does not charge any fees for sponsorships from user accounts, so 100% of these sponsorships go to the sponsored developer or organization. The 10% fee for sponsorships from organizations is waived during the beta. +{% data variables.product.prodname_sponsors %} does not charge any fees for sponsorships from personal accounts, so 100% of these sponsorships go to the sponsored developer or organization. The 10% fee for sponsorships from organizations is waived during the beta. diff --git a/data/reusables/sponsors/prorated-sponsorship.md b/data/reusables/sponsors/prorated-sponsorship.md index 9e560bf708..a3d48fb8ef 100644 --- a/data/reusables/sponsors/prorated-sponsorship.md +++ b/data/reusables/sponsors/prorated-sponsorship.md @@ -1 +1 @@ -If you're starting a monthly sponsorship on behalf of your user account, you'll immediately be charged a prorated amount for the time until your next regular billing date. If you're sponsoring on behalf of an organization, you can choose to pay the prorated amount or make the full monthly payment. +If you're starting a monthly sponsorship on behalf of your personal account, you'll immediately be charged a prorated amount for the time until your next regular billing date. If you're sponsoring on behalf of an organization, you can choose to pay the prorated amount or make the full monthly payment. diff --git a/data/reusables/sponsors/sponsorship-dashboard.md b/data/reusables/sponsors/sponsorship-dashboard.md index 20dc887fbe..7787e967e1 100644 --- a/data/reusables/sponsors/sponsorship-dashboard.md +++ b/data/reusables/sponsors/sponsorship-dashboard.md @@ -1,5 +1,5 @@ 1. Navigate to your sponsorship dashboard for the account. - - If you're sponsoring a user account, under the user's name, click **Sponsoring**. + - If you're sponsoring a personal account, under the user's name, click **Sponsoring**. ![Sponsoring button](/assets/images/help/profile/sponsoring-button.png) - If you're sponsoring an organization, to the right of the organization's name, click **Sponsoring**. ![Sponsoring button](/assets/images/help/sponsors/org-sponsoring-button.png) diff --git a/data/reusables/sponsors/sponsorship-details.md b/data/reusables/sponsors/sponsorship-details.md index 5f36b22238..e11f8fba2d 100644 --- a/data/reusables/sponsors/sponsorship-details.md +++ b/data/reusables/sponsors/sponsorship-details.md @@ -1 +1 @@ -You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your user account or an organization. You can choose from multiple sponsorship tiers, with one-time or monthly payment amounts and benefits that are set by the sponsored account. Your sponsorship will share your account's existing billing date, payment method, and receipt. +You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your personal account or an organization. You can choose from multiple sponsorship tiers, with one-time or monthly payment amounts and benefits that are set by the sponsored account. Your sponsorship will share your account's existing billing date, payment method, and receipt. diff --git a/data/reusables/ssh/key-type-support.md b/data/reusables/ssh/key-type-support.md index 7bfdf23c4b..57b5241f88 100644 --- a/data/reusables/ssh/key-type-support.md +++ b/data/reusables/ssh/key-type-support.md @@ -2,7 +2,7 @@ **Note:** {% data variables.product.company_short %} improved security by dropping older, insecure key types on March 15, 2022. -As of that date, DSA keys (`ssh-dss`) are no longer supported. You cannot add new DSA keys to your user account on {% data variables.product.product_location %}. +As of that date, DSA keys (`ssh-dss`) are no longer supported. You cannot add new DSA keys to your personal account on {% data variables.product.product_location %}. RSA keys (`ssh-rsa`) with a `valid_after` before November 2, 2021 may continue to use any signature algorithm. RSA keys generated after that date must use a SHA-2 signature algorithm. Some older clients may need to be upgraded in order to use SHA-2 signatures. diff --git a/data/reusables/two_fa/auth_methods_2fa.md b/data/reusables/two_fa/auth_methods_2fa.md index 9395ebb068..328f64f0de 100644 --- a/data/reusables/two_fa/auth_methods_2fa.md +++ b/data/reusables/two_fa/auth_methods_2fa.md @@ -3,8 +3,8 @@ | Authentication Method | Description | Two-factor authentication support | |-----------------------|--------------|-----------------------------------| -| Built-in | Authentication is performed against user accounts that are stored on the {% data variables.product.prodname_ghe_server %} appliance. | Supported and managed on the {% data variables.product.prodname_ghe_server %} appliance. Organization administrators can require 2FA to be enabled for members of the organization. |{% ifversion ghes %} -| Built-in authentication with an identity provider| Authentication is performed against user accounts that are stored on the identity provider. | Dependant on the identity provider.{% endif %} +| Built-in | Authentication is performed against personal accounts that are stored on the {% data variables.product.prodname_ghe_server %} appliance. | Supported and managed on the {% data variables.product.prodname_ghe_server %} appliance. Organization administrators can require 2FA to be enabled for members of the organization. |{% ifversion ghes %} +| Built-in authentication with an identity provider| Authentication is performed against accounts that are stored on the identity provider. | Dependant on the identity provider.{% endif %} | LDAP | Allows integration with your company directory service for authentication. | Supported and managed on the {% data variables.product.prodname_ghe_server %} appliance. Organization administrators can require 2FA to be enabled for members of the organization. | | SAML | Authentication is performed on an external identity provider. | {% data reusables.two_fa.2fa_not_supported_with_saml_and_cas %} | | CAS | Single sign-on service is provided by an external server. | {% data reusables.two_fa.2fa_not_supported_with_saml_and_cas %}{% endif %} diff --git a/data/reusables/user-settings/security.md b/data/reusables/user-settings/security.md index 9e83e2c052..b3d3e4e418 100644 --- a/data/reusables/user-settings/security.md +++ b/data/reusables/user-settings/security.md @@ -2,5 +2,5 @@ 1. In the "Access" section of the sidebar, click **{% octicon "shield-lock" aria-label="The shield-lock icon" %} Password and authentication**. {% else %} 1. In the left sidebar, click **Account security**. -![User account security settings](/assets/images/help/settings/settings-sidebar-account-security.png) +![Personal account security settings](/assets/images/help/settings/settings-sidebar-account-security.png) {% endif %} diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 2e8f3e211c..dc7ff5c7a6 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -23112,19 +23112,29 @@ "properties": { "strict": { "type": "boolean", - "description": "Require branches to be up to date before merging." + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] }, "contexts": { - "type": "array", + "type": "array of strings", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] }, "checks": { - "type": "array", - "description": "The list of status checks to require in order to merge into this branch.", + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", "required": [ @@ -23133,14 +23143,55 @@ "properties": { "context": { "type": "string", - "description": "The name of the required check" + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status." + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] } } - } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -23154,7 +23205,123 @@ "null" ], "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_status_checks", + "parentType": "object", + "id": "required_status_checks-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean or null", @@ -23174,55 +23341,164 @@ "properties": { "dismissal_restrictions": { "type": "object", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with dismissal access", + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with dismissal access", + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] } - } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] }, "dismiss_stale_reviews": { "type": "boolean", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them." + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] }, "required_approving_review_count": { "type": "integer", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers." + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", + "childParamsGroups": [] }, "bypass_pull_request_allowances": { "type": "object", - "description": "Allow specific users or teams to bypass pull request requirements.", + "description": "

Allow specific users or teams to bypass pull request requirements.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s allowed to bypass pull request requirements.", + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s allowed to bypass pull request requirements.", + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] } - } + }, + "name": "bypass_pull_request_allowances", + "in": "body", + "rawType": "object", + "rawDescription": "Allow specific users or teams to bypass pull request requirements.", + "childParamsGroups": [ + { + "parentName": "bypass_pull_request_allowances", + "parentType": "object", + "id": "bypass_pull_request_allowances-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "required_pull_request_reviews", @@ -23232,32 +23508,278 @@ "null" ], "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_pull_request_reviews", + "parentType": "object", + "id": "required_pull_request_reviews-object", + "params": [ + { + "type": "object", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "properties": { + "users": { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + "teams": { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "boolean", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", + "childParamsGroups": [] + }, + { + "type": "object", + "description": "

Allow specific users or teams to bypass pull request requirements.

", + "properties": { + "users": { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + "teams": { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + }, + "name": "bypass_pull_request_allowances", + "in": "body", + "rawType": "object", + "rawDescription": "Allow specific users or teams to bypass pull request requirements.", + "childParamsGroups": [ + { + "parentName": "bypass_pull_request_allowances", + "parentType": "object", + "id": "bypass_pull_request_allowances-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "bypass_pull_request_allowances", + "parentType": "object", + "id": "bypass_pull_request_allowances-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "object or null", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with push access", + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with push access", + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] }, "apps": { - "type": "array", - "description": "The list of app `slug`s with push access", + "type": "array of strings", + "description": "

The list of app slugs with push access

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] } }, "required": [ @@ -23271,7 +23793,51 @@ "null" ], "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "restrictions", + "parentType": "object", + "id": "restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of app slugs with push access

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", @@ -38893,7 +39459,7 @@ } ], "previews": [], - "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", + "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -45287,11 +45853,21 @@ "properties": { "protected_branches": { "type": "boolean", - "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] }, "custom_branch_policies": { "type": "boolean", - "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] } }, "required": [ @@ -45305,7 +45881,33 @@ "null" ], "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "deployment_branch_policy", + "parentType": "object", + "id": "deployment_branch_policy-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + ] + } + ] } ], "enabledForGitHubApps": true, @@ -88527,33 +89129,114 @@ "properties": { "advanced_security": { "type": "object", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning_push_protection": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "security_and_analysis", @@ -88563,7 +89246,174 @@ "null" ], "rawDescription": "Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "security_and_analysis", + "parentType": "object", + "id": "security_and_analysis-object", + "params": [ + { + "type": "object", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 1021acde20..7d062ced20 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -17838,19 +17838,29 @@ "properties": { "strict": { "type": "boolean", - "description": "Require branches to be up to date before merging." + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] }, "contexts": { - "type": "array", + "type": "array of strings", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] }, "checks": { - "type": "array", - "description": "The list of status checks to require in order to merge into this branch.", + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", "required": [ @@ -17859,14 +17869,55 @@ "properties": { "context": { "type": "string", - "description": "The name of the required check" + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status." + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] } } - } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -17880,7 +17931,123 @@ "null" ], "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_status_checks", + "parentType": "object", + "id": "required_status_checks-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean or null", @@ -17900,35 +18067,97 @@ "properties": { "dismissal_restrictions": { "type": "object", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with dismissal access", + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with dismissal access", + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] } - } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] }, "dismiss_stale_reviews": { "type": "boolean", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them." + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] }, "required_approving_review_count": { "type": "integer", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6." + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "childParamsGroups": [] } }, "name": "required_pull_request_reviews", @@ -17938,32 +18167,180 @@ "null" ], "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_pull_request_reviews", + "parentType": "object", + "id": "required_pull_request_reviews-object", + "params": [ + { + "type": "object", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "properties": { + "users": { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + "teams": { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "boolean", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "object or null", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with push access", + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with push access", + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] }, "apps": { - "type": "array", - "description": "The list of app `slug`s with push access", + "type": "array of strings", + "description": "

The list of app slugs with push access

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] } }, "required": [ @@ -17977,7 +18354,51 @@ "null" ], "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "restrictions", + "parentType": "object", + "id": "restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of app slugs with push access

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", @@ -27616,7 +28037,7 @@ } ], "previews": [], - "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", + "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index b24c404159..877c18f946 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -18894,19 +18894,29 @@ "properties": { "strict": { "type": "boolean", - "description": "Require branches to be up to date before merging." + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] }, "contexts": { - "type": "array", + "type": "array of strings", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] }, "checks": { - "type": "array", - "description": "The list of status checks to require in order to merge into this branch.", + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", "required": [ @@ -18915,14 +18925,55 @@ "properties": { "context": { "type": "string", - "description": "The name of the required check" + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status." + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] } } - } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -18936,7 +18987,123 @@ "null" ], "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_status_checks", + "parentType": "object", + "id": "required_status_checks-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean or null", @@ -18956,35 +19123,97 @@ "properties": { "dismissal_restrictions": { "type": "object", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with dismissal access", + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with dismissal access", + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] } - } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] }, "dismiss_stale_reviews": { "type": "boolean", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them." + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] }, "required_approving_review_count": { "type": "integer", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6." + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "childParamsGroups": [] } }, "name": "required_pull_request_reviews", @@ -18994,32 +19223,180 @@ "null" ], "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_pull_request_reviews", + "parentType": "object", + "id": "required_pull_request_reviews-object", + "params": [ + { + "type": "object", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "properties": { + "users": { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + "teams": { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "boolean", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "object or null", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with push access", + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with push access", + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] }, "apps": { - "type": "array", - "description": "The list of app `slug`s with push access", + "type": "array of strings", + "description": "

The list of app slugs with push access

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] } }, "required": [ @@ -19033,7 +19410,51 @@ "null" ], "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "restrictions", + "parentType": "object", + "id": "restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of app slugs with push access

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", @@ -28684,7 +29105,7 @@ } ], "previews": [], - "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", + "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -33806,11 +34227,21 @@ "properties": { "protected_branches": { "type": "boolean", - "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] }, "custom_branch_policies": { "type": "boolean", - "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] } }, "required": [ @@ -33824,7 +34255,33 @@ "null" ], "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "deployment_branch_policy", + "parentType": "object", + "id": "deployment_branch_policy-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + ] + } + ] } ], "enabledForGitHubApps": true, @@ -72170,33 +72627,114 @@ "properties": { "advanced_security": { "type": "object", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning_push_protection": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "security_and_analysis", @@ -72206,7 +72744,174 @@ "null" ], "rawDescription": "Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "security_and_analysis", + "parentType": "object", + "id": "security_and_analysis-object", + "params": [ + { + "type": "object", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 0354964241..1b06bcca41 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -18980,19 +18980,29 @@ "properties": { "strict": { "type": "boolean", - "description": "Require branches to be up to date before merging." + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] }, "contexts": { - "type": "array", + "type": "array of strings", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] }, "checks": { - "type": "array", - "description": "The list of status checks to require in order to merge into this branch.", + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", "required": [ @@ -19001,14 +19011,55 @@ "properties": { "context": { "type": "string", - "description": "The name of the required check" + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status." + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] } } - } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -19022,7 +19073,123 @@ "null" ], "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_status_checks", + "parentType": "object", + "id": "required_status_checks-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean or null", @@ -19042,35 +19209,97 @@ "properties": { "dismissal_restrictions": { "type": "object", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with dismissal access", + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with dismissal access", + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] } - } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] }, "dismiss_stale_reviews": { "type": "boolean", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them." + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] }, "required_approving_review_count": { "type": "integer", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6." + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "childParamsGroups": [] } }, "name": "required_pull_request_reviews", @@ -19080,32 +19309,180 @@ "null" ], "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_pull_request_reviews", + "parentType": "object", + "id": "required_pull_request_reviews-object", + "params": [ + { + "type": "object", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "properties": { + "users": { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + "teams": { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "boolean", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "object or null", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with push access", + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with push access", + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] }, "apps": { - "type": "array", - "description": "The list of app `slug`s with push access", + "type": "array of strings", + "description": "

The list of app slugs with push access

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] } }, "required": [ @@ -19119,7 +19496,51 @@ "null" ], "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "restrictions", + "parentType": "object", + "id": "restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of app slugs with push access

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", @@ -28839,7 +29260,7 @@ } ], "previews": [], - "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", + "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -33944,11 +34365,21 @@ "properties": { "protected_branches": { "type": "boolean", - "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] }, "custom_branch_policies": { "type": "boolean", - "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] } }, "required": [ @@ -33962,7 +34393,33 @@ "null" ], "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "deployment_branch_policy", + "parentType": "object", + "id": "deployment_branch_policy-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + ] + } + ] } ], "enabledForGitHubApps": true, @@ -72111,33 +72568,114 @@ "properties": { "advanced_security": { "type": "object", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning_push_protection": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "security_and_analysis", @@ -72147,7 +72685,174 @@ "null" ], "rawDescription": "Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "security_and_analysis", + "parentType": "object", + "id": "security_and_analysis-object", + "params": [ + { + "type": "object", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 0bdb7de4bb..13e21e364e 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -20086,19 +20086,29 @@ "properties": { "strict": { "type": "boolean", - "description": "Require branches to be up to date before merging." + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] }, "contexts": { - "type": "array", + "type": "array of strings", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] }, "checks": { - "type": "array", - "description": "The list of status checks to require in order to merge into this branch.", + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", "required": [ @@ -20107,14 +20117,55 @@ "properties": { "context": { "type": "string", - "description": "The name of the required check" + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status." + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] } } - } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -20128,7 +20179,123 @@ "null" ], "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_status_checks", + "parentType": "object", + "id": "required_status_checks-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean or null", @@ -20148,55 +20315,164 @@ "properties": { "dismissal_restrictions": { "type": "object", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with dismissal access", + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with dismissal access", + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] } - } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] }, "dismiss_stale_reviews": { "type": "boolean", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them." + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] }, "required_approving_review_count": { "type": "integer", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers." + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", + "childParamsGroups": [] }, "bypass_pull_request_allowances": { "type": "object", - "description": "Allow specific users or teams to bypass pull request requirements.", + "description": "

Allow specific users or teams to bypass pull request requirements.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s allowed to bypass pull request requirements.", + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s allowed to bypass pull request requirements.", + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] } - } + }, + "name": "bypass_pull_request_allowances", + "in": "body", + "rawType": "object", + "rawDescription": "Allow specific users or teams to bypass pull request requirements.", + "childParamsGroups": [ + { + "parentName": "bypass_pull_request_allowances", + "parentType": "object", + "id": "bypass_pull_request_allowances-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "required_pull_request_reviews", @@ -20206,32 +20482,278 @@ "null" ], "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_pull_request_reviews", + "parentType": "object", + "id": "required_pull_request_reviews-object", + "params": [ + { + "type": "object", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "properties": { + "users": { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + "teams": { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "boolean", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", + "childParamsGroups": [] + }, + { + "type": "object", + "description": "

Allow specific users or teams to bypass pull request requirements.

", + "properties": { + "users": { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + "teams": { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + }, + "name": "bypass_pull_request_allowances", + "in": "body", + "rawType": "object", + "rawDescription": "Allow specific users or teams to bypass pull request requirements.", + "childParamsGroups": [ + { + "parentName": "bypass_pull_request_allowances", + "parentType": "object", + "id": "bypass_pull_request_allowances-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "bypass_pull_request_allowances", + "parentType": "object", + "id": "bypass_pull_request_allowances-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "object or null", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with push access", + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with push access", + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] }, "apps": { - "type": "array", - "description": "The list of app `slug`s with push access", + "type": "array of strings", + "description": "

The list of app slugs with push access

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] } }, "required": [ @@ -20245,7 +20767,51 @@ "null" ], "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "restrictions", + "parentType": "object", + "id": "restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of app slugs with push access

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", @@ -30130,7 +30696,7 @@ } ], "previews": [], - "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", + "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -36395,11 +36961,21 @@ "properties": { "protected_branches": { "type": "boolean", - "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] }, "custom_branch_policies": { "type": "boolean", - "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] } }, "required": [ @@ -36413,7 +36989,33 @@ "null" ], "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "deployment_branch_policy", + "parentType": "object", + "id": "deployment_branch_policy-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + ] + } + ] } ], "enabledForGitHubApps": true, @@ -76283,33 +76885,114 @@ "properties": { "advanced_security": { "type": "object", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning_push_protection": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "security_and_analysis", @@ -76319,7 +77002,174 @@ "null" ], "rawDescription": "Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "security_and_analysis", + "parentType": "object", + "id": "security_and_analysis-object", + "params": [ + { + "type": "object", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 5cf164b516..6c0b571d3e 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -15998,19 +15998,29 @@ "properties": { "strict": { "type": "boolean", - "description": "Require branches to be up to date before merging." + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] }, "contexts": { - "type": "array", + "type": "array of strings", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", "items": { "type": "string" - } + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] }, "checks": { - "type": "array", - "description": "The list of status checks to require in order to merge into this branch.", + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", "items": { "type": "object", "required": [ @@ -16019,14 +16029,55 @@ "properties": { "context": { "type": "string", - "description": "The name of the required check" + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] }, "app_id": { "type": "integer", - "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status." + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] } } - } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -16040,7 +16091,123 @@ "null" ], "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_status_checks", + "parentType": "object", + "id": "required_status_checks-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Require branches to be up to date before merging.

", + "name": "strict", + "in": "body", + "rawType": "boolean", + "rawDescription": "Require branches to be up to date before merging.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "deprecated": true, + "description": "

Required. Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "items": { + "type": "string" + }, + "name": "contexts", + "in": "body", + "rawType": "array", + "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "childParamsGroups": [] + }, + { + "type": "array of objects", + "description": "

The list of status checks to require in order to merge into this branch.

", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + "app_id": { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + } + }, + "name": "checks", + "in": "body", + "rawType": "array", + "rawDescription": "The list of status checks to require in order to merge into this branch.", + "childParamsGroups": [ + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "checks", + "parentType": "items", + "id": "checks-items", + "params": [ + { + "type": "string", + "description": "

Required. The name of the required check

", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the required check", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean or null", @@ -16060,55 +16227,164 @@ "properties": { "dismissal_restrictions": { "type": "object", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with dismissal access", + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with dismissal access", + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] } - } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] }, "dismiss_stale_reviews": { "type": "boolean", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them." + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] }, "required_approving_review_count": { "type": "integer", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers." + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", + "childParamsGroups": [] }, "bypass_pull_request_allowances": { "type": "object", - "description": "Allow specific users or teams to bypass pull request requirements.", + "description": "

Allow specific users or teams to bypass pull request requirements.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s allowed to bypass pull request requirements.", + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s allowed to bypass pull request requirements.", + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] } - } + }, + "name": "bypass_pull_request_allowances", + "in": "body", + "rawType": "object", + "rawDescription": "Allow specific users or teams to bypass pull request requirements.", + "childParamsGroups": [ + { + "parentName": "bypass_pull_request_allowances", + "parentType": "object", + "id": "bypass_pull_request_allowances-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "required_pull_request_reviews", @@ -16118,32 +16394,278 @@ "null" ], "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "required_pull_request_reviews", + "parentType": "object", + "id": "required_pull_request_reviews-object", + "params": [ + { + "type": "object", + "description": "

Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "properties": { + "users": { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + "teams": { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + }, + "name": "dismissal_restrictions", + "in": "body", + "rawType": "object", + "rawDescription": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "childParamsGroups": [ + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "boolean", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

", + "name": "dismiss_stale_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Blocks merging pull requests until code owners review them.

", + "name": "require_code_owner_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

", + "name": "required_approving_review_count", + "in": "body", + "rawType": "integer", + "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", + "childParamsGroups": [] + }, + { + "type": "object", + "description": "

Allow specific users or teams to bypass pull request requirements.

", + "properties": { + "users": { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + "teams": { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + }, + "name": "bypass_pull_request_allowances", + "in": "body", + "rawType": "object", + "rawDescription": "Allow specific users or teams to bypass pull request requirements.", + "childParamsGroups": [ + { + "parentName": "bypass_pull_request_allowances", + "parentType": "object", + "id": "bypass_pull_request_allowances-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "dismissal_restrictions", + "parentType": "object", + "id": "dismissal_restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins with dismissal access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with dismissal access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs with dismissal access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with dismissal access", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "bypass_pull_request_allowances", + "parentType": "object", + "id": "bypass_pull_request_allowances-object", + "params": [ + { + "type": "array of strings", + "description": "

The list of user logins allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of team slugs allowed to bypass pull request requirements.

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "object or null", "description": "

Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", "properties": { "users": { - "type": "array", - "description": "The list of user `login`s with push access", + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", "items": { "type": "string" - } + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] }, "teams": { - "type": "array", - "description": "The list of team `slug`s with push access", + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", "items": { "type": "string" - } + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] }, "apps": { - "type": "array", - "description": "The list of app `slug`s with push access", + "type": "array of strings", + "description": "

The list of app slugs with push access

", "items": { "type": "string" - } + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] } }, "required": [ @@ -16157,7 +16679,51 @@ "null" ], "rawDescription": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "restrictions", + "parentType": "object", + "id": "restrictions-object", + "params": [ + { + "type": "array of strings", + "description": "

Required. The list of user logins with push access

", + "items": { + "type": "string" + }, + "name": "users", + "in": "body", + "rawType": "array", + "rawDescription": "The list of user `login`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

Required. The list of team slugs with push access

", + "items": { + "type": "string" + }, + "name": "teams", + "in": "body", + "rawType": "array", + "rawDescription": "The list of team `slug`s with push access", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The list of app slugs with push access

", + "items": { + "type": "string" + }, + "name": "apps", + "in": "body", + "rawType": "array", + "rawDescription": "The list of app `slug`s with push access", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", @@ -25991,7 +26557,7 @@ } ], "previews": [], - "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", + "descriptionHTML": "

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.

\n

Team members will include the members of child teams.

\n

You must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -31096,11 +31662,21 @@ "properties": { "protected_branches": { "type": "boolean", - "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] }, "custom_branch_policies": { "type": "boolean", - "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] } }, "required": [ @@ -31114,7 +31690,33 @@ "null" ], "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "deployment_branch_policy", + "parentType": "object", + "id": "deployment_branch_policy-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + ] + } + ] } ], "enabledForGitHubApps": true, @@ -66766,33 +67368,114 @@ "properties": { "advanced_security": { "type": "object", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, "secret_scanning_push_protection": { "type": "object", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", "properties": { "status": { "type": "string", - "description": "Can be `enabled` or `disabled`." + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] } - } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "security_and_analysis", @@ -66802,7 +67485,174 @@ "null" ], "rawDescription": "Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "security_and_analysis", + "parentType": "object", + "id": "security_and_analysis-object", + "params": [ + { + "type": "object", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "advanced_security", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "childParamsGroups": [ + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning_push_protection", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "parentName": "advanced_security", + "parentType": "object", + "id": "advanced_security-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + }, + { + "parentName": "secret_scanning_push_protection", + "parentType": "object", + "id": "secret_scanning_push_protection-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] }, { "type": "boolean", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 44c2be8ce0..5cd8e730ff 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -29288,23 +29288,47 @@ "type": "integer", "description": "Total minutes used on Windows runner machines." }, - "CUSTOM_LINUX_4_CORE": { + "linux_4_core": { "type": "integer", - "description": "Total minutes used on custom Linux 4 core runner machines." + "description": "Total minutes used on Linux 4 core runner machines." }, - "CUSTOM_LINUX_8_CORE": { + "linux_8_core": { "type": "integer", - "description": "Total minutes used on custom Linux 8 core runner machines." + "description": "Total minutes used on Linux 8 core runner machines." }, - "TOTAL_WITH_ENTITLEMENTS": { + "linux_16_core": { "type": "integer", - "description": "Total minutes used on all standard runner machines." + "description": "Total minutes used on Linux 16 core runner machines." }, - "TOTAL_WITHOUT_ENTITLEMENTS": { + "linux_32_core": { "type": "integer", - "description": "Total minutes used on all custom runner machines." + "description": "Total minutes used on Linux 32 core runner machines." }, - "TOTAL": { + "linux_64_core": { + "type": "integer", + "description": "Total minutes used on Linux 64 core runner machines." + }, + "windows_4_core": { + "type": "integer", + "description": "Total minutes used on Windows 4 core runner machines." + }, + "windows_8_core": { + "type": "integer", + "description": "Total minutes used on Windows 8 core runner machines." + }, + "windows_16_core": { + "type": "integer", + "description": "Total minutes used on Windows 16 core runner machines." + }, + "windows_32_core": { + "type": "integer", + "description": "Total minutes used on Windows 32 core runner machines." + }, + "windows_64_core": { + "type": "integer", + "description": "Total minutes used on Windows 64 core runner machines." + }, + "total": { "type": "integer", "description": "Total minutes used on all runner machines." } @@ -124801,23 +124825,47 @@ "type": "integer", "description": "Total minutes used on Windows runner machines." }, - "CUSTOM_LINUX_4_CORE": { + "linux_4_core": { "type": "integer", - "description": "Total minutes used on custom Linux 4 core runner machines." + "description": "Total minutes used on Linux 4 core runner machines." }, - "CUSTOM_LINUX_8_CORE": { + "linux_8_core": { "type": "integer", - "description": "Total minutes used on custom Linux 8 core runner machines." + "description": "Total minutes used on Linux 8 core runner machines." }, - "TOTAL_WITH_ENTITLEMENTS": { + "linux_16_core": { "type": "integer", - "description": "Total minutes used on all standard runner machines." + "description": "Total minutes used on Linux 16 core runner machines." }, - "TOTAL_WITHOUT_ENTITLEMENTS": { + "linux_32_core": { "type": "integer", - "description": "Total minutes used on all custom runner machines." + "description": "Total minutes used on Linux 32 core runner machines." }, - "TOTAL": { + "linux_64_core": { + "type": "integer", + "description": "Total minutes used on Linux 64 core runner machines." + }, + "windows_4_core": { + "type": "integer", + "description": "Total minutes used on Windows 4 core runner machines." + }, + "windows_8_core": { + "type": "integer", + "description": "Total minutes used on Windows 8 core runner machines." + }, + "windows_16_core": { + "type": "integer", + "description": "Total minutes used on Windows 16 core runner machines." + }, + "windows_32_core": { + "type": "integer", + "description": "Total minutes used on Windows 32 core runner machines." + }, + "windows_64_core": { + "type": "integer", + "description": "Total minutes used on Windows 64 core runner machines." + }, + "total": { "type": "integer", "description": "Total minutes used on all runner machines." } @@ -242758,7 +242806,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", "tags": [ "repos" ], @@ -581007,23 +581055,47 @@ "type": "integer", "description": "Total minutes used on Windows runner machines." }, - "CUSTOM_LINUX_4_CORE": { + "linux_4_core": { "type": "integer", - "description": "Total minutes used on custom Linux 4 core runner machines." + "description": "Total minutes used on Linux 4 core runner machines." }, - "CUSTOM_LINUX_8_CORE": { + "linux_8_core": { "type": "integer", - "description": "Total minutes used on custom Linux 8 core runner machines." + "description": "Total minutes used on Linux 8 core runner machines." }, - "TOTAL_WITH_ENTITLEMENTS": { + "linux_16_core": { "type": "integer", - "description": "Total minutes used on all standard runner machines." + "description": "Total minutes used on Linux 16 core runner machines." }, - "TOTAL_WITHOUT_ENTITLEMENTS": { + "linux_32_core": { "type": "integer", - "description": "Total minutes used on all custom runner machines." + "description": "Total minutes used on Linux 32 core runner machines." }, - "TOTAL": { + "linux_64_core": { + "type": "integer", + "description": "Total minutes used on Linux 64 core runner machines." + }, + "windows_4_core": { + "type": "integer", + "description": "Total minutes used on Windows 4 core runner machines." + }, + "windows_8_core": { + "type": "integer", + "description": "Total minutes used on Windows 8 core runner machines." + }, + "windows_16_core": { + "type": "integer", + "description": "Total minutes used on Windows 16 core runner machines." + }, + "windows_32_core": { + "type": "integer", + "description": "Total minutes used on Windows 32 core runner machines." + }, + "windows_64_core": { + "type": "integer", + "description": "Total minutes used on Windows 64 core runner machines." + }, + "total": { "type": "integer", "description": "Total minutes used on all runner machines." } diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index 3b6d239331..1913ac860d 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -188981,7 +188981,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index ca3e27e079..a8a50dc567 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -193392,7 +193392,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 18d3452436..391ca75ce3 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -196946,7 +196946,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 4235076203..3c78e41c88 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -212764,7 +212764,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index b20102aa43..05f1e88daf 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -177435,7 +177435,7 @@ "/repos/{owner}/{repo}/collaborators": { "get": { "summary": "List repository collaborators", - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nYou must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this\nendpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this\nendpoint.", "tags": [ "repos" ], diff --git a/script/content-migrations/update-tocs.js b/script/content-migrations/update-tocs.js index e840775eb6..11fe5b01fe 100755 --- a/script/content-migrations/update-tocs.js +++ b/script/content-migrations/update-tocs.js @@ -73,7 +73,7 @@ indexFiles.forEach((indexFile) => { if (relativePath === 'discussions/guides/index.md') { data.children = [ '/best-practices-for-community-conversations-on-github', - '/finding-discussions-across-multiple-repositories', + '/finding-your-discussions', '/granting-higher-permissions-to-top-contributors', ] } diff --git a/script/rest/utils/operation.js b/script/rest/utils/operation.js index 708cd72c1e..bf77b0c691 100644 --- a/script/rest/utils/operation.js +++ b/script/rest/utils/operation.js @@ -307,8 +307,12 @@ async function getBodyParams(paramsObject, requiredParams) { param.childParamsGroups.push(childParamsGroup) } - // if the param is an object, it may have child object params that have child params :/ - if (param.rawType === 'object') { + // If the param is an object, it may have child object params that have child params :/ + // Objects can potentially be null where the rawType is [ 'object', 'null' ]. + if ( + param.rawType === 'object' || + (Array.isArray(param.rawType) && param.rawType.includes('object')) + ) { param.childParamsGroups.push( ...flatten( childParamsGroup.params @@ -324,8 +328,18 @@ async function getBodyParams(paramsObject, requiredParams) { } async function getChildParamsGroup(param) { - // only objects, arrays of objects, anyOf, allOf, and oneOf have child params - if (!(param.rawType === 'array' || param.rawType === 'object' || param.oneOf)) return + // Only objects, arrays of objects, anyOf, allOf, and oneOf have child params. + // Objects can potentially be null where the rawType is [ 'object', 'null' ]. + if ( + !( + param.rawType === 'array' || + (Array.isArray(param.rawType) && param.rawType.includes('array')) || + param.rawType === 'object' || + (Array.isArray(param.rawType) && param.rawType.includes('object')) || + param.oneOf + ) + ) + return if ( param.oneOf && !param.oneOf.filter((param) => param.type === 'object' || param.type === 'array') @@ -338,7 +352,19 @@ async function getChildParamsGroup(param) { const childParams = await getBodyParams(childParamsObject, requiredParams) // adjust the type for easier readability in the child table - const parentType = param.rawType === 'array' ? 'items' : param.rawType + let parentType + + if (param.rawType === 'array') { + parentType = 'items' + } else if (Array.isArray(param.rawType) && param.rawType.includes('array')) { + // handle the case where rawType is [ 'array', 'null' ] + parentType = 'items' + } else if (Array.isArray(param.rawType) && param.rawType.includes('object')) { + // handle the case where rawType is [ 'object', 'null' ] + parentType = 'object' + } else { + parentType = param.rawType + } // add an ID to the child table so they can be linked to slugger.reset() diff --git a/tests/rendering/breadcrumbs.js b/tests/rendering/breadcrumbs.js index f3da2035d9..363416717f 100644 --- a/tests/rendering/breadcrumbs.js +++ b/tests/rendering/breadcrumbs.js @@ -23,7 +23,7 @@ describe('breadcrumbs', () => { expect($breadcrumbs).toHaveLength(8) expect($breadcrumbs[0].attribs.title).toBe('Account and profile') - expect($breadcrumbs[1].attribs.title).toBe('User accounts') + expect($breadcrumbs[1].attribs.title).toBe('Personal accounts') expect($breadcrumbs[2].attribs.title).toBe('Manage email preferences') expect($breadcrumbs[3].attribs.title).toBe('Add an email address') }) @@ -36,7 +36,7 @@ describe('breadcrumbs', () => { expect($breadcrumbs).toHaveLength(6) expect($breadcrumbs[0].attribs.title).toBe('Account and profile') - expect($breadcrumbs[1].attribs.title).toBe('User accounts') + expect($breadcrumbs[1].attribs.title).toBe('Personal accounts') expect($breadcrumbs[2].attribs.title).toBe('Manage email preferences') expect($breadcrumbs[2].attribs.class.includes('color-fg-muted')).toBe(true) }) @@ -158,11 +158,11 @@ describe('breadcrumbs', () => { }, { href: '/en/account-and-profile/setting-up-and-managing-your-github-user-account', - title: 'User accounts', + title: 'Personal accounts', }, { href: '/en/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings', - title: 'User account settings', + title: 'Personal account settings', }, ] expect(breadcrumbs).toEqual(expected) @@ -179,11 +179,11 @@ describe('breadcrumbs', () => { }, { href: '/en/account-and-profile/setting-up-and-managing-your-github-user-account', - title: 'User accounts', + title: 'Personal accounts', }, { href: '/en/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings', - title: 'User account settings', + title: 'Personal account settings', }, { href: '/en/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard', diff --git a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md index 52ba81a4a4..feb4c6a43d 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md @@ -192,7 +192,7 @@ Define uma tarefa chamada check-bats-version. As chaves secundaári ``` -A palavra-chave usa especifica que esta etapa irá executar v2 da ação actions/checkout. Esta é uma ação que faz o check-out do seu repositório para o executor, permitindo que você execute scripts ou outras ações com base no seu código (como ferramentas de compilação e teste). Você deve usar a ação de checkout sempre que o fluxo de trabalho for executado no código do repositório. +The uses keyword specifies that this step will run v3 of the actions/checkout action. Esta é uma ação que faz o check-out do seu repositório para o executor, permitindo que você execute scripts ou outras ações com base no seu código (como ferramentas de compilação e teste). Você deve usar a ação de checkout sempre que o fluxo de trabalho for executado no código do repositório. diff --git a/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md b/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md index d02ca901ba..973c48b0a7 100644 --- a/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md +++ b/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md @@ -49,7 +49,7 @@ Você especifica com que frequência verifica cada ecossistema para novas versõ Se tiver habilitado atualizações de segurança, às vezes você verá atualizações de segurança extras de pull requests. Elas são acionadas por um alerta de {% data variables.product.prodname_dependabot %} para uma dependência de seu branch padrão. {% data variables.product.prodname_dependabot %} gera automaticamente um pull request para atualizar a dependência vulnerável. ## Repositórios e ecossistemas suportados - + É possível configurar atualizações de versão para repositórios que contenham um manifesto de dependência ou arquivo de bloqueio para um dos gerentes de pacotes suportados. Para alguns gerenciadores de pacotes, você também pode configurar o armazenamento para dependências. Para obter mais informações, consulte "[Opções de configuração para o arquivo dependabot.yml](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#vendor)". {% note %} diff --git a/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md b/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md index 52cf6e8435..6f06cd0059 100644 --- a/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md +++ b/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md @@ -9,19 +9,34 @@ versions: ## Sobre o {% data variables.product.prodname_discussions %} -Com {% data variables.product.prodname_discussions %}, a comunidade para o seu projeto pode criar e participar de conversas no repositório do projeto. As discussões capacitam os mantenedores, contribuidores e visitantes para reunirem e atingirem os objetivos seguintes em um local central, sem ferramentas de terceiros. +With {% data variables.product.prodname_discussions %}, the community for your project can create and participate in conversations within the project's repository or organization. As discussões capacitam os mantenedores, contribuidores e visitantes para reunirem e atingirem os objetivos seguintes em um local central, sem ferramentas de terceiros. - Compartilhar anúncios e informações, recolher feedback, planejar e tomar decisões - Faça perguntas, discuta e responda às perguntas, e marque as discussões como respondidas +- Create polls to gauge community opinion - Promova uma atmosfera convidativa para visitantes e contribuidores para discutir objetivos, desenvolvimento, administração e fluxos de trabalho ![Aba de discussões para um repositório](/assets/images/help/discussions/hero.png) +You might use repository discussions to discuss topics that are specific to the repository. If your project spans multiple repositories, you might use organization discussions to discuss topics that aren't specific to a single repository in your organization. + Você não precisa fechar uma discussão como você fecha um problema ou um pull request. -Se um administrador de repositório ou mantenedor do projeto habilitar {% data variables.product.prodname_discussions %} para um repositório, qualquer pessoa que visitar o repositório poderá criar e participar de discussões do repositório. Os administradores de repositório e mantenedores de projetos podem gerenciar as discussões e categorias de discussão em um repositório e fixar discussões para aumentar a visibilidade da discussão. Os moderadores e colaboradores podem marcar comentários como respostas, travar discussões e converter problemas em discussões. Para obter mais informações, consulte "[Funções do repositório para uma organização](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)". +Se um administrador de repositório ou mantenedor do projeto habilitar {% data variables.product.prodname_discussions %} para um repositório, qualquer pessoa que visitar o repositório poderá criar e participar de discussões do repositório. If an organization owner enables {% data variables.product.prodname_discussions %} for an organization, anyone who can view the source repository can create an organization discussion. -Para obter mais informações sobre o gerenciamento de discussões para o repositório, consulte "[Gerenciar discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)". +Os administradores de repositório e mantenedores de projetos podem gerenciar as discussões e categorias de discussão em um repositório e fixar discussões para aumentar a visibilidade da discussão. Os moderadores e colaboradores podem marcar comentários como respostas, travar discussões e converter problemas em discussões. Similarly, for organization discussions, the role of a user in the source repository determines how a user can interact with organization discussions. Para obter mais informações, consulte "[Funções do repositório para uma organização](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)". + +For more information about management of discussions, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions)." + +## About polls + +You can create polls in the polls category to gauge interest in new ideas and project direction. Anyone with read access to your repository can create polls, vote in polls, and view their results. Logged out users can view the results of polls in public repositories. + +Polls require a question and at least two options. You can add a maximum of eight options and the options can contain a maximum of 128 characters. + +Voters cannot change their vote. Editing a poll will reset any votes that have already been cast. + +For more information on creating polls, see "[Creating a poll](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-poll)." ## Sobre a organização de discussão @@ -33,7 +48,7 @@ Para discussões com um formato de pergunta/resposta, é possível marcar um com {% data reusables.discussions.about-announcement-format %} -Para obter mais informações, consulte "[Gerenciar categorias para discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)". +For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)." {% data reusables.discussions.you-can-label-discussions %} @@ -43,9 +58,9 @@ Como integrante ou mantenedor da comunidade, inicie uma discussão para fazer um Participe de uma discussão para fazer e responder a perguntas, fornecer feedback e envolver-se com a comunidade do projeto. Para obter mais informações, consulte "[Participar de uma discussão](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion)". -Você pode destacar discussões que contenham conversas importantes, úteis ou exemplares entre os integrantes da comunidade. Para obter mais informações, consulte "[Gerenciar discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#pinning-a-discussion)". +Você pode destacar discussões que contenham conversas importantes, úteis ou exemplares entre os integrantes da comunidade. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#pinning-a-discussion)." -{% data reusables.discussions.you-can-convert-an-issue %} Para obter mais informações, consulte "[Moderar discussões no seu repositório](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)". +{% data reusables.discussions.you-can-convert-an-issue %} For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)." ## Compartilhando feedback diff --git a/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md b/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md index 980f2176dd..aaa65fba46 100644 --- a/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md +++ b/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md @@ -2,7 +2,7 @@ title: Colaboração com mantenedores usando as discussões shortTitle: Colaborando com mantenedores intro: 'Você pode contribuir para objetivos, planos, saúde e comunidade para um projeto em {% data variables.product.product_name %} comunicando-se com os mantenedores do projeto em uma discussão.' -permissions: 'People with read access to a repository can start and participate in discussions in the repository. {% data reusables.enterprise-accounts.emu-permission-interact %}' +permissions: 'People with read access to a repository can start and participate in discussions and polls in the repository. People with read access to the source repository for organization discussions can start and participate in discussions and polls in the organization. {% data reusables.enterprise-accounts.emu-permission-interact %}' versions: fpt: '*' ghec: '*' @@ -15,7 +15,7 @@ versions: {% data reusables.discussions.about-categories-and-formats %} {% data reusables.discussions.about-announcement-format %} -Os administradores de repositório e mantenedores de projeto podem excluir uma discussão. Para obter mais informações, consulte "[Gerenciar discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion)". +Repository administrators and project maintainers can delete a discussion in that repository. Similarly, administrators and maintainers of the source repository for an organization's discussions can delete a discussion in that organization. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#deleting-a-discussion)." {% data reusables.discussions.github-recognizes-members %} Estes membros aparecem em uma lista dos colaboradores mais úteis para as discussões do projeto. À medida que o seu projeto cresce, você pode conceder mais permissões de acesso aos integrantes ativos da sua comunidade. Para obter mais informações, consulte "[Conceder permissões mais elevadas aos melhores contribuidores](/discussions/guides/granting-higher-permissions-to-top-contributors)" @@ -25,24 +25,30 @@ Para obter mais informações sobre a participação em discussões, consulte "[ ## Pré-requisitos -Para colaborar com mantenedores em discussões, um administrador ou mantenedor do projeto deverá habilitar {% data variables.product.prodname_discussions %} para o repositório. Para obter mais informações, consulte "[Habilitando ou desabilitando {% data variables.product.prodname_discussions %} para um repositório](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)". +To collaborate with maintainers in repository discussions, a repository administrator or project maintainer must enable {% data variables.product.prodname_discussions %} for the repository. Para obter mais informações, consulte "[Habilitando ou desabilitando {% data variables.product.prodname_discussions %} para um repositório](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)". + +To collaborate with maintainers in organization discussions, {% data variables.product.prodname_discussions %} must be enabled for the organization. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." ## Iniciar uma discussão {% data reusables.discussions.starting-a-discussion %} +## Starting a poll + +{% data reusables.discussions.starting-a-poll %} + ## Filtrar a lista de discussões -É possível pesquisar discussões e filtrar a lista de discussões em um repositório. Para obter mais informações, consulte "[Pesquisar discussões](/search-github/searching-on-github/searching-discussions)". +You can search for discussions and filter the list of discussions in a repository or organization. Para obter mais informações, consulte "[Pesquisar discussões](/search-github/searching-on-github/searching-discussions)". -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} 1. No campo **Pesquisar todas as discussões**, digite uma consulta de pesquisa. Opcionalmente, à direita do campo de pesquisa, clique em um botão para filtrar ainda mais os resultados. ![Barra de pesquisa e botões para filtrar discussões](/assets/images/help/discussions/search-and-filter-controls.png) 1. Na lista de discussões, clique na discussão que você deseja visualizar. ![Resultados da busca de discussões](/assets/images/help/discussions/search-result.png) ## Converter um problema em uma discussão -{% data reusables.discussions.you-can-convert-an-issue %} Para obter mais informações, consulte "[Moderar discussões no seu repositório](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion#converting-an-issue-to-a-discussion)". +{% data reusables.discussions.you-can-convert-an-issue %} For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions#converting-an-issue-to-a-discussion)." ## Leia mais diff --git a/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md b/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md index f179a1504d..3f26fb5126 100644 --- a/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md +++ b/translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md @@ -1,7 +1,7 @@ --- title: Participando de uma discussão intro: 'Você pode conversar com a comunidade e mantenedores em um fórum do repositório para um projeto em {% data variables.product.product_name %}.' -permissions: 'People with read access to a repository can participate in discussions in the repository. {% data reusables.enterprise-accounts.emu-permission-interact %}' +permissions: 'People with read access to a repository can participate in discussions and polls in the repository. People with read access to the source repository for organization discussions can participate in discussions and polls in that organization. {% data reusables.enterprise-accounts.emu-permission-interact %}' versions: fpt: '*' ghec: '*' @@ -13,20 +13,24 @@ shortTitle: Participar da discussão {% data reusables.discussions.about-discussions %} Para obter mais informações, consulte "[Sobre discussões](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". -Além de começar ou visualizar uma discussão, você pode comentar em resposta ao comentário original do autor da discussão. Você também pode criar um tópico de comentário respondendo a um comentário individual feito por outro integrante da comunidade dentro da discussão e reagir aos comentários com emoji. +In addition to starting or viewing discussions and polls, you can comment in response to the original comment from the author of the discussion. Você também pode criar um tópico de comentário respondendo a um comentário individual feito por outro integrante da comunidade dentro da discussão e reagir aos comentários com emoji. Você pode bloquear usuários e reportar conteúdo disruptivo para manter um ambiente seguro e agradável para você mesmo em {% data variables.product.product_name %}. Para obter mais informações, consulte "[Manter sua segurança em {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)". ## Pré-requisitos -{% data variables.product.prodname_discussions %} deve estar habilitado para o repositório para que você participe de uma discussão no repositório. Para obter mais informações, consulte "[Habilitando ou desabilitando {% data variables.product.prodname_discussions %} para um repositório](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)". +{% data variables.product.prodname_discussions %} must be enabled for the repository or organization for you to participate in a discussion in the repository or organization. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for a repository](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)" and "[Enabling or disabling GitHub Discussions for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." ## Criar uma discussão {% data reusables.discussions.starting-a-discussion %} +## Creating a poll + +{% data reusables.discussions.starting-a-poll %} + ## Marcar um comentário como uma resposta -Os autores de discussões e usuários com função de triagem ou superior para um repositório podem marcar um comentário como a resposta para uma discussão no repositório. +Os autores de discussões e usuários com função de triagem ou superior para um repositório podem marcar um comentário como a resposta para uma discussão no repositório. Similarly, discussion authors and users with the triage role or greater for the source repository for organization discussions can mark a comment as the answer to a discussion in the organization. {% data reusables.discussions.marking-a-comment-as-an-answer %} diff --git a/translations/pt-BR/content/discussions/guides/best-practices-for-community-conversations-on-github.md b/translations/pt-BR/content/discussions/guides/best-practices-for-community-conversations-on-github.md index 31bfdae5f4..230286ea73 100644 --- a/translations/pt-BR/content/discussions/guides/best-practices-for-community-conversations-on-github.md +++ b/translations/pt-BR/content/discussions/guides/best-practices-for-community-conversations-on-github.md @@ -10,11 +10,11 @@ versions: ## Conversas da comunidade em {% data variables.product.prodname_discussions %} -Como {% data variables.product.prodname_discussions %} é um fórum aberto, há a oportunidade de trazer uma colaboração que não é do código para o repositório de um projeto e coletar diversas sugestões e ideias mais rapidamente. Você pode ajudar a conduzir uma conversa produtiva: +Since {% data variables.product.prodname_discussions %} is an open forum, there is an opportunity to bring non-code collaboration into a project's repository or organization and gather diverse feedback and ideas more quickly. You can help drive a productive conversation in a number of ways. - Fazendo pontuais e perguntas complementares para obter feedback específico -- Capturando uma experiência diversificada e até os pontos principais -- Abra um problema para tomar ações com base na conversa, quando aplicável +- Capturing a diverse experience and distilling it down to main points +- Opening an issue to take action based on the conversation, where applicable Para mais informações sobre como abrir um problema e fazer referências cruzadas a uma discussão, consulte "[Abrir um problema a partir de um comentário](/github/managing-your-work-on-github/opening-an-issue-from-a-comment)". @@ -22,18 +22,19 @@ Para mais informações sobre como abrir um problema e fazer referências cruzad Você pode criar e participar de discussões, problemas e pull requests, dependendo do tipo de conversa que você gostaria de ter. -Você pode usar {% data variables.product.prodname_discussions %} para discutir o panorama geral, levantamento de hipóteses e desenvolver detalhes específicos de um projeto antes de vinculá-lo a um problema, que poderá ter o escopo definido. {% data variables.product.prodname_discussions %} é útil para equipes se: +You can use {% data variables.product.prodname_discussions %} to discuss big picture ideas, brainstorm, and develop a project's specific details before committing it to an issue, which can then be scoped. {% data variables.product.prodname_discussions %} é útil para equipes se: - Você está na fase de descoberta de um projeto e ainda está aprendendo qual direção a sua equipe quer acessar - Você deseja coletar comentários de uma comunidade mais ampla sobre um projeto - Você deseja manter correções de erros, solicitações de recursos e conversas gerais separadas +- You want to measure interest in new ideas and gauge community opinion using polls + +You might use repository discussions to discuss topics that are specific to the repository. If your project spans multiple repositories, you might use organization discussions to discuss topics that aren't specific to a single repository in your organization. Os problemas são úteis para discutir detalhes específicos de um projeto, como relatórios de erros e melhorias planejadas. Para obter mais informações, consulte "[Sobre problemas](/articles/about-issues)". As pull requests permitem comentar diretamente nas alterações propostas. Para obter mais informações, consulte "[Sobre pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" e "[Comentar em uma pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)". -{% data reusables.organizations.team-discussions-purpose %} Para obter mais informações, consulte "[Sobre discussões de equipe](/organizations/collaborating-with-your-team/about-team-discussions)." - ## Seguindo as diretrizes de contribuição -Antes de abrir uma discussão, verifique se o repositório tem diretrizes de contribuição. O arquivo CONTRIBUTING inclui informações sobre como o mantenedor do repositório gostaria que você contribuísse com ideias para o projeto. +Before you open a discussion in an open source repository, check to see if the repository has contributing guidelines. O arquivo CONTRIBUTING inclui informações sobre como o mantenedor do repositório gostaria que você contribuísse com ideias para o projeto. Para obter mais informações, consulte "[Configurando seu projeto para Contribuições Úteis](/communities/setting-up-your-project-for-healthy-contributions)." diff --git a/translations/pt-BR/content/discussions/guides/finding-discussions-across-multiple-repositories.md b/translations/pt-BR/content/discussions/guides/finding-your-discussions.md similarity index 81% rename from translations/pt-BR/content/discussions/guides/finding-discussions-across-multiple-repositories.md rename to translations/pt-BR/content/discussions/guides/finding-your-discussions.md index 0ecfa7eae7..8a82b8d6b6 100644 --- a/translations/pt-BR/content/discussions/guides/finding-discussions-across-multiple-repositories.md +++ b/translations/pt-BR/content/discussions/guides/finding-your-discussions.md @@ -1,10 +1,12 @@ --- -title: Encontrar discussões entre vários repositórios -intro: Você pode acessar facilmente todas as discussões que você criou ou participou de vários repositórios. +title: Finding your discussions +intro: You can easily access every discussion you've created or participated in. versions: fpt: '*' ghec: '*' shortTitle: Encontrar discussões +redirect_from: + - /discussions/guides/finding-discussions-across-multiple-repositories --- diff --git a/translations/pt-BR/content/discussions/guides/granting-higher-permissions-to-top-contributors.md b/translations/pt-BR/content/discussions/guides/granting-higher-permissions-to-top-contributors.md index ad87c674c2..c6ec32405b 100644 --- a/translations/pt-BR/content/discussions/guides/granting-higher-permissions-to-top-contributors.md +++ b/translations/pt-BR/content/discussions/guides/granting-higher-permissions-to-top-contributors.md @@ -14,13 +14,13 @@ Os contribuidores mais úteis dos últimos 30 dias são destacados no painel de ## Etapa 1: Audite os seus melhores contribuidores de {% data variables.product.prodname_discussions %} -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} -1. Compare a lista de contribuidores com suas permissões de acesso para ver quem se qualifica para moderar a discussão. +1. Compare the list of contributors with their access permissions to the repository or, for organization discussions, to the source repository to see who qualifies to moderate the discussion. ## Etapa 2: Reveja os níveis de permissão para {% data variables.product.prodname_discussions %} -Pessoas com permissões de triagem para um repositório podem ajudar a moderar as discussões de um projeto marcando comentários como respostas, bloqueando discussões que já não são úteis ou prejudicam a comunidade e convertendo os problemas em discussões quando uma ideia ainda está nos primeiros estágios de desenvolvimento. Para obter mais informações, consulte "[Moderação de discussões](/discussions/managing-discussions-for-your-community/moderating-discussions)". +People with triage permissions for a repository can help moderate a repository's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. Similarly, people with triage permissions for the source repository for organization discussions can moderate the organization's discussions. Para obter mais informações, consulte "[Moderação de discussões](/discussions/managing-discussions-for-your-community/moderating-discussions)". Para obter mais informações sobre os níveis de permissão do repositório e {% data variables.product.prodname_discussions %}, consulte "[Níveis de permissões do repositório para uma organização](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)". diff --git a/translations/pt-BR/content/discussions/guides/index.md b/translations/pt-BR/content/discussions/guides/index.md index 66b5a237bb..0c59ac1769 100644 --- a/translations/pt-BR/content/discussions/guides/index.md +++ b/translations/pt-BR/content/discussions/guides/index.md @@ -7,7 +7,7 @@ versions: ghec: '*' children: - /best-practices-for-community-conversations-on-github - - /finding-discussions-across-multiple-repositories + - /finding-your-discussions - /granting-higher-permissions-to-top-contributors --- diff --git a/translations/pt-BR/content/discussions/index.md b/translations/pt-BR/content/discussions/index.md index e728efc4a8..b02fb5c9a8 100644 --- a/translations/pt-BR/content/discussions/index.md +++ b/translations/pt-BR/content/discussions/index.md @@ -18,9 +18,9 @@ featuredLinks: popular: - /discussions/guides/granting-higher-permissions-to-top-contributors - /discussions/guides/best-practices-for-community-conversations-on-github - - /discussions/guides/finding-discussions-across-multiple-repositories + - /discussions/guides/finding-your-discussions - /discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions - - /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository + - /discussions/managing-discussions-for-your-community/managing-categories-for-discussions changelog: label: discussions examples_source: data/product-examples/discussions/community-examples.yml diff --git a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/index.md b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/index.md index 875bb0785f..a15a90cd2b 100644 --- a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/index.md +++ b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/index.md @@ -6,8 +6,8 @@ versions: fpt: '*' ghec: '*' children: - - /managing-discussions-in-your-repository - - /managing-categories-for-discussions-in-your-repository + - /managing-discussions + - /managing-categories-for-discussions - /moderating-discussions - /viewing-insights-for-your-discussions --- diff --git a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md similarity index 80% rename from translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md rename to translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md index 49b97e3948..2003113392 100644 --- a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md +++ b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions.md @@ -1,11 +1,13 @@ --- -title: Gerenciar categorias para discussões no seu repositório -intro: Você pode categorizar as discussões no seu repositório para organizar conversas para integrantes da sua comunidade e você pode escolher um formato para cada categoria. -permissions: Repository administrators and people with write or greater access to a repository can manage categories for discussions in the repository. +title: Managing categories for discussions +intro: 'You can categorize discussions to organize conversations for your community members, and you can choose a format for each category.' +permissions: Repository administrators and people with write or greater access to a repository can manage categories for discussions in the repository. Repository administrators and people with write or greater access to the source repository for organization discussions can manage categories for discussions in the organization. versions: fpt: '*' ghec: '*' shortTitle: Gerenciar categorias +redirect_from: + - /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository --- @@ -24,12 +26,13 @@ Cada categoria deve ter um nome e um pareamento de emojis únicos e pode ser aco | 📣 Anúncios | Atualizações e notícias de mantenedores do projeto | Anúncio | | #️⃣ Geral | Tudo que for relevante para o projeto | Discussão aberta | | 💡 Ideias | Ideias para alterar ou melhorar o projeto | Discussão aberta | +| 🗳 Polls | Polls with multiple options for the community to vote for and discuss | Polls | | 🙏 Q&A | Perguntas para a comunidade responder, com um formato de pergunta/resposta | Pergunta e resposta | | 🙌 Mostrar e contar | Criações, experimentos ou testes relevantes para o projeto | Discussão aberta | ## Criar categoria -{% data reusables.repositories.navigate-to-repo %} +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to create a category. {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.edit-categories %} 1. Clique em **Nova Categoria**. ![Botão "Nova categoria" acima da lista de categorias de discussão para um repositório](/assets/images/help/discussions/click-new-category-button.png) @@ -40,7 +43,7 @@ Cada categoria deve ter um nome e um pareamento de emojis únicos e pode ser aco Você pode editar uma categoria para alterar o emoji, título, descrição e formato da discussão. -{% data reusables.repositories.navigate-to-repo %} +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to create a category. {% data reusables.discussions.discussions-tab %} 1. À direita de uma categoria na lista, clique em {% octicon "pencil" aria-label="The pencil icon" %}. ![Botão de editar à direita da categoria na lista de categorias para um repositório](/assets/images/help/discussions/click-edit-for-category.png) 1. {% data reusables.discussions.edit-category-details %}![Editar emoji, título, descrição e formato de discussão para uma categoria existente](/assets/images/help/discussions/edit-existing-category-details.png) @@ -50,7 +53,7 @@ Você pode editar uma categoria para alterar o emoji, título, descrição e for Ao você excluir uma categoria, {% data variables.product.product_name %} moverá todas as discussões da categoria excluída para uma categoria existente que você escolher. -{% data reusables.repositories.navigate-to-repo %} +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to create a category. {% data reusables.discussions.discussions-tab %} 1. À direita de uma categoria na lista, clique em {% octicon "trash" aria-label="The trash icon" %}. ![Botão de lixeira à direita da categoria na lista de categorias para um repositório](/assets/images/help/discussions/click-delete-for-category.png) 1. Use o menu suspenso e escolha uma nova categoria para qualquer discussão na categoria que você está excluindo. ![Menu suspenso para escolher nova categoria ao excluir uma categoria existente](/assets/images/help/discussions/choose-new-category.png) diff --git a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-discussions.md similarity index 69% rename from translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md rename to translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-discussions.md index 7f68f8e697..539fca9ff7 100644 --- a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md +++ b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/managing-discussions.md @@ -1,11 +1,13 @@ --- -title: Gerenciar discussões no seu repositório -intro: 'Você pode categorizar, destacar e transferir ou excluir as discussões de um repositório.' -permissions: Repository administrators and people with write or greater access to a repository can manage discussions in the repository. +title: Gerenciando discussões +intro: 'You can categorize, spotlight, transfer, or delete the discussions.' +permissions: Repository administrators and people with write or greater access to a repository can manage discussions in the repository. Repository administrators and people with write or greater access to the source repository for organization discussions can manage discussions in the organization. versions: fpt: '*' ghec: '*' shortTitle: Gerenciar discussões +redirect_from: + - /discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository --- @@ -13,7 +15,7 @@ shortTitle: Gerenciar discussões {% data reusables.discussions.about-discussions %} Para obter mais informações sobre discussões, consulte[Sobre discussões](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". -Os proprietários da organização podem escolher as permissões necessárias para criar uma discussão para repositórios pertencentes à organização. Para obter mais informações, consulte "[Gerenciar a criação de discussões para repositórios na sua organização](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)". +Organization owners can choose the permissions required to create a discussion in repositories owned by the organization. Similarly, to choose the permissions required to create an organization discussion, organization owners can change the permissions required in the source repository. Para obter mais informações, consulte "[Gerenciar a criação de discussões para repositórios na sua organização](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)". Como mantenedor de discussões, você pode criar recursos da comunidade para incentivar discussões alinhadas com o objetivo geral do projeto e manter um fórum aberto amigável para os colaboradores. Criar um código de conduta ou diretrizes de contribuição para os colaboradores a seguir ajudará a facilitar um fórum colaborativo e produtivo. Para obter mais informações sobre como criar recursos da comunidade, consulte "[Adicionar um código de conduta ao seu projeto](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" e "[Diretrizes de configuração para contribuidores do repositório](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)". @@ -27,11 +29,13 @@ Para obter mais informações sobre como facilitar uma discussão saudável, con Para gerenciar as discussões em um repositório, {% data variables.product.prodname_discussions %} deve estar habilitado para o repositório. Para obter mais informações, consulte "[Habilitando ou desabilitando {% data variables.product.prodname_discussions %} para um repositório](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository)". +To manage discussions in an organization, {% data variables.product.prodname_discussions %} must be enabled for the organization. For more information, see "[Enabling or disabling {% data variables.product.prodname_discussions %} for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." + ## Alterar a categoria para uma discussão -Você pode categorizar discussões para ajudar os integrantes da comunidade a encontrar discussões relacionadas. Para obter mais informações, consulte "[Gerenciar categorias para discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)". +Você pode categorizar discussões para ajudar os integrantes da comunidade a encontrar discussões relacionadas. For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)." -Você também pode mover a discussão para uma categoria diferente. +Você também pode mover a discussão para uma categoria diferente. It's not possible to move a discussion to or from the polls category. {% data reusables.repositories.navigate-to-repo %} {% data reusables.discussions.discussions-tab %} @@ -41,9 +45,9 @@ Você também pode mover a discussão para uma categoria diferente. ## Fixar uma discussão -Você pode fixar até quatro discussões importantes acima da lista de discussões para o repositório. +You can pin up to four important discussions above the list of discussions for the repository or organization. -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. Na barra lateral direita, clique em {% octicon "pin" aria-label="The pin icon" %} **Fixar discussão**. !["Fixar discussão" na barra lateral direita para discussão](/assets/images/help/discussions/click-pin-discussion.png) @@ -52,9 +56,9 @@ Você pode fixar até quatro discussões importantes acima da lista de discussõ ## Editar uma discussão fixada -Editar uma discussão fixada não irá alterar a categoria da discussão. Para obter mais informações, consulte "[Gerenciar categorias para discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)". +Editar uma discussão fixada não irá alterar a categoria da discussão. For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)." -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. Na barra lateral direita, clique em {% octicon "pencil" aria-label="The pencil icon" %} **Editar discussão fixada**. !["Editar discussão fixada" na barra lateral direita para discussão](/assets/images/help/discussions/click-edit-pinned-discussion.png) @@ -63,7 +67,7 @@ Editar uma discussão fixada não irá alterar a categoria da discussão. Para o ## Desafixar uma discussão -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. Na barra lateral direita, clique em {% octicon "pin" aria-label="The pin icon" %} **Desafixar discussão**. !["Desafixar discussão" na barra lateral direita para discussão](/assets/images/help/discussions/click-unpin-discussion.png) @@ -71,18 +75,18 @@ Editar uma discussão fixada não irá alterar a categoria da discussão. Para o ## Transferir uma discussão -Para transferir uma discussão, você precisa ter permissão de criar discussões no repositório, em que você deseja transferir a discussão. Você somente pode transferir discussões entre repositórios pertencentes à mesma conta de usuário ou organização. Você não pode transferir uma discussão de um repositório privado para um repositório público. +Para transferir uma discussão, você precisa ter permissão de criar discussões no repositório, em que você deseja transferir a discussão. If you want to transfer a discussion to an organization, you must have permissions to create discussions in the source repository for the organization's discussions. Você somente pode transferir discussões entre repositórios pertencentes à mesma conta de usuário ou organização. Você não pode transferir uma discussão de um repositório privado para um repositório público. -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. Na barra lateral direita, clique em {% octicon "arrow-right" aria-label="The right arrow icon" %} **Transferir discussão**. !["Transferir discussão" na barra lateral direita para discussão](/assets/images/help/discussions/click-transfer-discussion.png) -1. Selecione a lista suspensa **Escolher um repositório** e clique no repositório para o qual deseja transferir a discussão. ![Menu suspenso "Selecionar um repositório" Campo de pesquisar "Encontrar um repositório" e repositório na lista](/assets/images/help/discussions/use-choose-a-repository-drop-down.png) +1. Selecione a lista suspensa **Escolher um repositório** e clique no repositório para o qual deseja transferir a discussão. If you want to transfer a discussion to an organization, choose the source repository for the organization's discussions. ![Menu suspenso "Selecionar um repositório" Campo de pesquisar "Encontrar um repositório" e repositório na lista](/assets/images/help/discussions/use-choose-a-repository-drop-down.png) 1. Clique em **Transferir discussão**. ![Botão "Transferir discussão"](/assets/images/help/discussions/click-transfer-discussion-button.png) ## Excluir uma discussão -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. Na barra lateral direita, clique em {% octicon "trash" aria-label="The trash arrow icon" %} **Excluir discussão**. !["Excluir discussão" na barra lateral direita para discussão](/assets/images/help/discussions/click-delete-discussion.png) @@ -92,7 +96,7 @@ Para transferir uma discussão, você precisa ter permissão de criar discussõe Você pode converter todos as etiquetas com a mesma etiqueta para discussões em massa. Os problemas futuros com essa etiqueta também serão automaticamente convertidos em discussão e categoria que você configurar. -{% data reusables.repositories.navigate-to-repo %} +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or, for organization discussions, the source repository. {% data reusables.repositories.sidebar-issues %} {% data reusables.project-management.labels %} 1. Ao lado da etiqueta que você deseja converter em problemas, clique em **Converter problemas**. diff --git a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/moderating-discussions.md b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/moderating-discussions.md index aed4f26a35..eb3c5b02d2 100644 --- a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/moderating-discussions.md +++ b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/moderating-discussions.md @@ -1,7 +1,7 @@ --- title: Moderar discussões intro: 'Você pode promover uma colaboração saudável marcando comentários como respostas, bloqueando ou desbloqueando discussões, convertendo problemas para discussões, bem como e editar ou excluir comentários, discussões e categorias que não estão alinhadas com o código de conduta da sua comunidade.' -permissions: People with triage access to a repository can moderate discussions in the repository. +permissions: People with triage access to a repository can moderate discussions in the repository. People with triage access to the source repository for organization discussions can moderate discussions in the organization. versions: fpt: '*' ghec: '*' @@ -10,7 +10,7 @@ versions: ## Sobre a moderação de discussões -{% data reusables.discussions.about-discussions %} Se você tiver permissões de triagem para um repositório, você poderá ajudar a moderar as discussões de um projeto marcando comentários como respostas, bloqueando discussões que não são mais úteis ou que prejudicam a comunidade e convertendo os problemas em discussões quando uma ideia ainda está nos primeiros estágios de desenvolvimento. +{% data reusables.discussions.about-discussions %} If you have triage permissions for a repository, you can help moderate a repository's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. Similarly, if you have triage permission for the source repository for organization discussions, you can moderate discussions for that organization. ## Marcar um comentário como uma resposta @@ -18,9 +18,9 @@ versions: ## Bloquear discussões -É apropriado bloquear uma conversa quando toda a conversa não é construtiva ou quando viola o código de conduta da sua comunidade ou as [Diretrizes da Comunidade](/free-pro-team@latest/github/site-policy/github-community-guidelines) de {% data variables.product.prodname_dotcom %}. Você também pode bloquear uma conversa para evitar comentários em uma discussão que você deseja usar como um anúncio para a comunidade. Ao bloquear uma conversa, as pessoas com acesso de gravação ao repositório ainda poderão comentar na discussão. +É apropriado bloquear uma conversa quando toda a conversa não é construtiva ou quando viola o código de conduta da sua comunidade ou as [Diretrizes da Comunidade](/free-pro-team@latest/github/site-policy/github-community-guidelines) de {% data variables.product.prodname_dotcom %}. Você também pode bloquear uma conversa para evitar comentários em uma discussão que você deseja usar como um anúncio para a comunidade. When you lock a conversation, people with write access to the repository, or source repository for organization discussions, will still be able to comment on the discussion. -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} 1. Na lista de discussões, clique na discussão que você deseja bloquear. ![Bloquear discussão](/assets/images/help/discussions/unanswered-discussion.png) 1. Na margem direita de uma discussão, clique em **Bloquear conversa**. @@ -29,9 +29,9 @@ versions: ## Converter um problema em uma discussão -Ao converter um problema em uma discussão, a discussão será criada automaticamente usando o conteúdo do problema. As pessoas com acesso de gravação a um repositório podem fazer a conversão de problemas em massa com base em etquetas. Para obter mais informações, consulte "[Gerenciar discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)". +Ao converter um problema em uma discussão, a discussão será criada automaticamente usando o conteúdo do problema. People with write access to a repository, or source repository for organization discussions, can bulk convert issues based on labels. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions)." -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.repositories.sidebar-issues %} 1. Na lista de problemas, clique no problema que deseja converter. 1. Na margem direita de um problema, clique em **Converter em discussão**. diff --git a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md index 6b8bbf0b33..ebec90b9b2 100644 --- a/translations/pt-BR/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md +++ b/translations/pt-BR/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md @@ -1,7 +1,7 @@ --- title: Visualizando insights para suas discussões intro: 'As informações das discussões fornecem dados sobre a atividade das suas discussões, visualizações e contribuidores.' -permissions: Repository administrators and people with maintain access to a repository can view the discussions insights dashboard. +permissions: Repository administrators and people with maintain access to a repository can view the insights dashboard for discussions in that repository. Repository administrators and people with maintain access to the source repository for organization discussions can view the insights dashboard for discussions in that organization. versions: fpt: '*' ghec: '*' @@ -12,7 +12,7 @@ shortTitle: Ver insights de discussões ## Sobre o painel de insights das discussões -Você pode usar insights de discussões para ajudar a entender a atividade de contribuição, exibições de página e o crescimento da comunidade de discussões do repositório. +You can use discussions insights to help understand the contribution activity, page views, and growth of your discussions community. - **Atividade de contribuição** mostra a contagem total de contribuições para discussões, problemas e pull requests. - **Visualizações de páginas de discussões** mostra o total de visualizações de páginas para discussões, segmentadas por usuários conectados em comparação com usuários anônimos. - **Contribuidores diários de discussões** mostram a contagem diária de usuários únicos que reagiram, votaram, marcaram uma resposta, comentaram ou postaram no período de tempo selecionado. @@ -28,7 +28,7 @@ Você pode usar insights de discussões para ajudar a entender a atividade de co ## Visualizando insights de discussões -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.navigate-to-repo %} For organization discussions, navigate to the main page of the source repository. {% data reusables.repositories.accessing-repository-graphs %} 3. Na barra lateral esquerda, clique em **Community** (Comunidade). ![Captura de tela da aba "Comunidade" na barra lateral esquerda](/assets/images/help/graphs/graphs-sidebar-community-tab.png) 1. Opcionalmente, no canto superior direito da página, selecione o menu suspenso **Período** e clique no período de tempo para o qual você deseja ver dados: **30 dias**, **3 meses** ou **1 ano**. ![Captura de tela do seletor de intervalo de datas para insights de discussões](/assets/images/help/discussions/discussions-dashboard-date-selctor.png) diff --git a/translations/pt-BR/content/discussions/quickstart.md b/translations/pt-BR/content/discussions/quickstart.md index 2aabd68f2b..0387d0dd2c 100644 --- a/translations/pt-BR/content/discussions/quickstart.md +++ b/translations/pt-BR/content/discussions/quickstart.md @@ -1,6 +1,6 @@ --- title: Início Rápido para Discussões do GitHub -intro: 'Habilite {% data variables.product.prodname_discussions %} em um repositório existente e inicie conversas com sua comunidade.' +intro: 'Enable {% data variables.product.prodname_discussions %} on an existing repository or organization and start conversations with your community.' allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -27,34 +27,50 @@ Ao habilitar {% data variables.product.prodname_discussions %} pela primeira vez 1. Em "Iniciar uma nova discussão", edite o modelo para que fique alinhado aos recursos e tom que você deseja definir para sua comunidade. 1. Clique em **Iniciar discussão**. ![Botão "Iniciar discussão"](/assets/images/help/discussions/new-discussion-start-discussion-button.png) +## Enabling {% data variables.product.prodname_discussions %} on your organization + +Organization owners can enable {% data variables.product.prodname_discussions %} for their organization. + +{% data reusables.discussions.about-organization-discussions %} + +{% data reusables.discussions.enabling-or-disabling-github-discussions-for-your-organization %} + ## Dar as boas-vindas às contribuições para as suas discussões -Você pode dar as boas-vindas à sua comunidade e apresentar uma nova forma de se comunicar em um repositório, criando um post de boas-vindas e fixando o post na sua página de {% data variables.product.prodname_discussions %}. Fixar e bloquear discussões ajuda as pessoas a saber que uma publicação é feita como um anúncio. Você pode usar os anúncios como uma forma de vincular pessoas a mais recursos e oferecer orientação para abrir discussões na sua comunidade. Para obter mais informações sobre como fixar uma discussão, consulte "[Gerenciar discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#pinning-a-discussion)". +You can welcome your community and introduce a new way to communicate in a repository or organization by creating a welcome post and pinning the post to your {% data variables.product.prodname_discussions %} page. Fixar e bloquear discussões ajuda as pessoas a saber que uma publicação é feita como um anúncio. Você pode usar os anúncios como uma forma de vincular pessoas a mais recursos e oferecer orientação para abrir discussões na sua comunidade. For more information about pinning a discussion, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#pinning-a-discussion)." ## Configurar diretrizes da comunidade para colaboradores -Você pode definir diretrizes de contribuição para incentivar os colaboradores a terem conversas significativas e úteis que sejam relevantes para o repositório. Você também pode atualizar o README do repositório para comunicar as expectativas quando os colaboradores devem abrir um problema ou discussão. +For repository discussions, you can set contributing guidelines to encourage collaborators to have meaningful, useful conversations that are relevant to the repository. Você também pode atualizar o README do repositório para comunicar as expectativas quando os colaboradores devem abrir um problema ou discussão. Para obter mais informações sobre como fornecer diretrizes para o seu projeto, consulte "[Adicionar um código de conduta ao seu projeto](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" e "[Configurar seu projeto para contribuições saudáveis](/communities/setting-up-your-project-for-healthy-contributions)". -Para obter mais informações sobre como fornecer diretrizes para o seu projeto, consulte "[Adicionar um código de conduta ao seu projeto](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" e "[Configurar seu projeto para contribuições saudáveis](/communities/setting-up-your-project-for-healthy-contributions)". +For organization discussions, you share information about how to engage with your organization by creating an organization profile README. Para obter mais informações, consulte "[Personalizar o perfil da sua organização](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)". ## Criar uma nova discussão -Qualquer usuário autenticado que possa visualizar um repositório pode criar uma discussão. +Any authenticated user who can view the repository can create a discussion in that repository. Similarly, since organization discussions are based on a source repository, any authenticated user who can view the source repository can create a discussion in that organization. {% data reusables.discussions.starting-a-discussion %} +## Creating a new poll + +Any authenticated user who can view a repository can create a poll. Similarly, since organization discussions are based on a source repository, any authenticated user who can view the source repository can create a poll in that organization. + +{% data reusables.discussions.starting-a-poll %} + ## Organizando discussões -Os proprietários dos repositórios e pessoas com acesso de gravação podem criar novas categorias para manter as discussões organizadas. Os colaboradores que participam e criam novas discussões podem agrupar discussões nas categorias existentes mais relevantes. As discussões também podem ser recategorizadas depois que forem criadas. Para obter mais informações, consulte "[Gerenciar categorias para discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)". +Repository owners and people with write access to the repository can create new categories to keep discussions organized. Similarly, since organization discussions are based on a source repository, repository owners and people with write access to the source repository can create new categories for organization discussions. + +Os colaboradores que participam e criam novas discussões podem agrupar discussões nas categorias existentes mais relevantes. As discussões também podem ser recategorizadas depois que forem criadas. For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)." {% data reusables.discussions.you-can-label-discussions %} ## Promover conversas saudáveis -As pessoas com permissões de gravação em um repositório podem ajudar a supervisionar conversas importantes fixando discussões, excluindo discussões que não são mais úteis ou que são prejudiciais para a comunidade e transferindo discussões para repositórios mais relevantes pertencentes à organização. Para obter mais informações, consulte "[Gerenciar discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository)". +People with write permissions for the repository, or for the source repository for organization discussions, can help surface important conversations by pinning discussions, deleting discussions that are no longer useful or are damaging to the community, and transferring discussions to more relevant repositories owned by the organization. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions)." -Pessoas com permissões de triagem para um repositório podem ajudar a moderar as discussões de um projeto marcando comentários como respostas, bloqueando discussões que já não são úteis ou prejudicam a comunidade e convertendo os problemas em discussões quando uma ideia ainda está nos primeiros estágios de desenvolvimento. Para obter mais informações, consulte "[Moderação de discussões](/discussions/managing-discussions-for-your-community/moderating-discussions)". +People with triage permissions for the repository, or for the source repository for organization discussions, can help moderate a project's discussions by marking comments as answers, locking discussions that are no longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. Para obter mais informações, consulte "[Moderação de discussões](/discussions/managing-discussions-for-your-community/moderating-discussions)". ## Próximas etapas diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 697a5abb93..0d61da8330 100644 --- a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -23,6 +23,8 @@ Você pode decidir quantas equipes uma atividade pode ter e quantos integrantes Para uma demonstração de vídeo da criação de uma atividade de grupo, consulte "[Fundamentos de configuração de {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom)". +{% data reusables.classroom.reuse-assignment-link %} + ## Pré-requisitos {% data reusables.classroom.assignments-classroom-prerequisite %} diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md index cfdadc34b9..fd4a4c9dca 100644 --- a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md @@ -14,6 +14,8 @@ Você pode utilizar um repositório de modelo em {% data variables.product.produ Para usar o repositório de modelo para a sua atribuição, o repositório de modelo deve pertencer à sua organização, ou a visibilidade do repositório de modelos deverá ser pública. +You can reuse an existing assignment, even if it uses a template repository, in any other classroom that you have admin access to, including classrooms in a different organization. For more information, see "[Reuse an assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." + ## Leia mais - "[Criar uma atividade individual](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md index f8330cda78..18354c1565 100644 --- a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md @@ -20,6 +20,8 @@ shortTitle: Atividade individual Para uma demonstração vídeo da criação de uma atividade individual, consulte "[Fundamentos da configuração de {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom)". +{% data reusables.classroom.reuse-assignment-link %} + ## Pré-requisitos {% data reusables.classroom.assignments-classroom-prerequisite %} diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md index 7231f0e706..c59828e8c5 100644 --- a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md @@ -11,6 +11,7 @@ children: - /use-the-git-and-github-starter-assignment - /create-an-individual-assignment - /create-a-group-assignment + - /reuse-an-assignment - /create-an-assignment-from-a-template-repository - /leave-feedback-with-pull-requests - /use-autograding diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md index e63834167b..01b81b4b33 100644 --- a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md @@ -25,6 +25,8 @@ Convide TAs e administradores para a sua sala de aula, convidando as contas de u Ao terminar de usar uma sala de aula, você pode arquivar a sala de aula e consultar a sala de aula, lista, e recomendações posteriormente, ou você pode excluir a sala de aula se não precisar mais dela. +{% data reusables.classroom.reuse-assignment-link %} + ## Sobre as listas de salas de aula Cada sala de aula tem uma lista. Uma lista é uma lista de identificadores para os alunos que participam do seu curso. @@ -45,7 +47,7 @@ Você deve autorizar o aplicativo OAuth {% data variables.product.prodname_class 1. Clique em **Nova sala de aula**. ![Botão "Nova sala de aula"](/assets/images/help/classroom/click-new-classroom-button.png) {% data reusables.classroom.guide-create-new-classroom %} -Depois de criar uma sala de aula, você pode começar a criar atividades para os alunos. Para obter mais informações, consulte "[Use a atividade inicial do Git e {% data variables.product.company_short %}](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment), "[Crie uma tarefa individual](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" ou "[Crie uma atividade em grupo](/education/manage-coursework-with-github-classroom/create-a-group-assignment)." +Depois de criar uma sala de aula, você pode começar a criar atividades para os alunos. For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)," "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)," or "[Reuse an assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." ## Criando uma lista para sua sala de aula diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md new file mode 100644 index 0000000000..6bee27aae4 --- /dev/null +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md @@ -0,0 +1,38 @@ +--- +title: Reuse an assignment +intro: 'You can reuse an existing assignment in more than one classroom, including classrooms in a different organization.' +versions: + fpt: '*' +permissions: 'Organization owners who are admins for a classroom can reuse assignments from a classroom. {% data reusables.classroom.classroom-admins-link %}' +shortTitle: Reuse an assignment +--- + +## About reusing assignments + +You can reuse an existing individual or group assignment in any other classroom you have access to, including classrooms in a different organization. If you choose to reuse an assignment, {% data variables.product.prodname_classroom %} will copy the assignment to the classroom you choose. If the assignment uses a template repository and you choose to reuse it in a classroom from a different organization, {% data variables.product.prodname_classroom %} will create a copy of the repository and its contents in the target organization. + +The copied assignment includes assignment details such as the name, source repository, autograding test, and preferred editor. You can edit the assignment after it has been copied to make changes. You cannot make changes to the preferred editor. + +## Reusing an assignment + +1. Efetue o login em {% data variables.product.prodname_classroom_with_url %}. +1. Navigate to the classroom that has the assignment that you want to reuse. + + ![Sala de aula na lista de salas de aula de uma organização](/assets/images/help/classroom/click-classroom-in-list.png) + +1. In the list of assignments, click the assignment you want to reuse. + + ![Atividade na lista de atividades para uma sala de aula](/assets/images/help/classroom/click-assignment-in-list.png) + +1. Select the **{% octicon "pencil" aria-label="The pencil icon" %} Edit** dropdown menu in the top right of the page, then click **{% octicon "sync" aria-label="The sync icon" %} Reuse assignment**. + + ![Reuse assignment button](/assets/images/help/classroom/reuse-assignment-button.png) + +1. In "Reuse assignment" modal, use the **Choose an organization** dropdown menu to select the organization you want the assignment to be in. Then use the **Choose a classroom** dropdown menu to select the classroom within that organization that you want to copy the assignment to. + + ![Reuse assignment modal](/assets/images/help/classroom/reuse-assignment-modal.png) + +1. Click **Create assignment**. +1. The assignment is copied to the selected classroom, and a confirmation message is shown. If you chose to reuse an assignment with a template repository, the copying process may take a few minutes to complete, and you may need to refresh the page to see the completed message. + + ![Completed message for reused assignment](/assets/images/help/classroom/reuse-assignment-completed-message.png) diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md index 2b4122696d..ff39edad9e 100644 --- a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md @@ -96,7 +96,7 @@ A atividade inicial do Git & {% data variables.product.company_short %} só est ## Próximas etapas -- Faça recomendações adicionais personalizadas para seu curso. Para obter mais informações, consulte "[Criar uma atividade individual](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" e "[Criar uma atividade em grupo](/education/manage-coursework-with-github-classroom/create-a-group-assignment)". +- Faça recomendações adicionais personalizadas para seu curso. For more information, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)," and "[Reuse an assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." ## Leia mais diff --git a/translations/pt-BR/content/get-started/learning-about-github/githubs-products.md b/translations/pt-BR/content/get-started/learning-about-github/githubs-products.md index 6956f597ca..7d6853e74e 100644 --- a/translations/pt-BR/content/get-started/learning-about-github/githubs-products.md +++ b/translations/pt-BR/content/get-started/learning-about-github/githubs-products.md @@ -1,5 +1,5 @@ --- -title: Produtos do GitHub +title: GitHub’s products intro: 'Uma visão geral dos produtos e planos de preços de {% data variables.product.prodname_dotcom %}.' redirect_from: - /articles/github-s-products diff --git a/translations/pt-BR/content/get-started/quickstart/fork-a-repo.md b/translations/pt-BR/content/get-started/quickstart/fork-a-repo.md index cc0db8e7c6..fb2952f2cd 100644 --- a/translations/pt-BR/content/get-started/quickstart/fork-a-repo.md +++ b/translations/pt-BR/content/get-started/quickstart/fork-a-repo.md @@ -152,7 +152,7 @@ Ao bifurcar um projeto para propor mudanças no repositório original, é possí > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) ``` -6. Digite `git remote add upstream`, cole a URL que você copiou na etapa 2 e pressione **Enter**. Ficará assim: +6. Type `git remote add upstream`, and then paste the URL you copied in Step 3 and press **Enter**. Ficará assim: ```shell $ git remote add upstream https://{% data variables.command_line.codeblock %}/octocat/Spoon-Knife.git ``` diff --git a/translations/pt-BR/content/get-started/using-github/github-command-palette.md b/translations/pt-BR/content/get-started/using-github/github-command-palette.md index 47aab4fb34..16eae7c329 100644 --- a/translations/pt-BR/content/get-started/using-github/github-command-palette.md +++ b/translations/pt-BR/content/get-started/using-github/github-command-palette.md @@ -192,10 +192,10 @@ Estes comandos só estão disponíveis quando você abre a paleta de comandos em | Comando | Comportamento | |:------------------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Excluir discussão...` | Excluir permanentemente a discussão. Para obter mais informações, consulte "[Gerenciar discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion)". | +| `Excluir discussão...` | Excluir permanentemente a discussão. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#deleting-a-discussion)." | | `Editar texto da discussão` | Abra o texto principal da discussão que está pronto para edição. | | `Assinar`/`Cancelar assinatura` | Opte por participar ou não receber notificações de adições à discussão. Para obter mais informações, consulte "[Sobre notificações](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)". | -| `Transferir discussão...` | Mover a discussão para um repositório diferente. Para obter mais informações, consulte "[Gerenciar discussões no seu repositório](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#transferring-a-discussion)". | +| `Transferir discussão...` | Mover a discussão para um repositório diferente. For more information, see "[Managing discussions](/discussions/managing-discussions-for-your-community/managing-discussions#transferring-a-discussion)." | ### Comandos de problemas diff --git a/translations/pt-BR/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md b/translations/pt-BR/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md index 57693d2503..40fad1709a 100644 --- a/translations/pt-BR/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md +++ b/translations/pt-BR/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md @@ -50,7 +50,7 @@ Look! Você pode ver minhas aspas. ## Realce de sintaxe - + Você pode adicionar um identificador de linguagem opcional para habilitar o realce de sintaxe no bloco de código isolado. diff --git a/translations/pt-BR/content/organizations/collaborating-with-your-team/about-team-discussions.md b/translations/pt-BR/content/organizations/collaborating-with-your-team/about-team-discussions.md index 61e38790d7..74675c3947 100644 --- a/translations/pt-BR/content/organizations/collaborating-with-your-team/about-team-discussions.md +++ b/translations/pt-BR/content/organizations/collaborating-with-your-team/about-team-discussions.md @@ -42,6 +42,14 @@ Para desativar notificações de discussões de equipe, você pode cancelar a as Para obter mais informações, consulte {% ifversion fpt or ghae or ghes or ghec %}"[Visualizando suas assinaturas](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Cadastrar-se e descadastrar-se para receber notificações](/github/receiving-notifications-about-activity-on-github/subscribing-to-and-unsubscribing-from-notifications){% endif %}" e "[Equipes aninhadas](/articles/about-teams/#nested-teams)." +{% ifversion fpt or ghec %} + +## Organization discussions + +You can also use organization discussions to facilitate conversations across your organization. For more information, see "[Enabling or disabling GitHub Discussions for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." + +{% endif %} + ## Leia mais - "[Início rápido para comunicação em {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/quickstart-for-communicating-on-github)" diff --git a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md index 32d109f44c..9331785e85 100644 --- a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md +++ b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md @@ -142,15 +142,15 @@ Algumas das funcionalidades listadas abaixo estão limitadas a organizações qu {% endif %} | Crie referências autolink para recursos externos, como Jira ou Zendesk (consulte "[Configurando links automáticos para fazer referência a recursos externos](/articles/configuring-autolinks-to-reference-external-resources)") | | | | | **X** |{% ifversion fpt or ghec %} | [Habilitar {% data variables.product.prodname_discussions %}](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository) em um repositório | | | | **X** | **X** | -| [Criar e editar categorias](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository) para {% data variables.product.prodname_discussions %} | | | | **X** | **X** | -| [Mover uma discussão para uma categoria diferente](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) | | | **X** | **X** | **X** | -| [Transferir uma discussão](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) para um novo repositório | | | **X** | **X** | **X** | -| [Gerenciar discussões fixadas](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) | | | **X** | **X** | **X** | -| [Converter problemas para discussões em massa](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository) | | | **X** | **X** | **X** | +| [Criar e editar categorias](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions) para {% data variables.product.prodname_discussions %} | | | | **X** | **X** | +| [Mover uma discussão para uma categoria diferente](/discussions/managing-discussions-for-your-community/managing-discussions) | | | **X** | **X** | **X** | +| [Transferir uma discussão](/discussions/managing-discussions-for-your-community/managing-discussions) para um novo repositório | | | **X** | **X** | **X** | +| [Gerenciar discussões fixadas](/discussions/managing-discussions-for-your-community/managing-discussions) | | | **X** | **X** | **X** | +| [Converter problemas para discussões em massa](/discussions/managing-discussions-for-your-community/managing-discussions) | | | **X** | **X** | **X** | | [Bloquear e desbloquear discussões](/discussions/managing-discussions-for-your-community/moderating-discussions) | | **X** | **X** | **X** | **X** | | [Converter individualmente problemas em discussões](/discussions/managing-discussions-for-your-community/moderating-discussions) | | **X** | **X** | **X** | **X** | | [Criar novas discussões e comentar em discussões existentes](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion) | **X** | **X** | **X** | **X** | **X** | -| [Excluir uma discussão](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion) | | **X** | | **X** | **X** |{% endif %}{% ifversion fpt or ghec %} +| [Excluir uma discussão](/discussions/managing-discussions-for-your-community/managing-discussions#deleting-a-discussion) | | **X** | | **X** | **X** |{% endif %}{% ifversion fpt or ghec %} | Crie [codespaces](/codespaces/about-codespaces) | | | **X** | **X** | **X** {% endif %} diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md new file mode 100644 index 0000000000..e93b972e45 --- /dev/null +++ b/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -0,0 +1,27 @@ +--- +title: Enabling or disabling GitHub Discussions for an organization +intro: 'You can use {% data variables.product.prodname_discussions %} in a organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' +permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' +versions: + fpt: '*' + ghec: '*' +topics: + - Organizations +shortTitle: Organization discussions +--- + +## About organization discussions + +{% data reusables.discussions.about-organization-discussions %} + +You can also manage repository discussions. For more information, see "[Enabling or disabling GitHub Discussions for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository)" and "[Managing discussion creation for repositories in your organization](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)." + +## Enabling or disabling {% data variables.product.prodname_discussions %} for your organization + +{% data reusables.discussions.enabling-or-disabling-github-discussions-for-your-organization %} +1. To disable discussions, under "Discussions", unselect **Enable discussions for this organization**. + +## Leia mais + +- "[Sobre discussões](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" +- "[Gerenciar discussões para a sua comunidade](/discussions/managing-discussions-for-your-community)" diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/index.md b/translations/pt-BR/content/organizations/managing-organization-settings/index.md index 0d440b3262..8473a71362 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/index.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/index.md @@ -25,6 +25,7 @@ children: - /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization - /setting-permissions-for-adding-outside-collaborators - /allowing-people-to-delete-issues-in-your-organization + - /enabling-or-disabling-github-discussions-for-an-organization - /managing-discussion-creation-for-repositories-in-your-organization - /setting-team-creation-permissions-in-your-organization - /managing-scheduled-reminders-for-your-organization diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md index f6ede53122..822c4a0d7b 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization.md @@ -10,7 +10,7 @@ versions: topics: - Organizations - Teams -shortTitle: Gerenciar criação de discussão +shortTitle: Manage repository discussions --- @@ -28,3 +28,4 @@ Por padrão, integrantes da organização com acesso de leitura podem criar disc - "[Sobre discussões](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" - "[Gerenciar discussões para a sua comunidade](/discussions/managing-discussions-for-your-community)" +- "[Enabling or disabling GitHub Discussions for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)" diff --git a/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md index 2f92adc46d..1ffeed2655 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -58,7 +58,7 @@ For more information, see "[About permissions for {% data variables.product.prod {% endif %} ## Supported clients and formats - + {% data variables.product.prodname_registry %} uses the native package tooling commands you're already familiar with to publish and install package versions. ### Support for package registries diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md index a508c50785..3145ced99c 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md @@ -19,6 +19,8 @@ shortTitle: Discussions {% data reusables.discussions.enabling-or-disabling-github-discussions-for-your-repository %} 1. Para desabilitar as discussões, em "Recursos", desmarque **Discussões**. +You can also use organization discussions to facilitate conversations that span multiple repositories in your organization. For more information, see "[Enabling or disabling GitHub Discussions for an organization](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization)." + ## Leia mais - "[Sobre discussões](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" diff --git a/translations/pt-BR/content/search-github/searching-on-github/searching-code.md b/translations/pt-BR/content/search-github/searching-on-github/searching-code.md index 93448e5f49..dbb214ce92 100644 --- a/translations/pt-BR/content/search-github/searching-on-github/searching-code.md +++ b/translations/pt-BR/content/search-github/searching-on-github/searching-code.md @@ -70,7 +70,6 @@ Você pode usar o qualificador `path` para pesquisar o código-fonte que aparece | path:PATH/TO/DIRECTORY | [**`console path:app/public language:javascript`**](https://github.com/search?q=console+path%3A%22app%2Fpublic%22+language%3Ajavascript&type=Code) corresponde arquivos do JavaScript com a palavra "console" no diretório app/public ou em qualquer um dos seus subdiretórios (ainda que residam em app/public/js/form-validators). | ## Pesquisar por linguagem - Você pode pesquisar código com base na linguagem na qual ele foi escrito. O qualificador da `linguagem` pode ser o nome da linguagem ou o alias. Para obter uma lista completa de linguagens compatíveis com seus nomes e alias, consulte o repositório [github/linguist](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). diff --git a/translations/pt-BR/data/reusables/classroom/reuse-assignment-link.md b/translations/pt-BR/data/reusables/classroom/reuse-assignment-link.md new file mode 100644 index 0000000000..73b7419440 --- /dev/null +++ b/translations/pt-BR/data/reusables/classroom/reuse-assignment-link.md @@ -0,0 +1 @@ +You can reuse an existing assignment in any other classroom you have admin access to, including classrooms in a different organization. For more information, see "[Reuse an assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/discussions/about-categories-and-formats.md b/translations/pt-BR/data/reusables/discussions/about-categories-and-formats.md index 591b650e8f..601ada8b80 100644 --- a/translations/pt-BR/data/reusables/discussions/about-categories-and-formats.md +++ b/translations/pt-BR/data/reusables/discussions/about-categories-and-formats.md @@ -1 +1 @@ -Todas as discussões devem ser criadas em uma categoria. As pessoas com permissões de manutenção ou administração definem as categorias de um repositório. Cada categoria tem um formato: discussão aberta, pergunta e resposta ou anúncio. +Todas as discussões devem ser criadas em uma categoria. For repository discussions, people with maintain or admin permissions to the repository define the categories for discussions in that repository. For organization discussions, people with maintain or admin permissions to the source repository define the categories for discussions in that organization. Cada categoria tem um formato: discussão aberta, pergunta e resposta ou anúncio. diff --git a/translations/pt-BR/data/reusables/discussions/about-discussions.md b/translations/pt-BR/data/reusables/discussions/about-discussions.md index 846f180578..2d6aa2eca4 100644 --- a/translations/pt-BR/data/reusables/discussions/about-discussions.md +++ b/translations/pt-BR/data/reusables/discussions/about-discussions.md @@ -1 +1 @@ -{% data variables.product.prodname_discussions %} is an open forum for conversation among maintainers and the community for a project on {% data variables.product.product_name %}. +{% data variables.product.prodname_discussions %} is an open forum for conversation among maintainers and the community for a repository or organization on {% data variables.product.product_name %}. diff --git a/translations/pt-BR/data/reusables/discussions/about-organization-discussions.md b/translations/pt-BR/data/reusables/discussions/about-organization-discussions.md new file mode 100644 index 0000000000..c9964a9b33 --- /dev/null +++ b/translations/pt-BR/data/reusables/discussions/about-organization-discussions.md @@ -0,0 +1,5 @@ +When you enable organization discussions, you will choose a repository in the organization to be the source repository for your organization discussions. You can use an existing repository or create a repository specifically to hold your organization discussions. Discussions will appear both on the discussions page for the organization and on the discussion page for the source repository. + +Permission to participate in or manage discussion in your organization is based on permission in the source repository. For example, a user needs write permission to the source repository in order to delete an organization discussion. This is identical to how a user needs write permission in a repository in order to delete a repository discussion. + +You can change the source repository at any time. If you change the source repository, discussions are not transferred to the new source repository. diff --git a/translations/pt-BR/data/reusables/discussions/discussions-tab.md b/translations/pt-BR/data/reusables/discussions/discussions-tab.md index 2774e346f9..71f1ba51ec 100644 --- a/translations/pt-BR/data/reusables/discussions/discussions-tab.md +++ b/translations/pt-BR/data/reusables/discussions/discussions-tab.md @@ -1 +1 @@ -1. No nome do seu repositório, clique em {% octicon "comment-discussion" aria-label="The discussion icon" %} **Discussões**. ![Aba "Discussões" de um repositório](/assets/images/help/discussions/repository-discussions-tab.png) +1. Under your repository or organization name, click {% octicon "comment-discussion" aria-label="The discussion icon" %} **Discussions**. ![Aba "Discussões" de um repositório](/assets/images/help/discussions/repository-discussions-tab.png) diff --git a/translations/pt-BR/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md b/translations/pt-BR/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md new file mode 100644 index 0000000000..8bfde99af1 --- /dev/null +++ b/translations/pt-BR/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md @@ -0,0 +1,5 @@ +1. Em {% data variables.product.product_location %}, acesse a página principal da sua organização. +1. Under your organization name, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. ![Botão de configurações da organização](/assets/images/help/discussions/org-settings.png) +1. Under "Discussions", select **Enable discussions for this organization**. +1. Select a repository to use as the source repository for your organization discussions. ![Settings to enable discussions for an organization](/assets/images/help/discussions/enable-org-discussions.png) +1. Clique em **Salvar**. diff --git a/translations/pt-BR/data/reusables/discussions/marking-a-comment-as-an-answer.md b/translations/pt-BR/data/reusables/discussions/marking-a-comment-as-an-answer.md index 0c2c51fb06..701d2712f0 100644 --- a/translations/pt-BR/data/reusables/discussions/marking-a-comment-as-an-answer.md +++ b/translations/pt-BR/data/reusables/discussions/marking-a-comment-as-an-answer.md @@ -6,7 +6,7 @@ Ao marcar uma pergunta como resposta, {% data variables.product.product_name %} Você não pode marcar um comentário em resposta a um comentário como resposta a uma discussão. Você também não pode marcar um comentário minimizado como resposta para uma discussão. -{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.navigate-to-repo-or-org %} {% data reusables.discussions.discussions-tab %} 1. Na lista de discussões, clique na discussão não respondida que você deseja marcar como respondida. ![Discussão não respondida](/assets/images/help/discussions/unanswered-discussion.png) 1. Na discussão, encontre o comentário que deseja marcar como resposta. diff --git a/translations/pt-BR/data/reusables/discussions/navigate-to-repo-or-org.md b/translations/pt-BR/data/reusables/discussions/navigate-to-repo-or-org.md new file mode 100644 index 0000000000..92670f998b --- /dev/null +++ b/translations/pt-BR/data/reusables/discussions/navigate-to-repo-or-org.md @@ -0,0 +1 @@ +1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization. diff --git a/translations/pt-BR/data/reusables/discussions/repository-category-limit.md b/translations/pt-BR/data/reusables/discussions/repository-category-limit.md index ca61bf579f..b1a8e50e1a 100644 --- a/translations/pt-BR/data/reusables/discussions/repository-category-limit.md +++ b/translations/pt-BR/data/reusables/discussions/repository-category-limit.md @@ -1 +1 @@ -Cada repositório pode ter até 10 categorias. +Each repository or organization can have up to 10 categories. diff --git a/translations/pt-BR/data/reusables/discussions/starting-a-discussion.md b/translations/pt-BR/data/reusables/discussions/starting-a-discussion.md index 88b94072ac..9b83c9e4d9 100644 --- a/translations/pt-BR/data/reusables/discussions/starting-a-discussion.md +++ b/translations/pt-BR/data/reusables/discussions/starting-a-discussion.md @@ -1,4 +1,5 @@ -{% data reusables.repositories.navigate-to-repo %} +1. Em +{% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to start a discussion. {% data reusables.discussions.discussions-tab %} 1. Clique em **Nova discussão**. ![Botão "Nova discussão" dentro da aba "Discussões" para um repositório](/assets/images/help/discussions/new-discussion-button.png) 1. Menu suspenso **Selecionar categoria** e clique em uma categoria para a sua discussão. ![Menu suspenso "Selecionar categoria" e lista de categorias disponíveis em repositório](/assets/images/help/discussions/new-discussion-select-category-dropdown-menu.png) diff --git a/translations/pt-BR/data/reusables/discussions/starting-a-poll.md b/translations/pt-BR/data/reusables/discussions/starting-a-poll.md new file mode 100644 index 0000000000..0ecfc99b37 --- /dev/null +++ b/translations/pt-BR/data/reusables/discussions/starting-a-poll.md @@ -0,0 +1,9 @@ +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.discussions.discussions-tab %} +1. In the list of categories, click **Polls**. ![Screenshot showing "Poll" category](/assets/images/help/discussions/poll-category.png) +1. On the right, click **Start poll**. ![Screenshot showing the "Start poll" button](/assets/images/help/discussions/start-poll-button.png) +1. Type a title and optional body for your poll. ![Screenshot showing text fields for title and body](/assets/images/help/discussions/new-poll-title-and-body-fields.png) +1. Type a question for your poll. ![Screenshot showing text fields for the poll's question](/assets/images/help/discussions/new-poll-question.png) +1. Type at least two options for your poll. ![Screenshot showing text fields for the poll's options](/assets/images/help/discussions/new-poll-options.png) +1. Optionally, to add a extra poll options, click **Add an option**. ![Screenshot showing "Add an option" button](/assets/images/help/discussions/new-poll-add-option.png) +1. Click **Start poll**. ![Screenshot showing the "Start poll" button](/assets/images/help/discussions/new-poll-start-poll-button.png) \ No newline at end of file