Skip to content

repo sync #21182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ topics:
- Infrastructure
- Performance
---
## Enabling rate limits for {% data variables.product.prodname_enterprise_api %}
## Enabling rate limits for the {% data variables.product.prodname_enterprise_api %}

Enabling rate limits on {% data variables.product.prodname_enterprise_api %} can prevent overuse of resources by individual or unauthenticated users. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)."
Enabling rate limits on the {% data variables.product.prodname_enterprise_api %} can prevent overuse of resources by individual or unauthenticated users. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)."

{% ifversion ghes %}
You can exempt a list of users from API rate limits using the `ghe-config` utility in the administrative shell. For more information, see "[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-config)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ You can also use a command-line utility to configure the IP exception list. For

{% endif %}

## Scheduling maintenance mode with {% data variables.product.prodname_enterprise_api %}
## Scheduling maintenance mode with the {% data variables.product.prodname_enterprise_api %}

You can schedule maintenance for different times or dates with {% data variables.product.prodname_enterprise_api %}. For more information, see "[Management Console](/enterprise/user/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode)."
You can schedule maintenance for different times or dates with the {% data variables.product.prodname_enterprise_api %}. For more information, see "[Management Console](/enterprise/user/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode)."

## Enabling or disabling maintenance mode for all nodes in a cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To thoroughly test {% data variables.product.product_name %} and recreate an env
- Authentication, especially if you use an external authentication provider like SAML
- Integration with an external ticketing system
- Integration with a continuous integration server
- External scripts or software that use {% data variables.product.prodname_enterprise_api %}
- External scripts or software that use the {% data variables.product.prodname_enterprise_api %}
- External SMTP server for email notifications

## Setting up a staging instance
Expand Down
2 changes: 1 addition & 1 deletion content/admin/overview/about-the-github-enterprise-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ With the APIs, you can automate many administrative tasks. Some examples include
- Collect statistics about your enterprise. For more information, see "[Admin stats](/rest/reference/enterprise-admin#admin-stats)."
- Manage your enterprise account. For more information, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)."

For the complete documentation for {% data variables.product.prodname_enterprise_api %}, see [{% data variables.product.prodname_dotcom %} REST API](/rest) and [{% data variables.product.prodname_dotcom%} GraphQL API](/graphql).
For the complete documentation for the {% data variables.product.prodname_enterprise_api %}, see [{% data variables.product.prodname_dotcom %} REST API](/rest) and [{% data variables.product.prodname_dotcom%} GraphQL API](/graphql).
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ If you're wondering where the Terminal output above is coming from, it's written

## Troubleshooting

Here are a few common problems and some suggested solutions. If you run into any other trouble, you can ask for help or advice in the {% data variables.product.prodname_support_forum_with_url %}.
Here are a few common problems and some suggested solutions. If you run into any other trouble, you can ask for help or advice in the {% data reusables.support.prodname_support_forum_with_url %}.

* **Q:** When I try to install the Smee command-line client, I get the following error:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -714,7 +714,7 @@ end

## Troubleshooting

Here are a few common problems and some suggested solutions. If you run into any other trouble, you can ask for help or advice in the {% data variables.product.prodname_support_forum_with_url %}.
Here are a few common problems and some suggested solutions. If you run into any other trouble, you can ask for help or advice in the {% data reusables.support.prodname_support_forum_with_url %}.

* **Q:** My app isn't pushing code to GitHub. I don't see the fixes that RuboCop automatically makes!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ See "[Next steps](#next-steps)" for ideas about where you can go from here.

## Troubleshooting

Here are a few common problems and some suggested solutions. If you run into any other trouble, you can ask for help or advice in the {% data variables.product.prodname_support_forum_with_url %}.
Here are a few common problems and some suggested solutions. If you run into any other trouble, you can ask for help or advice in the {% data reusables.support.prodname_support_forum_with_url %}.

* **Q:** My server isn't listening to events! The Smee client is running in a Terminal window, and I'm sending events on GitHub.com by opening new issues, but I don't see any output in the Terminal window where I'm running the server.

