diff --git a/.github/actions/clone-translations/action.yml b/.github/actions/clone-translations/action.yml index a0bbab893e..f905b12a76 100644 --- a/.github/actions/clone-translations/action.yml +++ b/.github/actions/clone-translations/action.yml @@ -17,13 +17,6 @@ runs: token: ${{ inputs.token }} path: translations/zh-cn - - name: Clone Japanese - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 - with: - repository: github/docs-internal.ja-jp - token: ${{ inputs.token }} - path: translations/ja-jp - - name: Clone Spanish uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 with: @@ -38,12 +31,19 @@ runs: token: ${{ inputs.token }} path: translations/pt-br - - name: Clone German + - name: Clone Russian uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 with: - repository: github/docs-internal.de-de + repository: github/docs-internal.ru-ru token: ${{ inputs.token }} - path: translations/de-de + path: translations/ru-ru + + - name: Clone Japanese + uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 + with: + repository: github/docs-internal.ja-jp + token: ${{ inputs.token }} + path: translations/ja-jp - name: Clone French uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 @@ -52,12 +52,12 @@ runs: token: ${{ inputs.token }} path: translations/fr-fr - - name: Clone Russian + - name: Clone German uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 with: - repository: github/docs-internal.ru-ru + repository: github/docs-internal.de-de token: ${{ inputs.token }} - path: translations/ru-ru + path: translations/de-de - name: Clone Korean uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 diff --git a/.github/workflows/sync-search-elasticsearch.yml b/.github/workflows/sync-search-elasticsearch.yml index 6be289544c..c6d74d20db 100644 --- a/.github/workflows/sync-search-elasticsearch.yml +++ b/.github/workflows/sync-search-elasticsearch.yml @@ -48,7 +48,7 @@ jobs: script: | // Edit this list for the definitive list of languages // (other than English) we want to index in Elasticsearch. - const allNonEnglish = ["ja", "es", "pt", "zh", "ru", "fr", "ko", "de"] + const allNonEnglish = ["zh", "es", "pt", "ru", "ja", "fr", "de", "ko"] const allPossible = ["en", ...allNonEnglish] if (context.eventName === "workflow_run") { diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 88fcda5e0d..e70323aa83 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -44,15 +44,15 @@ jobs: return [ { name: 'content', path: 'tests/content', }, { name: 'graphql', path: 'tests/graphql', }, - { name: 'meta', path: 'tests/meta', }, - { name: 'rendering', path: 'tests/rendering', }, - { name: 'routing', path: 'tests/routing', }, - { name: 'unit', path: 'tests/unit', }, - { name: 'linting', path: 'tests/linting', }, - { name: 'rendering-fixtures', path: 'tests/rendering-fixtures', }, { name: 'events', path: 'src/events/tests', }, + { name: 'linting', path: 'tests/linting', }, + { name: 'meta', path: 'tests/meta', }, + { name: 'routing', path: 'tests/routing', }, + { name: 'rendering', path: 'tests/rendering', }, + { name: 'rendering-fixtures', path: 'tests/rendering-fixtures', }, context.payload.repository.full_name === 'github/docs-internal' && { name: 'translations', path: 'tests/translations', }, + { name: 'unit', path: 'tests/unit', }, ].filter(Boolean) test: diff --git a/.github/workflows/translation-health-report.yml b/.github/workflows/translation-health-report.yml index 14326c2977..59cae21876 100644 --- a/.github/workflows/translation-health-report.yml +++ b/.github/workflows/translation-health-report.yml @@ -24,29 +24,25 @@ jobs: fail-fast: false matrix: include: + - language: zh + language_dir: translations/zh-cn + language_repo: github/docs-internal.zh-cn + - language: es language_dir: translations/es-es language_repo: github/docs-internal.es-es - - language: ja - language_dir: translations/ja-jp - language_repo: github/docs-internal.ja-jp - - language: pt language_dir: translations/pt-br language_repo: github/docs-internal.pt-br - - language: zh - language_dir: translations/zh-cn - language_repo: github/docs-internal.zh-cn - - language: ru language_dir: translations/ru-ru language_repo: github/docs-internal.ru-ru - - language: ko - language_dir: translations/ko-kr - language_repo: github/docs-internal.ko-kr + - language: ja + language_dir: translations/ja-jp + language_repo: github/docs-internal.ja-jp - language: fr language_dir: translations/fr-fr @@ -56,6 +52,9 @@ jobs: language_dir: translations/de-de language_repo: github/docs-internal.de-de + - language: ko + language_dir: translations/ko-kr + language_repo: github/docs-internal.ko-kr steps: - name: Checkout the docs-internal repo uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 diff --git a/Dockerfile b/Dockerfile index 3347d1bd9a..2d11342ae9 100644 --- a/Dockerfile +++ b/Dockerfile @@ -107,7 +107,7 @@ FROM preview as production # Override what was set for previews # Make this match the default of `Object.keys(languages)` in lib/languages.js -ENV ENABLED_LANGUAGES "en,zh,ja,es,pt,de,fr,ru,ko" +ENV ENABLED_LANGUAGES "en,zh,es,pt,ru,ja,fr,de,ko" # Copy in all translations COPY --chown=node:node translations ./translations diff --git a/assets/images/help/sponsors/access-github-sponsors-dashboard.png b/assets/images/help/sponsors/access-github-sponsors-dashboard.png index 3a38276fcc..12116f655d 100644 Binary files a/assets/images/help/sponsors/access-github-sponsors-dashboard.png and b/assets/images/help/sponsors/access-github-sponsors-dashboard.png differ diff --git a/assets/images/help/sponsors/add-a-tier-button.png b/assets/images/help/sponsors/add-a-tier-button.png deleted file mode 100644 index e17a036f5d..0000000000 Binary files a/assets/images/help/sponsors/add-a-tier-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/add-a-welcome-message.png b/assets/images/help/sponsors/add-a-welcome-message.png deleted file mode 100644 index 5ec7fff1ef..0000000000 Binary files a/assets/images/help/sponsors/add-a-welcome-message.png and /dev/null differ diff --git a/assets/images/help/sponsors/add-webhook-sponsors-button.png b/assets/images/help/sponsors/add-webhook-sponsors-button.png deleted file mode 100644 index c155f2b8fd..0000000000 Binary files a/assets/images/help/sponsors/add-webhook-sponsors-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/billing-account-switcher.png b/assets/images/help/sponsors/billing-account-switcher.png deleted file mode 100644 index afdf166fff..0000000000 Binary files a/assets/images/help/sponsors/billing-account-switcher.png and /dev/null differ diff --git a/assets/images/help/sponsors/choose-fiscal-host-dropdown.png b/assets/images/help/sponsors/choose-fiscal-host-dropdown.png new file mode 100644 index 0000000000..86b229a4ef Binary files /dev/null and b/assets/images/help/sponsors/choose-fiscal-host-dropdown.png differ diff --git a/assets/images/help/sponsors/confirm-retire-goal.png b/assets/images/help/sponsors/confirm-retire-goal.png deleted file mode 100644 index 0a858957ac..0000000000 Binary files a/assets/images/help/sponsors/confirm-retire-goal.png and /dev/null differ diff --git a/assets/images/help/sponsors/create-stripe-connect-account.png b/assets/images/help/sponsors/create-stripe-connect-account.png deleted file mode 100644 index 0e3ce3ac35..0000000000 Binary files a/assets/images/help/sponsors/create-stripe-connect-account.png and /dev/null differ diff --git a/assets/images/help/sponsors/create-webhook-sponsors-button.png b/assets/images/help/sponsors/create-webhook-sponsors-button.png deleted file mode 100644 index ae640dc9d1..0000000000 Binary files a/assets/images/help/sponsors/create-webhook-sponsors-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/custom-amounts.png b/assets/images/help/sponsors/custom-amounts.png deleted file mode 100644 index 920533670e..0000000000 Binary files a/assets/images/help/sponsors/custom-amounts.png and /dev/null differ diff --git a/assets/images/help/sponsors/description-highlighted-org-members.png b/assets/images/help/sponsors/description-highlighted-org-members.png deleted file mode 100644 index 51bace6171..0000000000 Binary files a/assets/images/help/sponsors/description-highlighted-org-members.png and /dev/null differ diff --git a/assets/images/help/sponsors/dev-sponsors-dashboard-button.png b/assets/images/help/sponsors/dev-sponsors-dashboard-button.png deleted file mode 100644 index 3d1e62007f..0000000000 Binary files a/assets/images/help/sponsors/dev-sponsors-dashboard-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/disable-github-sponsors-account-dialog.png b/assets/images/help/sponsors/disable-github-sponsors-account-dialog.png deleted file mode 100644 index bdd3a9bf6e..0000000000 Binary files a/assets/images/help/sponsors/disable-github-sponsors-account-dialog.png and /dev/null differ diff --git a/assets/images/help/sponsors/disable-your-account-button.png b/assets/images/help/sponsors/disable-your-account-button.png deleted file mode 100644 index 69176ebd15..0000000000 Binary files a/assets/images/help/sponsors/disable-your-account-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/draft-tier-edit.png b/assets/images/help/sponsors/draft-tier-edit.png deleted file mode 100644 index bd9d097d01..0000000000 Binary files a/assets/images/help/sponsors/draft-tier-edit.png and /dev/null differ diff --git a/assets/images/help/sponsors/edit-goal-button.png b/assets/images/help/sponsors/edit-goal-button.png deleted file mode 100644 index c439f390ae..0000000000 Binary files a/assets/images/help/sponsors/edit-goal-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/edit-org-members-profile-button.png b/assets/images/help/sponsors/edit-org-members-profile-button.png deleted file mode 100644 index 6e1c74ebd8..0000000000 Binary files a/assets/images/help/sponsors/edit-org-members-profile-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/edit-sponsorship-payment-button.png b/assets/images/help/sponsors/edit-sponsorship-payment-button.png deleted file mode 100644 index b5747bcdd6..0000000000 Binary files a/assets/images/help/sponsors/edit-sponsorship-payment-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/edit-tier-button.png b/assets/images/help/sponsors/edit-tier-button.png deleted file mode 100644 index 1941159dc9..0000000000 Binary files a/assets/images/help/sponsors/edit-tier-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/enable-custom-amounts.png b/assets/images/help/sponsors/enable-custom-amounts.png deleted file mode 100644 index 335a95e51c..0000000000 Binary files a/assets/images/help/sponsors/enable-custom-amounts.png and /dev/null differ diff --git a/assets/images/help/sponsors/example-of-open-source-project-dependency.png b/assets/images/help/sponsors/example-of-open-source-project-dependency.png deleted file mode 100644 index 48279d2d75..0000000000 Binary files a/assets/images/help/sponsors/example-of-open-source-project-dependency.png and /dev/null differ diff --git a/assets/images/help/sponsors/example-sponsors-invoice.png b/assets/images/help/sponsors/example-sponsors-invoice.png deleted file mode 100644 index faf1cfaf59..0000000000 Binary files a/assets/images/help/sponsors/example-sponsors-invoice.png and /dev/null differ diff --git a/assets/images/help/sponsors/featured-work-edit-button.png b/assets/images/help/sponsors/featured-work-edit-button.png deleted file mode 100644 index 4a1c71da31..0000000000 Binary files a/assets/images/help/sponsors/featured-work-edit-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/featured-work-select.png b/assets/images/help/sponsors/featured-work-select.png deleted file mode 100644 index 11a08d907b..0000000000 Binary files a/assets/images/help/sponsors/featured-work-select.png and /dev/null differ diff --git a/assets/images/help/sponsors/fiscal-host-profile-url-field.png b/assets/images/help/sponsors/fiscal-host-profile-url-field.png new file mode 100644 index 0000000000..90d5f7ce56 Binary files /dev/null and b/assets/images/help/sponsors/fiscal-host-profile-url-field.png differ diff --git a/assets/images/help/sponsors/fiscal-host-project-profile-field.png b/assets/images/help/sponsors/fiscal-host-project-profile-field.png deleted file mode 100644 index 02c76fad8c..0000000000 Binary files a/assets/images/help/sponsors/fiscal-host-project-profile-field.png and /dev/null differ diff --git a/assets/images/help/sponsors/funding-yml-file.png b/assets/images/help/sponsors/funding-yml-file.png deleted file mode 100644 index 8ea922760c..0000000000 Binary files a/assets/images/help/sponsors/funding-yml-file.png and /dev/null differ diff --git a/assets/images/help/sponsors/get-sponsored.png b/assets/images/help/sponsors/get-sponsored.png deleted file mode 100644 index a9b49ff405..0000000000 Binary files a/assets/images/help/sponsors/get-sponsored.png and /dev/null differ diff --git a/assets/images/help/sponsors/goal-settings.png b/assets/images/help/sponsors/goal-settings.png deleted file mode 100644 index c04718bf69..0000000000 Binary files a/assets/images/help/sponsors/goal-settings.png and /dev/null differ diff --git a/assets/images/help/sponsors/grant-sponsors-access-to-repo-checkbox.png b/assets/images/help/sponsors/grant-sponsors-access-to-repo-checkbox.png deleted file mode 100644 index f3665d0b6c..0000000000 Binary files a/assets/images/help/sponsors/grant-sponsors-access-to-repo-checkbox.png and /dev/null differ diff --git a/assets/images/help/sponsors/grant-sponsors-access-to-repo-dropdown.png b/assets/images/help/sponsors/grant-sponsors-access-to-repo-dropdown.png index 45603c7b4e..5276cc053e 100644 Binary files a/assets/images/help/sponsors/grant-sponsors-access-to-repo-dropdown.png and b/assets/images/help/sponsors/grant-sponsors-access-to-repo-dropdown.png differ diff --git a/assets/images/help/sponsors/introduction-box.png b/assets/images/help/sponsors/introduction-box.png deleted file mode 100644 index c7e850441f..0000000000 Binary files a/assets/images/help/sponsors/introduction-box.png and /dev/null differ diff --git a/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/help/sponsors/manage-your-sponsorship-button.png deleted file mode 100644 index 53c9ed4ff8..0000000000 Binary files a/assets/images/help/sponsors/manage-your-sponsorship-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/opt-in-to-being-featured.png b/assets/images/help/sponsors/opt-in-to-being-featured.png deleted file mode 100644 index cfd8ffc33e..0000000000 Binary files a/assets/images/help/sponsors/opt-in-to-being-featured.png and /dev/null differ diff --git a/assets/images/help/sponsors/org-sponsoring-button.png b/assets/images/help/sponsors/org-sponsoring-button.png deleted file mode 100644 index 112d8c258b..0000000000 Binary files a/assets/images/help/sponsors/org-sponsoring-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/org-updates-checkbox-manage.png b/assets/images/help/sponsors/org-updates-checkbox-manage.png deleted file mode 100644 index 479378ae75..0000000000 Binary files a/assets/images/help/sponsors/org-updates-checkbox-manage.png and /dev/null differ diff --git a/assets/images/help/sponsors/org-waitlist-payout-options.png b/assets/images/help/sponsors/org-waitlist-payout-options.png deleted file mode 100644 index 5fc16af2e2..0000000000 Binary files a/assets/images/help/sponsors/org-waitlist-payout-options.png and /dev/null differ diff --git a/assets/images/help/sponsors/organization-update-email-textbox.png b/assets/images/help/sponsors/organization-update-email-textbox.png deleted file mode 100644 index 670c4513ef..0000000000 Binary files a/assets/images/help/sponsors/organization-update-email-textbox.png and /dev/null differ diff --git a/assets/images/help/sponsors/overview-tab.png b/assets/images/help/sponsors/overview-tab.png deleted file mode 100644 index bfbf3ff9f7..0000000000 Binary files a/assets/images/help/sponsors/overview-tab.png and /dev/null differ diff --git a/assets/images/help/sponsors/payouts-tab.png b/assets/images/help/sponsors/payouts-tab.png deleted file mode 100644 index 72a82ed2a7..0000000000 Binary files a/assets/images/help/sponsors/payouts-tab.png and /dev/null differ diff --git a/assets/images/help/sponsors/profile-tab.png b/assets/images/help/sponsors/profile-tab.png deleted file mode 100644 index 54bfe8d9a7..0000000000 Binary files a/assets/images/help/sponsors/profile-tab.png and /dev/null differ diff --git a/assets/images/help/sponsors/publish-goal-button.png b/assets/images/help/sponsors/publish-goal-button.png deleted file mode 100644 index 0c59c16f61..0000000000 Binary files a/assets/images/help/sponsors/publish-goal-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/publish-tier-button.png b/assets/images/help/sponsors/publish-tier-button.png deleted file mode 100644 index cda6675de4..0000000000 Binary files a/assets/images/help/sponsors/publish-tier-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/request-approval-button.png b/assets/images/help/sponsors/request-approval-button.png deleted file mode 100644 index 623706a62c..0000000000 Binary files a/assets/images/help/sponsors/request-approval-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/retire-goal-button.png b/assets/images/help/sponsors/retire-goal-button.png deleted file mode 100644 index 86a658bcea..0000000000 Binary files a/assets/images/help/sponsors/retire-goal-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/retire-tier-button.png b/assets/images/help/sponsors/retire-tier-button.png deleted file mode 100644 index e024c25b31..0000000000 Binary files a/assets/images/help/sponsors/retire-tier-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/save-tier-draft.png b/assets/images/help/sponsors/save-tier-draft.png deleted file mode 100644 index b9f694dfec..0000000000 Binary files a/assets/images/help/sponsors/save-tier-draft.png and /dev/null differ diff --git a/assets/images/help/sponsors/select-a-tier-box.png b/assets/images/help/sponsors/select-a-tier-box.png deleted file mode 100644 index 8b370232e3..0000000000 Binary files a/assets/images/help/sponsors/select-a-tier-box.png and /dev/null differ diff --git a/assets/images/help/sponsors/select-an-account-drop-down.png b/assets/images/help/sponsors/select-an-account-drop-down.png deleted file mode 100644 index 50c1543254..0000000000 Binary files a/assets/images/help/sponsors/select-an-account-drop-down.png and /dev/null differ diff --git a/assets/images/help/sponsors/select-goal-type.png b/assets/images/help/sponsors/select-goal-type.png deleted file mode 100644 index 4835aa4af5..0000000000 Binary files a/assets/images/help/sponsors/select-goal-type.png and /dev/null differ diff --git a/assets/images/help/sponsors/set-default-amount.png b/assets/images/help/sponsors/set-default-amount.png deleted file mode 100644 index e166fb10b2..0000000000 Binary files a/assets/images/help/sponsors/set-default-amount.png and /dev/null differ diff --git a/assets/images/help/sponsors/updates-tab.png b/assets/images/help/sponsors/updates-tab.png deleted file mode 100644 index 310e6135d0..0000000000 Binary files a/assets/images/help/sponsors/updates-tab.png and /dev/null differ diff --git a/content/apps/creating-github-apps/creating-github-apps/rate-limits-for-github-apps.md b/content/apps/creating-github-apps/creating-github-apps/rate-limits-for-github-apps.md index 8c8053cdc1..10bd70464a 100644 --- a/content/apps/creating-github-apps/creating-github-apps/rate-limits-for-github-apps.md +++ b/content/apps/creating-github-apps/creating-github-apps/rate-limits-for-github-apps.md @@ -1,6 +1,6 @@ --- title: Rate limits for GitHub Apps -intro: '{% data reusables.shortdesc.rate_limits_github_apps %}' +intro: '{% data reusables.shortdesc.rate_limits_apps %}' redirect_from: - /early-access/integrations/rate-limits - /apps/building-integrations/setting-up-and-registering-github-apps/about-rate-limits-for-github-apps @@ -18,65 +18,63 @@ topics: shortTitle: Rate limits --- -{% data reusables.enterprise.rate_limit %} +## About rate limits for {% data variables.product.prodname_github_apps %} + +{% ifversion ghec or fpt or ghae %} + +{% data variables.product.company_short %} sets a limit on the number of requests a {% data variables.product.prodname_github_app %} can send to the server within a specific time period. This limit helps to prevent abuse and denial-of-service attacks, and ensures that the system remains available for all users. + +{% endif %} + +{% ifversion ghec or fpt %} + +{% data variables.product.company_short %} may apply additional secondary rate limits to some actions, to ensure API availability. You can avoid secondary rate limits by following best practices and staying within the rate limit guidelines listed below. For more information about secondary rate limits, see "[AUTOTITLE](/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" and "[AUTOTITLE](/rest/overview/resources-in-the-rest-api#secondary-rate-limits)." + +{% elsif ghes %} + +{% note %} + +Rate limits are disabled by default for {% data variables.product.product_name %}. Contact your site administrator to confirm the rate limits for your instance. + +{% endnote %} + +When rate limits are enabled for your {% data variables.product.product_name %} instance, there is a limit on the number of requests a {% data variables.product.prodname_github_app %} can send to the server within a specific time period. This limit helps to ensure the system remains available for all users. + +{% endif %} + +## Determining rate limits for a {% data variables.product.prodname_github_app %} {% data reusables.rest-api.always-check-your-limit %} {% ifversion ghec or fpt %} -## About rate limits for apps - -Rate limits for {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} depend on the plan for the organization where you install the application. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products)" and "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts#organization-accounts)." +The rate limits for requests made by a {% data variables.product.prodname_github_app %} depend on where the app is installed. If the app is installed on an organization or repository owned by an enterprise on {% data variables.location.product_location %}, the rate limit will be higher than for an app that is installed outside an enterprise. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products)" and "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts#organization-accounts)." {% endif %} -## Server-to-server requests +Rate limits {% ifversion ghec or fpt %}also {% endif %}depend on whether the {% data variables.product.prodname_github_app %} authenticates with a user access token or with an installation access token. A user access token allows an app to act on behalf of a specific user, after the user authorizes the app. An installation access token allows an app to attribute actions to the app itself. For more information about user and installation access tokens, "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)." -{% ifversion ghec or fpt %} +### Installation access tokens{% ifversion fpt or ghec %} on {% data variables.product.prodname_dotcom_the_website %}{% endif %} -### Default server-to-server rate limits for {% data variables.product.prodname_dotcom_the_website %} - -{% endif %} - -{% data variables.product.prodname_github_apps %} making server-to-server requests use the installation's minimum rate limit of 5,000 requests per hour. If an application is installed on an organization with more than 20 users, the application receives another 50 requests per hour for each user. Installations that have more than 20 repositories receive another 50 requests per hour for each repository. The maximum rate limit for an installation is 12,500 requests per hour. +{% data variables.product.prodname_github_apps %} authenticating with an installation access token use the installation's minimum rate limit of 5,000 requests per hour. If an application is installed on an organization with more than 20 users, the application receives another 50 requests per hour for each user. Installations that have more than 20 repositories receive another 50 requests per hour for each repository. The maximum rate limit for an installation is 12,500 requests per hour. {% ifversion fpt or ghec %} -### Server-to-server rate limits for {% data variables.product.prodname_ghe_cloud %} - -{% endif %} - -{% ifversion fpt or ghec %} +### Installation access tokens on {% data variables.product.prodname_ghe_cloud %} {% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.location.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} -## User-to-server requests +### User access tokens{% ifversion fpt or ghec %} on {% data variables.product.prodname_dotcom_the_website %}{% endif %} -{% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} can also act on behalf of a user, making user-to-server requests after the user authorizes the app. For more information, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)" and "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)." - -User-to-server requests from {% data variables.product.prodname_oauth_apps %} are authenticated with an OAuth token. User-to-server requests from {% data variables.product.prodname_github_apps %} are authenticated with either an OAuth token or an expiring user access token. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/identifying-and-authorizing-users-for-github-apps#identifying-and-authorizing-users-for-github-apps)" and "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps)." +{% ifversion ghes %}By default, user access token{% else %}User access token{% endif %} requests are limited to {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour and per authenticated user. {% ifversion fpt or ghec %} -### Default user-to-server rate limits for {% data variables.product.prodname_dotcom_the_website %} +### User access tokens on {% data variables.product.prodname_ghe_cloud %} -{% endif %} - -{% ifversion ghec %} - -The rate limits for user-to-server requests made by {% data variables.product.prodname_github_apps %} depend on where the app is installed. If the app is installed on organizations or repositories owned by an enterprise on {% data variables.location.product_location %}, then the rate is higher than for installations outside an enterprise. - -{% endif %} - -{% data reusables.apps.user-to-server-rate-limits %} - -{% ifversion fpt or ghec %} - -### User-to-server rate limits for {% data variables.product.prodname_ghe_cloud %} - -{% data reusables.apps.user-to-server-rate-limits-ghec %} +User access token requests are subject to a higher limit of 15,000 requests per hour and per authenticated user when the request is from a {% data variables.product.prodname_github_app %} that is owned by a {% data variables.product.prodname_ghe_cloud %} organization. {% endif %} diff --git a/content/apps/oauth-apps/building-oauth-apps/index.md b/content/apps/oauth-apps/building-oauth-apps/index.md index 5084645cc6..beae1b3d23 100644 --- a/content/apps/oauth-apps/building-oauth-apps/index.md +++ b/content/apps/oauth-apps/building-oauth-apps/index.md @@ -13,6 +13,7 @@ versions: topics: - OAuth Apps children: + - /rate-limits-for-oauth-apps - /creating-an-oauth-app - /authenticating-to-the-rest-api-with-an-oauth-app - /authorizing-oauth-apps diff --git a/content/apps/oauth-apps/building-oauth-apps/rate-limits-for-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/rate-limits-for-oauth-apps.md new file mode 100644 index 0000000000..b8da3fb654 --- /dev/null +++ b/content/apps/oauth-apps/building-oauth-apps/rate-limits-for-oauth-apps.md @@ -0,0 +1,59 @@ +--- +title: Rate limits for OAuth Apps +intro: '{% data reusables.shortdesc.rate_limits_apps %}' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - OAuth Apps +shortTitle: Rate limits +--- + +## About rate limits for {% data variables.product.prodname_oauth_apps %} + +{% ifversion ghec or fpt or ghae %} + +{% data variables.product.company_short %} sets a limit on the number of requests an {% data variables.product.prodname_oauth_app %} can send to the server within a specific time period. This limit helps to prevent abuse and denial-of-service attacks, and ensures that the system remains available for all users. + +{% endif %} + +{% ifversion ghec or fpt %} + +{% data variables.product.company_short %} may apply additional secondary rate limits to some actions, to ensure API availability. You can avoid secondary rate limits by following best practices and staying within the rate limit guidelines listed below. For more information about secondary rate limits, see "[AUTOTITLE](/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" and "[AUTOTITLE](/rest/overview/resources-in-the-rest-api#secondary-rate-limits)." + +{% elsif ghes %} + +{% note %} + +Rate limits are disabled by default for {% data variables.product.product_name %}. Contact your site administrator to confirm the rate limits for your instance. + +{% endnote %} + +When rate limits are enabled for your {% data variables.product.product_name %} instance, there is a limit on the number of requests an {% data variables.product.prodname_oauth_app %} can send to the server within a specific time period. This limit helps to ensure the system remains available for all users. + +{% endif %} + +{% data variables.product.prodname_oauth_apps %} act on behalf of a user, by making requests with a user access token after the user authorizes the app. User access token requests from {% data variables.product.prodname_oauth_apps %} are authenticated with an OAuth token. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps)." + +## Determining rate limits for an {% data variables.product.prodname_oauth_app %} + +{% data reusables.rest-api.always-check-your-limit %} + +{% ifversion ghes %}By default, {% data variables.product.prodname_oauth_apps %}{% else %}{% data variables.product.prodname_oauth_apps %}{% endif %} are limited to {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour and per authenticated user. All requests from {% data variables.product.prodname_oauth_apps %} that are authorized by a user or a {% data variables.product.pat_generic %} owned by the user, and requests authenticated with any of the user's authentication credentials, share the same quota of {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour for that user. + +{% ifversion fpt or ghec %} + +{% data variables.product.prodname_oauth_apps %} are subject to a higher limit of 15,000 requests per hour and per authenticated user when both of the following are true: + +- The request is from an {% data variables.product.prodname_oauth_app %} that's owned or approved by a {% data variables.product.prodname_ghe_cloud %} organization. +- The authenticated user is a member of the {% data variables.product.prodname_ghe_cloud %} organization. + +For more information about rate limits, see "[AUTOTITLE](/rest/overview/resources-in-the-rest-api#rate-limiting)" and "[AUTOTITLE](/rest/rate-limit#understanding-your-rate-limit-status)" in the REST API documentation. + +{% endif %} + +## Further reading + +- "[AUTOTITLE](/graphql/overview/resource-limitations)" in the GraphQL API documentation diff --git a/content/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship.md b/content/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship.md index e96a2562e4..e0ad3bfe25 100644 --- a/content/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship.md +++ b/content/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship.md @@ -33,5 +33,5 @@ When you downgrade or cancel a sponsorship, the change will become effective on {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} {% data reusables.sponsors.billing-switcher %} -3. Under "{% data variables.product.prodname_sponsors %}", next to the sponsored account, click your current tier amount, then click **Cancel sponsorship**. -4. Review the alert about canceling your sponsorship, then click **OK**. \ No newline at end of file +1. Under "{% data variables.product.prodname_sponsors %}", next to the sponsored account, click your current tier amount, then click **Cancel sponsorship**. +1. Review the alert about canceling your sponsorship, then click **OK**. \ No newline at end of file diff --git a/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md b/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md index d77c8fd6c7..8023a5558d 100644 --- a/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md +++ b/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md @@ -22,7 +22,6 @@ You can also disable updates from accounts your organization sponsors. For more {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} 1. Under "Sponsors update email (Private)", type the email address you want to receive updates from accounts your organization sponsors. - ![Textbox to enter the email address to receive updates from sponsored accounts](/assets/images/help/sponsors/organization-update-email-textbox.png) 1. Click **Update profile**. ![Update profile button](/assets/images/help/organizations/update-profile-button.png) 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 56c1066d77..51a0ef33eb 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 @@ -15,7 +15,7 @@ shortTitle: Display a sponsor button --- ## About FUNDING files -You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." +You can configure your sponsor button by editing a `FUNDING.yml` file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." You can add one username, package name, or project name per external funding platform and up to four custom URLs. You can add one organization and up to four sponsored developers in {% data variables.product.prodname_sponsors %}. Add each platform on a new line, using the following syntax: @@ -43,7 +43,7 @@ Java | `maven` PHP | `packagist` C# | `nuget` -Here's an example _FUNDING.yml_ file: +Here's an example `FUNDING.yml` file: ``` github: [octocat, surftocat] patreon: octocat @@ -71,12 +71,15 @@ Anyone with admin permissions can enable a sponsor button in a repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Under Features, select **Sponsorships**. +1. Under Features, select **Sponsorships**. + ![Checkbox to enable Sponsorships](/assets/images/help/sponsors/sponsorships-checkbox.png) -4. Under "Sponsorships", click **Set up sponsor button** or **Override funding links**. + +1. Under "Sponsorships", click **Set up sponsor button** or **Override funding links**. + ![Button to set up sponsor button](/assets/images/help/sponsors/sponsor-set-up-button.png) -5. In the file editor, follow the instructions in the _FUNDING.yml_ file to add links to your funding locations. - ![Edit the FUNDING file to add links to funding locations](/assets/images/help/sponsors/funding-yml-file.png) + +1. In the file editor, follow the instructions in the `FUNDING.yml` file to add links to your funding locations. {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index 09872d2d0d..de2a74be53 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -120,7 +120,7 @@ Read [more about OAuth2](/apps/oauth-apps/building-oauth-apps). Note that OAuth curl -u my_client_id:my_client_secret '{% data variables.product.api_url_pre %}/user/repos' ``` -Using your `client_id` and `client_secret` does _not_ authenticate as a user, it will only identify your OAuth App to increase your rate limit. Permissions are only granted to users, not applications, and you will only get back data that an unauthenticated user would see. For this reason, you should only use the OAuth2 key/secret in server-to-server scenarios. Don't leak your OAuth App's client secret to your users. +Using your `client_id` and `client_secret` does _not_ authenticate as a user, it will only identify your {% data variables.product.prodname_oauth_app %} to increase your rate limit. Permissions are only granted to users, not applications, and you will only get back data that an unauthenticated user would see. Don't leak your {% data variables.product.prodname_oauth_app %}'s client secret to your users. {% ifversion ghes %} You will be unable to authenticate using your OAuth2 key and secret while in private mode, and trying to authenticate will return `401 Unauthorized`. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-private-mode)". @@ -329,15 +329,18 @@ Different types of API requests to {% data variables.location.product_location % #### Rate limits for requests from personal accounts -Direct API requests that you authenticate with a {% data variables.product.pat_generic %} 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 "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)," "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)," and "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." +You can make direct API requests that you authenticate with a {% data variables.product.pat_generic %}. An {% data variables.product.prodname_oauth_app %} or {% data variables.product.prodname_github_app %} can also make a request on your behalf after you authorize the app. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)," "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)," and "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." -{% data variables.product.product_name %} associates all user-to-server requests with the authenticated user. For OAuth Apps and GitHub Apps, this is the user who authorized the app. All user-to-server requests count toward the authenticated user's rate limit. +{% data variables.product.product_name %} associates all of these requests with the authenticated user. For {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %}, this is the user who authorized the app. All of these requests count toward the authenticated user's rate limit. {% data reusables.apps.user-to-server-rate-limits %} {% ifversion fpt or ghec %} -{% data reusables.apps.user-to-server-rate-limits-ghec %} +User access token requests are subject to a higher limit of 15,000 requests per hour and per authenticated user in the following scenarios: + +- The request is from a {% data variables.product.prodname_github_app %} that is owned by a {% data variables.product.prodname_ghe_cloud %} organization. +- The request is from an {% data variables.product.prodname_oauth_app %} that is owned or approved by a {% data variables.product.prodname_ghe_cloud %} organization. {% ifversion fpt or ghec or ghes %} @@ -349,7 +352,7 @@ For unauthenticated requests, the rate limit allows for up to 60 requests per ho #### Rate limits for requests from {% data variables.product.prodname_github_apps %} -Requests from a GitHub App may be either user-to-server or server-to-server requests. For more information about rate limits for GitHub Apps, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/rate-limits-for-github-apps)." +Requests from a {% data variables.product.prodname_github_app %} may either use a user access token or an installation access token. For more information about rate limits for {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/rate-limits-for-github-apps)." #### Rate limits for requests from {% data variables.product.prodname_actions %} @@ -406,9 +409,9 @@ If you exceed the rate limit, the response will have a `403` status and the `x-r If you are rate limited, you should not try your request until after the time specified by the `x-ratelimit-reset` time. -### Increasing the unauthenticated rate limit for OAuth Apps +### Increasing the unauthenticated rate limit for {% data variables.product.prodname_oauth_apps %} -If your OAuth App needs to make unauthenticated calls with a higher rate limit, you can pass your app's client ID and secret before the endpoint route. +If your {% data variables.product.prodname_oauth_app %} needs to make unauthenticated calls with a higher rate limit, you can pass your app's client ID and secret before the endpoint route. ```shell $ curl -u my_client_id:my_client_secret -I {% data variables.product.api_url_pre %}/user/repos @@ -422,7 +425,7 @@ $ curl -u my_client_id:my_client_secret -I {% data variables.product.api_url_pre {% note %} -**Note:** Never share your client secret with anyone or include it in client-side browser code. Use the method shown here only for server-to-server calls. +**Note:** Never share your client secret with anyone or include it in client-side browser code. {% endnote %} 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 6a2f2f9bd1..21a7f3a218 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 @@ -16,8 +16,6 @@ As you consider where to find open source contributors to sponsor, consider star If you're logged in, the sponsors results will start with public dependencies that your repositories depend on. -![The Babel open source project with highlighted text that says "4 of your repositories depend on this"](/assets/images/help/sponsors/example-of-open-source-project-dependency.png) - You can also toggle which of your accounts to view results for and further filter or search. ![Search options on sponsors community search page](/assets/images/help/sponsors/sponsors-search-options.png) 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 6db6e1c7eb..cb82e7f20e 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 @@ -22,7 +22,7 @@ For sponsored developer accounts, the update will come from your personal accoun ## Contacting your sponsors {% data reusables.sponsors.navigate-to-sponsors-dashboard %} -{% data reusables.sponsors.sponsors-updates-tab %} +1. In the "Manage" section of the sidebar, click **Newsletters**. {% data reusables.sponsors.draft-new-update %} {% data reusables.sponsors.send-update-to-sponsors %} {% data reusables.sponsors.write-sponsor-update %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/disabling-your-github-sponsors-account.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/disabling-your-github-sponsors-account.md index 2dcf0dde41..302254236e 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/disabling-your-github-sponsors-account.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/disabling-your-github-sponsors-account.md @@ -21,7 +21,5 @@ Alternatively, you can unpublish your sponsors profile and then republish the ac {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.settings-tab %} -1. Under "Disable GitHub Sponsors account", click **Disable account**. - !["Disable your account" button](/assets/images/help/sponsors/disable-your-account-button.png) -2. To confirm, click **Disable GitHub Sponsors account**. - !["Disable GitHub Sponsors account" button](/assets/images/help/sponsors/disable-github-sponsors-account-dialog.png) +1. In the "Disable {% data variables.product.prodname_sponsors %} account" section, click **Disable account**. +1. To confirm, click **Disable {% data variables.product.prodname_sponsors %} account**. diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md index 9cde32c6b8..8f51854e74 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md @@ -28,17 +28,12 @@ shortTitle: Manage payment tiers 1. If you are setting up tiers for the first time, we recommend you review the suggested tier examples to see how some other open source contributors have set up {% data variables.product.prodname_sponsors %}. Decide whether you want to start with some suggested draft tiers, which you can customize in the tier editor. - To use a suggested tier, select the rewards you'd like to include in your draft tier or tiers. Then, click **Continue to tier editor**. - To create tiers without using with any of the draft suggestions, click **Skip this step**. - + ![Screenshot of "Skip this step" option and "Continue to tier editor" button](/assets/images/help/sponsors/tier-editor-button.png) -1. Optionally, in the text boxes under "Custom amounts", type a recommended or minimum sponsorship amount. The minimum amount applies to both recurring and one-time sponsorships. - - ![Screenshot of custom amounts fields](/assets/images/help/sponsors/custom-amounts.png) - +1. Optionally, in the text boxes in the "Custom amounts" section, type a recommended or minimum sponsorship amount. The minimum amount applies to both recurring and one-time sponsorships. 1. Optionally, to edit a draft tier, find the draft tier and click **Edit**. - ![Screenshot of edit button next to draft tier](/assets/images/help/sponsors/draft-tier-edit.png) - {% data reusables.sponsors.click-add-tier %} {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.add-welcome-message %} @@ -67,11 +62,11 @@ shortTitle: Manage payment tiers To add a repository to a tier, the repository must be private and owned by an organization, and you must have admin access to the repository. -When you add a repository to a tier, {% data variables.product.company_short %} will automatically send repository invitations to new sponsors and remove access when a sponsorship is canceled. +When you add a repository to a tier, {% data variables.product.company_short %} will automatically send repository invitations to new sponsors and remove access when a sponsorship is canceled. Only personal accounts, not organizations, can be invited to private repositories associated with a sponsorship tier. -You can also manually add or remove collaborators to the repository, and {% data variables.product.company_short %} will not override these in the sync. +You can also manually add or remove collaborators to the repository, and {% data variables.product.company_short %} will not override these in the sync. ### About transfers for repositories that are added to sponsorship tiers @@ -87,11 +82,8 @@ If you transfer a repository that has been added to a sponsorship tier, sponsors {% data reusables.sponsors.navigate-to-sponsor-tiers-tab %} {% data reusables.sponsors.edit-tier %} 1. Select **Grant sponsors access to a private repository**. +1. Select the dropdown menu that appears and click the repository you want to add. - ![Screenshot of checkbox to grant sponsors access to a private repository](/assets/images/help/sponsors/grant-sponsors-access-to-repo-checkbox.png) - -1. Select the dropdown menu and click the repository you want to add. - - ![Screenshot of dropdown menu to choose the repository to grant sponsors access to](/assets/images/help/sponsors/grant-sponsors-access-to-repo-dropdown.png) + ![Screenshot of a sponsor tier editing screen. An expanded dropdown menu of repositories you can grant sponsors access to is outlined in dark orange.](/assets/images/help/sponsors/grant-sponsors-access-to-repo-dropdown.png) {% data reusables.sponsors.tier-update %} 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 9340d78207..ec1888c8f0 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 @@ -27,11 +27,9 @@ To join {% data variables.product.prodname_sponsors %} as an individual contribu {% data reusables.sponsors.navigate-to-github-sponsors %} {% data reusables.sponsors.view-eligible-accounts %} -3. To the right of your organization, click **Join the waitlist**. +1. To the right of your organization, click **Join the waitlist**. {% data reusables.sponsors.contact-info %} {% data reusables.sponsors.payout-choice %} - ![Screenshot of option to choose between a bank account and a fiscal host](/assets/images/help/sponsors/org-waitlist-payout-options.png) - {% data reusables.sponsors.accept-legal-terms %} ## Completing your sponsored organization profile diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account.md index 3fffe99d9e..bb695c0d73 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account.md @@ -23,9 +23,8 @@ shortTitle: Set up for personal account To join {% data variables.product.prodname_sponsors %} as an organization, see "[AUTOTITLE](/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 **Get sponsored**, then in the list of accounts, find your personal account. - ![Screenshot of the Get sponsored button](/assets/images/help/sponsors/get-sponsored.png) -3. Click **Join the waitlist**. +1. If you are an organization owner, you have more than one eligible account. Click **Get sponsored**, then in the list of accounts, find your personal account. +1. Click **Join the waitlist**. {% data reusables.sponsors.contact-info %} {% data reusables.sponsors.payout-choice %} ![Screenshot of option to choose between a bank account and a fiscal host](/assets/images/help/sponsors/user-waitlist-payout-options.png) @@ -90,6 +89,5 @@ Before you can become a sponsored developer, you must enable 2FA for your accoun {% data reusables.sponsors.navigate-to-sponsors-dashboard %} 4. Click **Request approval**. - ![Request approval button](/assets/images/help/sponsors/request-approval-button.png) {% data reusables.sponsors.github-review-app %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md index d71f842df6..f891f18ab7 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts.md @@ -33,6 +33,9 @@ Once you navigate to the "Join the waitlist" profile setup page for the account ![Screenshot of option to choose between a bank account and a fiscal host](/assets/images/help/sponsors/user-waitlist-payout-options.png) 2. Use the **Select a fiscal host** dropdown to choose the fiscal host you want to use. + + ![Screenshot of the fiscal host options for a sponsor profile. A collapsed dropdown menu, labeled "Select a fiscal host", is outlined in dark orange.](/assets/images/help/sponsors/choose-fiscal-host-dropdown.png) + 3. In the text box under "Fiscal host project profile URL", type the URL to your profile page on the fiscal host's site. This helps us verify that you are indeed registered with the fiscal host. - - ![Screenshot of text box for project profile URL of your fiscal host](/assets/images/help/sponsors/fiscal-host-project-profile-field.png) + + ![Screenshot of fiscal host options for a sponsor profile. A text field, labeled "Fiscal host project profile URL", is outlined in dark orange.](/assets/images/help/sponsors/fiscal-host-profile-url-field.png) diff --git a/content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md b/content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md index 76624a51e5..118f086da2 100644 --- a/content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md +++ b/content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md @@ -16,11 +16,10 @@ shortTitle: Attribute sponsorships --- 1. Navigate to the organization whose sponsorships you want to attribute to another organization. -2. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**. +1. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**. !["Sponsoring" tab](/assets/images/help/sponsors/sponsoring-tab.png) 1. In the upper-right corner, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. !["Settings" button](/assets/images/help/sponsors/sponsoring-settings-button.png) -1. Under "Link sponsorships to another account", use the drop-down menu, then click the organization you want this organization's sponsorships to be attributed to. - ![Drop-down menu to select account](/assets/images/help/sponsors/select-an-account-drop-down.png) +1. In the "Link sponsorships to another account" section, select the dropdown menu, then click the organization you want your organization's sponsorships to be attributed to. 1. Click **Link account**. !["Link account" button](/assets/images/help/sponsors/link-account-button.png) diff --git a/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md b/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md index 6bd2df69a4..57b65c991b 100644 --- a/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md +++ b/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md @@ -19,7 +19,4 @@ Companies can use an invoice method to participate in the {% data variables.prod Companies paying by invoice will be invoiced separately for their {% data variables.product.prodname_sponsors %} payments and their other payments to GitHub. Payments to {% data variables.product.prodname_sponsors %} are invoiced through Stripe. -![Example GitHub Sponsors invoice sent via Stripe](/assets/images/help/sponsors/example-sponsors-invoice.png) - You can join this beta program by talking to your sales representative, or by [contacting us](https://support.github.com/contact/org-sponsors-waitlist). - 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 61df9d0c1c..0dbae43639 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 @@ -82,7 +82,6 @@ Before you can sponsor an account, you must have a verified email address. For m {% data reusables.sponsors.select-a-tier %} {% data reusables.sponsors.pay-prorated-amount %} {% data reusables.sponsors.select-sponsorship-billing %} - ![Edit payment button](/assets/images/help/sponsors/edit-sponsorship-payment-button.png) {% data reusables.sponsors.who-can-see-your-sponsorship %} ![Radio buttons to choose who can see your sponsorship](/assets/images/help/sponsors/who-can-see-sponsorship.png) {% data reusables.sponsors.choose-updates %} diff --git a/contributing/search.md b/contributing/search.md index ec893526e0..762c2a345f 100644 --- a/contributing/search.md +++ b/contributing/search.md @@ -19,7 +19,7 @@ You can also query our search endpoint directly at: `https://docs.github.com/search?version=&language=&filters=topics:&query=` - The VERSION can be any numbered GitHub Enterprise Server version (e.g., `2.22`, `3.0`), GitHub AE (`ghae`), or the Free pro team plan (`dotcom`). -- The LANGUAGE CODE can be: `zh`, `de`, `en`, `es`, `ja`, or `pt`. +- The LANGUAGE CODE can be one of: `zh`, `es`, `pt`, `ru`, `ja`, `fr`, `de`, `ko` - TOPIC can be any topics in [the allowed list of topics](/data/allowed-topics.js). The values in the `topics` attribute are **not** case sensitive, so filtering on `GitHub actions` or `github actions` will return the same result. **Note:** Currently, the topics filter only works for the dotcom version in the English language. We plan to expand this search query to other languages and versions in the future. - Any search QUERY you'd like. @@ -94,18 +94,15 @@ There's a separate search index for each combination of product and language. So Index Name | Description ---------- | ----------- -`github-docs-dotcom-zh` | GitHub.com Chinese `github-docs-dotcom-en` | GitHub.com English +`github-docs-dotcom-zh` | GitHub.com Chinese `github-docs-dotcom-es` | GitHub.com Spanish -`github-docs-dotcom-ja` | GitHub.com Japanese -`github-docs-2.18-zh` | GitHub Enterprise 2.18 Chinese `github-docs-2.18-en` | GitHub Enterprise 2.18 English +`github-docs-2.18-zh` | GitHub Enterprise 2.18 Chinese `github-docs-2.18-es` | GitHub Enterprise 2.18 Spanish -`github-docs-2.18-ja` | GitHub Enterprise 2.18 Japanese -`github-docs-2.17-zh` | GitHub Enterprise 2.17 Chinese `github-docs-2.17-en` | GitHub Enterprise 2.17 English +`github-docs-2.17-zh` | GitHub Enterprise 2.17 Chinese `github-docs-2.17-es` | GitHub Enterprise 2.17 Spanish -`github-docs-2.17-ja` | GitHub Enterprise 2.17 Japanese ## Records diff --git a/data/reusables/apps/user-to-server-rate-limits-ghec.md b/data/reusables/apps/user-to-server-rate-limits-ghec.md deleted file mode 100644 index 1d6190588e..0000000000 --- a/data/reusables/apps/user-to-server-rate-limits-ghec.md +++ /dev/null @@ -1,4 +0,0 @@ -User-to-server requests are subject to a higher limit of 15,000 requests per hour and per authenticated user in the following scenarios. - -- The request is from a {% data variables.product.prodname_github_app %} that's owned by a {% data variables.product.prodname_ghe_cloud %} organization. -- The request is from an {% data variables.product.prodname_oauth_app %} that's owned or approved by a {% data variables.product.prodname_ghe_cloud %} organization. diff --git a/data/reusables/apps/user-to-server-rate-limits.md b/data/reusables/apps/user-to-server-rate-limits.md index f56f5c3e0c..9cd24e6312 100644 --- a/data/reusables/apps/user-to-server-rate-limits.md +++ b/data/reusables/apps/user-to-server-rate-limits.md @@ -1 +1 @@ -{% ifversion ghes %}By default, user-to-server{% else %}User-to-server{% endif %} requests are limited to {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour and per authenticated user. All requests from OAuth applications authorized by a user or a {% data variables.product.pat_generic %} owned by the user, and requests authenticated with any of the user's authentication credentials, share the same quota of {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour for that user. +{% ifversion ghes %}By default, user access token{% else %}User access token{% endif %} requests are limited to {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour and per authenticated user. All requests from OAuth applications authorized by a user or a {% data variables.product.pat_generic %} owned by the user, and requests authenticated with any of the user's authentication credentials, share the same quota of {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour for that user. diff --git a/data/reusables/enterprise/rate_limit.md b/data/reusables/enterprise/rate_limit.md index 7f664b5044..cf5206055b 100644 --- a/data/reusables/enterprise/rate_limit.md +++ b/data/reusables/enterprise/rate_limit.md @@ -2,7 +2,7 @@ {% note %} -**Note**: Rate limits are disabled by default for {% data variables.product.product_name %}. Contact your site administrator to confirm the rate limits for your instance. +Rate limits are disabled by default for {% data variables.product.product_name %}. Contact your site administrator to confirm the rate limits for your instance. {% endnote %} diff --git a/data/reusables/package_registry/package-settings-delete-versions.md b/data/reusables/package_registry/package-settings-delete-versions.md index 0ab5e80d55..af1082fc15 100644 --- a/data/reusables/package_registry/package-settings-delete-versions.md +++ b/data/reusables/package_registry/package-settings-delete-versions.md @@ -1,5 +1,5 @@ 1. In the list of packages, find the version of the package that you want to delete. - * If your package is a container, to the right of the package version click {% octicon "kebab-horizontal" aria-hidden="true" %}, then select **Delete version** from the dropdown menu. + * _If your package is a container_, to the right of the package version click {% octicon "kebab-horizontal" aria-hidden="true" %}, then select **Delete version** from the dropdown menu. ![Screenshot of a package version with a dropdown menu button, labeled with a kebab icon. The "Delete version" link in the menu is highlighted with an orange outline.](/assets/images/help/package-registry/delete-container-package-version.png) - * For types of packages other than containers, to the right of the package version click **Delete**. + * _For types of packages other than containers_, to the right of the package version click **Delete**. ![Screenshot of a package version with a "Delete" button. The button is highlighted with an orange outline.](/assets/images/help/package-registry/delete-noncontainer-package-version.png) \ No newline at end of file diff --git a/data/reusables/package_registry/package-settings-manage-versions-menu.md b/data/reusables/package_registry/package-settings-manage-versions-menu.md index a8cfb81255..b366fd54d1 100644 --- a/data/reusables/package_registry/package-settings-manage-versions-menu.md +++ b/data/reusables/package_registry/package-settings-manage-versions-menu.md @@ -3,9 +3,9 @@ ![Screenshot of a package's "Recent Versions" section. Underneath, the "View and manage all versions" link is highlighted with an orange outline.](/assets/images/help/package-registry/packages-recent-versions-manage-link.png) {% elsif ghes %} 1. Navigate to where you can manage versions for your type of package. - * **If your package is a container**, under the "Recent Versions" section, click **View and manage all versions**. + * _If your package is a container_, under the "Recent Versions" section, click **View and manage all versions**. ![Screenshot of a package's "Recent Versions" section. Underneath, the "View and manage all versions" link is highlighted with an orange outline.](/assets/images/help/package-registry/packages-recent-versions-manage-link.png) - * **For types of packages other than containers**: + * _For types of packages other than containers_: 1. On the right-hand side, click **{% octicon "gear" aria-hidden="true" %} Package settings**. ![Screenshot of a package's landing page. In the lower right corner, "Package settings" is highlighted with an orange outline.](/assets/images/help/package-registry/package-settings.png) 1. On the left click **Manage versions**. diff --git a/data/reusables/rest-api/always-check-your-limit.md b/data/reusables/rest-api/always-check-your-limit.md index eeb93475d8..b39c3241da 100644 --- a/data/reusables/rest-api/always-check-your-limit.md +++ b/data/reusables/rest-api/always-check-your-limit.md @@ -1,5 +1,5 @@ {% note %} -**Note**: You can confirm your current rate limit status at any time. For more information, see "[AUTOTITLE](/rest/overview/resources-in-the-rest-api#checking-your-rate-limit-status)." +You can confirm your current rate limit status at any time using the REST API. For more information, see "[AUTOTITLE](/rest/overview/resources-in-the-rest-api#checking-your-rate-limit-status)." {% endnote %} diff --git a/data/reusables/shortdesc/rate_limits_apps.md b/data/reusables/shortdesc/rate_limits_apps.md new file mode 100644 index 0000000000..20318fea78 --- /dev/null +++ b/data/reusables/shortdesc/rate_limits_apps.md @@ -0,0 +1 @@ +Rate limits restrict the rate of traffic to {% data variables.location.product_location %}, to help ensure consistent access for all users. diff --git a/data/reusables/shortdesc/rate_limits_github_apps.md b/data/reusables/shortdesc/rate_limits_github_apps.md deleted file mode 100644 index 499de3d2f5..0000000000 --- a/data/reusables/shortdesc/rate_limits_github_apps.md +++ /dev/null @@ -1 +0,0 @@ -Rate limits for {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} help control the rate of traffic to {% data variables.location.product_location %}. diff --git a/data/reusables/sponsors/add-introduction.md b/data/reusables/sponsors/add-introduction.md index d17925f3c4..5ee1fe8968 100644 --- a/data/reusables/sponsors/add-introduction.md +++ b/data/reusables/sponsors/add-introduction.md @@ -1,2 +1 @@ -1. Under "Introduction", type a description of the work you'll do with your sponsorships. - ![Profile details text field](/assets/images/help/sponsors/introduction-box.png) +1. In the "Introduction" section, type a description of the work you'll do with your sponsorships. diff --git a/data/reusables/sponsors/add-webhook.md b/data/reusables/sponsors/add-webhook.md index c2f60d1b2c..55e2e3fcad 100644 --- a/data/reusables/sponsors/add-webhook.md +++ b/data/reusables/sponsors/add-webhook.md @@ -1,2 +1 @@ 1. Click **Add webhook**. - ![Add webhook button in the Webhooks sidebar](/assets/images/help/sponsors/add-webhook-sponsors-button.png) diff --git a/data/reusables/sponsors/add-welcome-message.md b/data/reusables/sponsors/add-welcome-message.md index 36a31e251d..1f1527bdea 100644 --- a/data/reusables/sponsors/add-welcome-message.md +++ b/data/reusables/sponsors/add-welcome-message.md @@ -1,2 +1 @@ -1. Optionally, type a welcome message for the tier. - ![Add welcome message](/assets/images/help/sponsors/add-a-welcome-message.png) +1. Optionally, to add a welcome message for the tier, select **Display welcome message**, then type your message in the text field that appears. diff --git a/data/reusables/sponsors/billing-switcher.md b/data/reusables/sponsors/billing-switcher.md index 0388b53d7f..36a6ce8709 100644 --- a/data/reusables/sponsors/billing-switcher.md +++ b/data/reusables/sponsors/billing-switcher.md @@ -1,2 +1 @@ -1. Optionally, to manage your sponsorship on behalf of an organization, in the upper-left corner, use the **Personal settings** drop-down menu, and click the organization. - ![Drop-down menu to switch accounts for settings](/assets/images/help/sponsors/billing-account-switcher.png) +1. Optionally, to manage your sponsorship on behalf of an organization, in the upper-left corner, select the **Switch to another account** dropdown menu, then click the organization. diff --git a/data/reusables/sponsors/click-add-tier.md b/data/reusables/sponsors/click-add-tier.md index 3704234aef..918cea2ab0 100644 --- a/data/reusables/sponsors/click-add-tier.md +++ b/data/reusables/sponsors/click-add-tier.md @@ -1,2 +1 @@ 1. To create a monthly tier, click **Add a monthly tier** at the right of the page. Alternatively, to create a tier for one-time payments, click **One-time tiers** and then click **Add a one-time tier**. - ![Add a tier button](/assets/images/help/sponsors/add-a-tier-button.png) diff --git a/data/reusables/sponsors/confirm-add-webhook.md b/data/reusables/sponsors/confirm-add-webhook.md index 5f80821917..76dd7bfd4c 100644 --- a/data/reusables/sponsors/confirm-add-webhook.md +++ b/data/reusables/sponsors/confirm-add-webhook.md @@ -1,2 +1 @@ 1. Click **Create webhook**. -![Create webhook button in the Webhooks sidebar](/assets/images/help/sponsors/create-webhook-sponsors-button.png) diff --git a/data/reusables/sponsors/create-stripe-account.md b/data/reusables/sponsors/create-stripe-account.md index 3ac970e910..9e93ca95a9 100644 --- a/data/reusables/sponsors/create-stripe-account.md +++ b/data/reusables/sponsors/create-stripe-account.md @@ -1,3 +1,2 @@ 1. Click **Stripe Connect account**. - ![Link to create Stripe Connect account](/assets/images/help/sponsors/create-stripe-connect-account.png) -2. Follow the prompts to create your account. +1. Follow the prompts to create your account. diff --git a/data/reusables/sponsors/edit-featured-work.md b/data/reusables/sponsors/edit-featured-work.md index c2330af08b..6fc2589768 100644 --- a/data/reusables/sponsors/edit-featured-work.md +++ b/data/reusables/sponsors/edit-featured-work.md @@ -1,5 +1,3 @@ 1. Optionally, choose the repositories that are showcased on your {% data variables.product.prodname_sponsors %} profile. - - To the right of "Featured work", click **Edit**. - ![Edit button for featured work](/assets/images/help/sponsors/featured-work-edit-button.png) - - Select up to 6 repositories, then click **Save**. - ![Checkboxes to select repositories](/assets/images/help/sponsors/featured-work-select.png) + - In the "Featured work" section, to the right of the section title, click **Edit**. + - In the modal that appears, select up to six repositories, then click **Save**. diff --git a/data/reusables/sponsors/edit-goal.md b/data/reusables/sponsors/edit-goal.md index 5cc979fb98..9ea69b03ae 100644 --- a/data/reusables/sponsors/edit-goal.md +++ b/data/reusables/sponsors/edit-goal.md @@ -1,2 +1 @@ 1. To the right of your goal, click **Edit**. -![Edit button](/assets/images/help/sponsors/edit-goal-button.png) diff --git a/data/reusables/sponsors/edit-tier.md b/data/reusables/sponsors/edit-tier.md index 01cae1f27b..c7545922a6 100644 --- a/data/reusables/sponsors/edit-tier.md +++ b/data/reusables/sponsors/edit-tier.md @@ -1,2 +1 @@ 1. To the right of the tier you want to edit, click **Edit**. - ![Edit tier button](/assets/images/help/sponsors/edit-tier-button.png) diff --git a/data/reusables/sponsors/enable-custom-amounts.md b/data/reusables/sponsors/enable-custom-amounts.md deleted file mode 100644 index fd2a459a7c..0000000000 --- a/data/reusables/sponsors/enable-custom-amounts.md +++ /dev/null @@ -1,4 +0,0 @@ -1. When you have at least one tier, you'll see an option to enable custom amounts above the monthly and one-time tiers. If you want to allow sponsors to set their payment amount, then select **Enable custom amounts**. - ![Enable custom amounts](/assets/images/help/sponsors/enable-custom-amounts.png) -1. Optionally, if you enable custom amounts you can set a default amount to display for the custom tiers. Specify a whole dollar amount and click **Set default amount**. - ![Set a default amount](/assets/images/help/sponsors/set-default-amount.png) diff --git a/data/reusables/sponsors/manage-sponsorship.md b/data/reusables/sponsors/manage-sponsorship.md index 34b0a2b890..cb50384029 100644 --- a/data/reusables/sponsors/manage-sponsorship.md +++ b/data/reusables/sponsors/manage-sponsorship.md @@ -1,2 +1 @@ 1. To the right of your current tier, click **Manage**. - ![Manage your sponsorship button](/assets/images/help/sponsors/manage-your-sponsorship-button.png) diff --git a/data/reusables/sponsors/meet-the-team.md b/data/reusables/sponsors/meet-the-team.md index 21379ec5ed..e8e465af57 100644 --- a/data/reusables/sponsors/meet-the-team.md +++ b/data/reusables/sponsors/meet-the-team.md @@ -1,7 +1,5 @@ 1. Optionally, choose the organization members that are highlighted on your {% data variables.product.prodname_sponsors %} profile. - - To the right of "Meet the team", click **Edit**. - ![Edit organization members to profile button](/assets/images/help/sponsors/edit-org-members-profile-button.png) + - In the "Meet the team" section, to the right of the section title, click **Edit**. - Select up to six organization members, then click **Save**. ![Select highlighted organization members](/assets/images/help/sponsors/select-highlighted-org-members.png) - Optionally, under each highlighted member's name, type a description of the member. - ![Description for highlighted organization members](/assets/images/help/sponsors/description-highlighted-org-members.png) diff --git a/data/reusables/sponsors/navigate-to-payouts-tab.md b/data/reusables/sponsors/navigate-to-payouts-tab.md index 1f0a5c0b7c..baff3d5dfd 100644 --- a/data/reusables/sponsors/navigate-to-payouts-tab.md +++ b/data/reusables/sponsors/navigate-to-payouts-tab.md @@ -1,2 +1 @@ 1. On the left sidebar, click **Payouts**. - ![Sponsor tiers tab](/assets/images/help/sponsors/payouts-tab.png) diff --git a/data/reusables/sponsors/navigate-to-profile-tab.md b/data/reusables/sponsors/navigate-to-profile-tab.md index 2d8d992039..7962c83834 100644 --- a/data/reusables/sponsors/navigate-to-profile-tab.md +++ b/data/reusables/sponsors/navigate-to-profile-tab.md @@ -1,2 +1 @@ -1. On the left sidebar, click **Profile details**. - ![Profile details tab](/assets/images/help/sponsors/profile-tab.png) +1. In the "Profile" section in the left sidebar, click **Profile details**. diff --git a/data/reusables/sponsors/navigate-to-sponsors-dashboard.md b/data/reusables/sponsors/navigate-to-sponsors-dashboard.md index 2ebe7f6417..0599dcb904 100644 --- a/data/reusables/sponsors/navigate-to-sponsors-dashboard.md +++ b/data/reusables/sponsors/navigate-to-sponsors-dashboard.md @@ -1,4 +1,4 @@ 1. In the upper-right corner of any page, click your profile photo, then click **Your sponsors**. -![{% data variables.product.prodname_sponsors %} button](/assets/images/help/sponsors/access-github-sponsors-dashboard.png) -2. If a list of your sponsored and eligible accounts is shown, to the right of the account you want to manage, click **Dashboard**. -![Developer sponsors dashboard button](/assets/images/help/sponsors/dev-sponsors-dashboard-button.png) + + ![Screenshot of the profile options dropdown menu. One option, labeled "Your sponsors," is outlined in dark orange.](/assets/images/help/sponsors/access-github-sponsors-dashboard.png) +1. If a list of your sponsored and eligible accounts is shown, to the right of the account you want to manage, click **Dashboard**. diff --git a/data/reusables/sponsors/opt-in-to-being-featured.md b/data/reusables/sponsors/opt-in-to-being-featured.md index b34f2d60f4..bb62f9b493 100644 --- a/data/reusables/sponsors/opt-in-to-being-featured.md +++ b/data/reusables/sponsors/opt-in-to-being-featured.md @@ -1,2 +1 @@ -1. Optionally, select **Opt-in to potentially being featured on github.com/sponsors**. - ![Checkbox to opt-in to being featured](/assets/images/help/sponsors/opt-in-to-being-featured.png) +1. Optionally, select **Optional: Opt-in to get featured on github.com/sponsors**. diff --git a/data/reusables/sponsors/org-sponsored-choose-updates.md b/data/reusables/sponsors/org-sponsored-choose-updates.md deleted file mode 100644 index c88da9e0ec..0000000000 --- a/data/reusables/sponsors/org-sponsored-choose-updates.md +++ /dev/null @@ -1,2 +0,0 @@ -4. Decide whether you want to receive email updates from the sponsored organization, then select or unselect "Receive updates from _ORGANIZATION_." - ![Checkbox to receive updates from sponsored organization](/assets/images/help/sponsors/org-updates-checkbox-manage.png) diff --git a/data/reusables/sponsors/overview-tab.md b/data/reusables/sponsors/overview-tab.md index 93678650c2..402296a303 100644 --- a/data/reusables/sponsors/overview-tab.md +++ b/data/reusables/sponsors/overview-tab.md @@ -1,2 +1 @@ -1. In the left sidebar, click **Overview**. - ![Overview tab](/assets/images/help/sponsors/overview-tab.png) +1. At the top of the left sidebar, click **Overview**. diff --git a/data/reusables/sponsors/publish-goal.md b/data/reusables/sponsors/publish-goal.md index 67a50a44b7..c0300df74e 100644 --- a/data/reusables/sponsors/publish-goal.md +++ b/data/reusables/sponsors/publish-goal.md @@ -1,2 +1 @@ 1. Click **Publish**. -![Publish button](/assets/images/help/sponsors/publish-goal-button.png) diff --git a/data/reusables/sponsors/request-approval.md b/data/reusables/sponsors/request-approval.md index b69f427086..f4498ae9d8 100644 --- a/data/reusables/sponsors/request-approval.md +++ b/data/reusables/sponsors/request-approval.md @@ -1,2 +1 @@ 1. Click **Request approval**. - ![Request approval button](/assets/images/help/sponsors/request-approval-button.png) diff --git a/data/reusables/sponsors/retire-goal.md b/data/reusables/sponsors/retire-goal.md index 9268e2fda3..81e85d952c 100644 --- a/data/reusables/sponsors/retire-goal.md +++ b/data/reusables/sponsors/retire-goal.md @@ -1,4 +1,2 @@ 1. At the bottom of the page, click **Retire**. -![The Retire button](/assets/images/help/sponsors/retire-goal-button.png) -2. Read the warning, then click **OK**. -![Warning about retiring a goal](/assets/images/help/sponsors/confirm-retire-goal.png) +2. In the modal that appears, read the warning, then click **OK**. diff --git a/data/reusables/sponsors/retire-tier.md b/data/reusables/sponsors/retire-tier.md index c328e37a34..8bdcdd382f 100644 --- a/data/reusables/sponsors/retire-tier.md +++ b/data/reusables/sponsors/retire-tier.md @@ -1,2 +1 @@ -7. To retire a tier, click **Retire tier**, then click **OK**. - ![Retire tier button](/assets/images/help/sponsors/retire-tier-button.png) +1. To retire a tier, click **Retire tier**, then click **OK**. diff --git a/data/reusables/sponsors/review-and-publish-tier.md b/data/reusables/sponsors/review-and-publish-tier.md index be99804a56..b7519c942e 100644 --- a/data/reusables/sponsors/review-and-publish-tier.md +++ b/data/reusables/sponsors/review-and-publish-tier.md @@ -1,2 +1 @@ 1. Proofread your tier, then click **Publish tier**. - ![Screenshot of new tier page with publish monthly tier button emphasized](/assets/images/help/sponsors/publish-tier-button.png) diff --git a/data/reusables/sponsors/save-tier-draft.md b/data/reusables/sponsors/save-tier-draft.md index a162b9aabf..57da64d4c3 100644 --- a/data/reusables/sponsors/save-tier-draft.md +++ b/data/reusables/sponsors/save-tier-draft.md @@ -1,2 +1 @@ 1. Click **Save draft**. - ![Save draft button](/assets/images/help/sponsors/save-tier-draft.png) diff --git a/data/reusables/sponsors/select-a-tier.md b/data/reusables/sponsors/select-a-tier.md index 8e87d104ba..fae75c897b 100644 --- a/data/reusables/sponsors/select-a-tier.md +++ b/data/reusables/sponsors/select-a-tier.md @@ -1,2 +1,3 @@ -1. To the right of the tier you want, click **Select**. If want to select a custom amount, enter the sponsorship amount before clicking "Select." - ![Select a tier box](/assets/images/help/sponsors/select-a-tier-box.png) +1. To the right of the tier you want, click **Select**. + + Alternatively, if you want to select a custom amount, enter the sponsorship amount in the text field provided, then click **Select**. diff --git a/data/reusables/sponsors/select-goal-type.md b/data/reusables/sponsors/select-goal-type.md index ad8d33f428..069c5a0e9a 100644 --- a/data/reusables/sponsors/select-goal-type.md +++ b/data/reusables/sponsors/select-goal-type.md @@ -1,7 +1,5 @@ -1. Under "What is your goal based on?", select **Number of monthly sponsors** or **Sponsorships a month**. -![Available goal types ](/assets/images/help/sponsors/select-goal-type.png) -2. Type the number of monthly sponsors you'd like to have, or the monthly amount you're aiming for. -3. Under "Describe your goal", type a description for your goal. -![Goal settings](/assets/images/help/sponsors/goal-settings.png) -5. If you chose a goal based on sponsorships per month, select "I understand that this will publicly display how much sponsorship funds I receive each month". +1. In the "What is your goal based on?" section, select **Number of monthly sponsors** or **Sponsorships a month**. +1. Type the number of monthly sponsors you'd like to have, or the monthly amount you're aiming for. +1. In the "Describe your goal" section, type a description for your goal. +1. If you chose a goal based on sponsorships per month, select "I understand that this will publicly display how much sponsorship funds I receive each month". ![Checkbox that you understand your sponsorships fund will be published](/assets/images/help/sponsors/sponsorships-published-checkbox.png) diff --git a/data/reusables/sponsors/select-sponsorship-billing.md b/data/reusables/sponsors/select-sponsorship-billing.md index 26b44ffe79..295a8e4da7 100644 --- a/data/reusables/sponsors/select-sponsorship-billing.md +++ b/data/reusables/sponsors/select-sponsorship-billing.md @@ -1 +1 @@ -4. Under "Billing information", review your payment details. Optionally, to change the payment details for your entire account on {% data variables.location.product_location %}, click **Edit**. Then, follow the prompts to complete the payment form. +4. In the "Billing information" and "Payment method" sections, review your payment details. Optionally, to change the payment details for your entire account on {% data variables.location.product_location %}, in the "Payment method" section, click **Edit**. Then, follow the prompts to complete the payment form. diff --git a/data/reusables/sponsors/sponsors-updates-tab.md b/data/reusables/sponsors/sponsors-updates-tab.md deleted file mode 100644 index 567293dc58..0000000000 --- a/data/reusables/sponsors/sponsors-updates-tab.md +++ /dev/null @@ -1,2 +0,0 @@ -3. In the left sidebar, click **Updates**. - ![Updates tab](/assets/images/help/sponsors/updates-tab.png) diff --git a/data/reusables/sponsors/sponsorship-dashboard.md b/data/reusables/sponsors/sponsorship-dashboard.md index 28013f0735..1c974bc733 100644 --- a/data/reusables/sponsors/sponsorship-dashboard.md +++ b/data/reusables/sponsors/sponsorship-dashboard.md @@ -2,7 +2,6 @@ - If you're sponsoring a personal account, under the user's name, click **Sponsoring**. ![Screenshot of the sidebar of @octocat's profile page. A button, labeled with a heart icon and "Sponsoring", is outlined in dark orange.](/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) + - If you're sponsoring an organization, to the right of the organization's name, click {% octicon "heart-fill" aria-label="" %} **Sponsoring**. 1. Optionally, to manage a sponsorship on behalf of an organization, on the right side of the page, use the **Sponsoring as** drop-down menu, and click the organization. ![Drop-down menu to choose the account you're sponsoring as](/assets/images/help/sponsors/sponsoring-as-drop-down-menu.png) diff --git a/data/reusables/sponsors/view-eligible-accounts.md b/data/reusables/sponsors/view-eligible-accounts.md index f561cb7271..1c38e7a6c9 100644 --- a/data/reusables/sponsors/view-eligible-accounts.md +++ b/data/reusables/sponsors/view-eligible-accounts.md @@ -1,2 +1 @@ 1. Click **Get sponsored**. - ![Screenshot of the Get sponsored button](/assets/images/help/sponsors/get-sponsored.png) diff --git a/lib/languages.js b/lib/languages.js index c52fa7ecc5..dbf5de521e 100644 --- a/lib/languages.js +++ b/lib/languages.js @@ -10,13 +10,13 @@ import path from 'path' dotenv.config() const possibleEnvVars = { - 'es-es': process.env.TRANSLATIONS_ROOT_ES_ES, 'zh-cn': process.env.TRANSLATIONS_ROOT_ZH_CN, - 'ja-jp': process.env.TRANSLATIONS_ROOT_JA_JP, + 'es-es': process.env.TRANSLATIONS_ROOT_ES_ES, 'pt-br': process.env.TRANSLATIONS_ROOT_PT_BR, - 'de-de': process.env.TRANSLATIONS_ROOT_DE_DE, - 'fr-fr': process.env.TRANSLATIONS_ROOT_FR_FR, 'ru-ru': process.env.TRANSLATIONS_ROOT_RU_RU, + 'ja-jp': process.env.TRANSLATIONS_ROOT_JA_JP, + 'fr-fr': process.env.TRANSLATIONS_ROOT_FR_FR, + 'de-de': process.env.TRANSLATIONS_ROOT_DE_DE, 'ko-kr': process.env.TRANSLATIONS_ROOT_KO_KR, }