Expand Down Expand Up @@ -234,5 +234,5 @@ Here are some ideas for what you can do next:
* When the bot successfully adds the label, show a message in the Terminal. (Hint: compare the `needs-response` label ID with the ID of the label in the payload as a condition for your message, so that the message only displays when the relevant label is added and not some other label.)
* Add a landing page to your app and hook up a [Sinatra route](https://github.com/sinatra/sinatra#routes) for it.
* Move your code to a hosted server (like Heroku). Don't forget to update your app settings with the new domain.
* Share your project or get advice in the {% data variables.product.prodname_support_forum_with_url %}{% ifversion fpt or ghec %}
* Share your project or get advice in the {% data reusables.support.prodname_support_forum_with_url %}{% ifversion fpt or ghec %}
* Have you built a shiny new app you think others might find useful? [Add it to GitHub Marketplace](/apps/marketplace/creating-and-submitting-your-app-for-approval/)!{% endif %}
2 changes: 1 addition & 1 deletion content/rest/scim.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The SCIM API is used by SCIM-enabled Identity Providers (IdPs) to automate provi

### Authenticating calls to the SCIM API

You must authenticate as an owner of a {% data variables.product.product_name %} organization to use its SCIM API. The API expects an [OAuth 2.0 Bearer](/developers/apps/authenticating-with-github-apps) token to be included in the `Authorization` header. You may also use a personal access token, but you must first [authorize it for use with your SAML SSO organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).
You must authenticate as an owner of a {% data variables.product.product_name %} organization to use its SCIM API. The API expects an [OAuth 2.0 Bearer](/developers/apps/authenticating-with-github-apps) token to be included in the `Authorization` header. If you use a personal access token for authentication, it must have the `admin:org` scope and you must also [authorize it for use with your SAML SSO organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).

### Mapping of SAML and SCIM data

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
You can also use {% data variables.product.prodname_enterprise_api %} to manage global webhooks. For a complete list of actions, see "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks)."
You can also use the {% data variables.product.prodname_enterprise_api %} to manage global webhooks. For a complete list of actions, see "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks)."
2 changes: 1 addition & 1 deletion data/reusables/support/help_resources.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
For questions, bug reports, and discussions about {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and API development, explore the {% data variables.product.prodname_support_forum_with_url %}. The discussions are moderated and maintained by {% data variables.product.company_short %} staff, but questions posted to the forum are not guaranteed to receive a reply from {% data variables.product.company_short %} staff.
For questions, bug reports, and discussions about {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and API development, explore the {% data reusables.support.prodname_support_forum_with_url %}. The discussions are moderated and maintained by {% data variables.product.company_short %} staff, but questions posted to the forum are not guaranteed to receive a reply from {% data variables.product.company_short %} staff.

Consider reaching out to [GitHub Support](https://support.github.com/) directly using the contact form for:
- guaranteed response from {% data variables.product.product_name %} staff
Expand Down
1 change: 1 addition & 0 deletions data/reusables/support/prodname_support_forum_with_url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[APIs and Integrations discussions on GitHub Community](https://github.com/orgs/community/discussions/categories/apis-and-integrations)
3 changes: 1 addition & 2 deletions data/variables/product.yml
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,7 @@ prodname_oauth_app: 'OAuth App'
prodname_oauth_apps: 'OAuth Apps'

# API and developer docs
prodname_enterprise_api: 'the {% ifversion ghes %}GitHub Enterprise Server{% elsif ghae %}GitHub AE{% endif %} APIs'
prodname_support_forum_with_url: '[APIs and Integrations discussions on GitHub Community](https://github.com/orgs/community/discussions/categories/apis-and-integrations)'
prodname_enterprise_api: '{% ifversion ghes %}GitHub Enterprise Server{% elsif ghae %}GitHub AE{% endif %} APIs'
prodname_unfurls: 'Content Attachments'

# Azure AD
Expand Down