Skip to content
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

Repo sync #30624

Closed
wants to merge 8 commits into from
Closed
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
Binary file modified assets/images/help/writing/alerts-rendered.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ Network settings are excluded from the backup snapshot. After restoration, you m

1. Ensure maintenance mode is enabled on the primary instance and all active processes have completed. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
1. Stop replication on all replica nodes in a high-availability configuration. For more information, see "[AUTOTITLE](/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration#ghe-repl-stop)."
1. Provision a new {% data variables.product.product_name %} instance to use as a target for the restoration of your backup. For more information, see "[AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance)."
1. If {% data variables.location.product_location %} has {% data variables.product.prodname_actions %} enabled, you must configure the external storage provider for {% data variables.product.prodname_actions %} on the replacement instance. For more information, see "[AUTOTITLE](/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)."

### Starting the restore operation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ To use the script, fill in the placeholder environment variable values with the
# - Resource group
# - Network Security Group rules
# - Virtual network (vnet) and subnet
# - Network Settings with specified subnet and GitHub Enterprise databse ID
# - Network Settings with specified subnet and GitHub Enterprise database ID
#
# It also registers the `GitHub.Network` resource provider with the subscription,
# delegates the created subnet to the Actions service via the `GitHub.Network/NetworkSettings`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ When this option is selected, the certificate is validated to make sure:

You can establish role-based access control for users from your LDAP server by synchronizing {% data variables.product.prodname_ghe_server %} users and team membership against your established LDAP groups. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/creating-a-team#creating-teams-with-ldap-sync-enabled)."

LDAP sync does not create user accounts on {% data variables.location.product_location %}. For more information, see "[Viewing and creating LDAP users](#viewing-and-creating-ldap-users)."

{% note %}

**Note:** Using LDAP Synchronization with groups that exceed 1499 members may lead to team membership synchronization failures.
Expand All @@ -124,7 +126,7 @@ If you need help determining if modifying the `MaxValRange` is the right approac

{% endnote %}

To enable LDAP Sync, in your LDAP settings, select **Synchronize Emails**, **Synchronize SSH Keys**, or **Synchronize GPG Keys** .
To enable LDAP Sync, in your LDAP settings, select **Synchronize Emails**, **Synchronize SSH Keys**, or **Synchronize GPG Keys**.

After you enable LDAP sync, a synchronization job will run at the specified time interval to perform the following operations on each user account:

Expand Down Expand Up @@ -188,6 +190,8 @@ If disclosing such information is not desired, your company or organization shou

## Viewing and creating LDAP users

When you use LDAP, your instance creates a user account the first time someone successfully signs in using LDAP credentials. Alternatively, you can manually provision a user account.

You can view the full list of LDAP users who have access to your instance and provision new users.

{% data reusables.enterprise_site_admin_settings.sign-in %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ redirect_from:
- /admin/user-management/managing-dormant-users
- /admin/user-management/managing-users-in-your-enterprise/managing-dormant-users
intro: '{% data reusables.enterprise-accounts.dormant-user-activity-threshold %}'
permissions: "{% ifversion ghec or ghae %}Enterprise owners can manage dormant users for an enterprise.{% elsif ghes %}Site administrators can manage dormant users on a {% data variables.product.product_name %} instance.{% endif %}"
versions:
ghec: '*'
ghes: '*'
Expand Down Expand Up @@ -37,12 +38,14 @@ You can customize the dormancy threshold for {% data variables.location.product_

Dormancy applies to both enterprise members and outside collaborators.

{% ifversion ghes %}

## Viewing dormant users

{% data reusables.enterprise-accounts.viewing-dormant-users %}

{% data reusables.enterprise_site_admin_settings.access-settings %}
1. In the left sidebar, click **Dormant users**.{% ifversion ghes %}
1. In the left sidebar, click **Dormant users**.
1. To suspend all the dormant users in this list, at the top of the page, click **Suspend all**.

## Determining whether a user account is dormant
Expand All @@ -62,6 +65,7 @@ Dormancy applies to both enterprise members and outside collaborators.
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.options-tab %}
1. Under "Dormancy threshold", select the dropdown menu, and click the desired dormancy threshold.

{% endif %}

{% ifversion ghec %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ See these pages for details on how to authenticate when using the {% data variab

{% note %}

**Note:** [Rate limits for the REST API](/rest/overview/rate-limits-for-the-rest-api) apply to all {% data variables.product.prodname_marketplace %} API endpoints.
**Note:** [Rate limits for the REST API](/rest/using-the-rest-api/rate-limits-for-the-rest-api) apply to all {% data variables.product.prodname_marketplace %} API endpoints.

{% endnote %}
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,11 @@ If your enterprise does not use {% data variables.product.prodname_emus %}, you

### Accounts that consume a license on {% data variables.product.prodname_ghe_server %}

Each user account on {% data variables.product.prodname_ghe_server %} consumes a seat.
After a user successfully authenticates to a {% data variables.product.prodname_ghe_server %} instance for the first time, the user consumes a seat.

Suspended users are not counted when calculating the number of licensed users consuming seats. For more information, see "[Suspending and unsuspending users]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %}

Dormant users do occupy a seat license. As such, you can choose to suspend dormant users to release user licenses. For more information, see "[Managing dormant users]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %}
Dormant users do occupy a seat license. Administrators can suspend dormant users to free licenses. For more information, see "[Managing dormant users]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %}

{% endif %}

Expand Down
10 changes: 10 additions & 0 deletions content/contributing/style-guide-and-content-model/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,14 @@ Use italics to emphasize words or parts of a sentence. Use emphasis sparingly fo
- **Use:** _For types of packages other than containers_, to the right of the package version click **Delete**.
- **Avoid:** Next to _**Title**_, add a descriptive label for your new key.

## Error messages

When you include the text of an error message from a {% data variables.product.company_short %} product or interface in an article, format the text according to the interface where the message appears.

- If the message appears in {% data variables.product.prodname_dotcom %}'s web interface, or in a graphical client app like {% data variables.product.prodname_desktop %} or {% data variables.product.prodname_mobile %}, treat the message like other text in the UI. For more information, see "[User interface text](#user-interface-text)."

- If the message appears in a command-line interface, log output, or a response from an API, reproduce the text exactly and use backticks to format the message using a monospaced font.

## Footnotes

Avoid using footnotes where possible. Consider instead whether you could use a [callout](#callouts) or present the information in another way. See some [examples of alternatives to footnotes from NICE.org.uk](https://www.nice.org.uk/corporate/ecd6/chapter/footnotes).
Expand Down Expand Up @@ -841,6 +849,7 @@ A release note for a bug fix answers the following questions.
- Language like "fixed a bug..." or "fixed an issue..." is implied and unnecessary.
- To reduce repetition and unnecessary words, "now" is usually implied.
- To clarify actors and impact, avoid passive language when possible.
- If the release note includes an error message, format the message according to the guidance in "[Error messages](#error-messages)."

#### Examples of release notes for bug fixes

Expand Down Expand Up @@ -896,6 +905,7 @@ A release note for a known issue answers the following questions.

- To clarify actors and impact, avoid passive language when possible.
- To reduce repetition and unnecessary words, "now" is usually implied.
- If the release note includes an error message, format the message according to the guidance in "[Error messages](#error-messages)."
- If useful, include relevant links to GitHub Docs.
- Known issues are also a type of content on GitHub Docs. For more information, see "[AUTOTITLE](/contributing/style-guide-and-content-model/troubleshooting-content-type#known-issues)." If useful, write or link to more in-depth and contextually relevant content in the docs.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ On {% data variables.product.prodname_dotcom_the_website %}, you can use {% data
The following limitations apply to this beta release of {% data variables.product.prodname_copilot_chat_dotcom %}:

- {% data reusables.copilot.chat-limited-docset-availability %}
- Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Owners of organizations {% ifversion ghec %}or enterprises {% endif %} can index up to {% data variables.copilot.max-chat-indexed-repos %} repositories for each organization.
- Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Anyone who gets access to {% data variables.product.prodname_copilot_short %} from the organization that owns a repository can index that repository. Up to {% data variables.copilot.max-chat-indexed-repos %} repositories can be indexed for each organization.
- The quality of the results from {% data variables.product.prodname_copilot_chat_short %} may, in some situations, be degraded if very large files, or a large number of files, are used as a context for a question.

## Prerequisites
Expand Down Expand Up @@ -92,7 +92,7 @@ You can choose a specific context, such as a particular repository or a document

{% data variables.product.prodname_copilot_short %}'s ability to answer natural language questions like these in a repository context is improved when the repository has been indexed for semantic code search. The indexing status of the repository is displayed when you start a conversation that has a repository context.

If you are an organization owner{% ifversion ghec %}, or an enterprise owner,{% endif %} and the repository has not been indexed, an **Index this repository** button is displayed. Click this button to start the indexing process. You can index up to {% data variables.copilot.max-chat-indexed-repos %} repositories in an organization.
If you get access to {% data variables.product.prodname_copilot_short %} from the organization that owns the repository, and the repository has not been indexed, an **Index this repository** button is displayed. Click this button to start the indexing process. Up to {% data variables.copilot.max-chat-indexed-repos %} repositories can be indexed for each organization.

![Screenshot showing the 'Index this repository' button highlighted with a dark orange outline.](/assets/images/help/copilot/index-this-repo.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -344,39 +344,32 @@ Footnotes are not supported in wikis.

## Alerts

Alerts are an extension of the blockquote syntax that you can use to emphasize critical information. On {% data variables.product.product_name %}, they are displayed with distinctive colors and icons to indicate the importance of the content. Alert syntax is supported in:
- Issues
- Pull requests
- Markdown files
- Discussions
- Gists
- Wikis
- Releases
Alerts are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information. On {% data variables.product.product_name %}, they are displayed with distinctive colors and icons to indicate the significance of the content.

We recommend restricting the use of alerts to one or two per article to avoid overloading the reader. Consecutive alerts should be avoided.
Use alerts only when they are crucial for user success and limit them to one or two per article to prevent overloading the reader. Additionally, you should avoid placing alerts consecutively. Alerts cannot be nested within other elements.

Multiple types of alerts are available. You can add an alert with a special blockquote line that specifies the alert type, and then add the alert information in a standard blockquote immediately after.
To add an alert, use a special blockquote line specifying the alert type, followed by the alert information in a standard blockquote. Five types of alerts are available:

```markdown
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> Useful information that users should know, even when skimming content.

> [!TIP]
> Optional information to help a user be more successful.
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> Key information users need to know to achieve their goal.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Negative potential consequences of an action.
> Advises about risks or negative outcomes of certain actions.
```

Here are the rendered alerts.
Here are the rendered alerts:

![Screenshot of rendered Markdown alerts showing how Note, Tips, Important, Warning, and Caution render with different colored text and icons.](/assets/images/help/writing/alerts-rendered.png)
![Screenshot of rendered Markdown alerts showing how Note, Tip, Important, Warning, and Caution render with different colored text and icons.](/assets/images/help/writing/alerts-rendered.png)

{% endif %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ topics:
- API
redirect_from:
- /rest/overview/openapi-description
- /rest/overview/about-the-openapi-description-for-the-rest-api
---

## About OpenAPI
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ shortTitle: API Versions
intro: Learn how to specify which REST API version to use whenever you make a request to the REST API.
versions:
feature: api-date-versioning
redirect_from:
- /rest/overview/api-versions
---

## About API versioning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ shortTitle: Breaking changes
intro: Learn about breaking changes that were introduced in each REST API version.
versions:
feature: api-date-versioning
redirect_from:
- /rest/overview/breaking-changes
---

## About breaking changes in the REST API
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ redirect_from:
- /github/extending-github/getting-started-with-the-api
- /developers/overview/about-githubs-apis
- /rest/overview/about-githubs-apis
- /rest/overview/comparing-githubs-rest-api-and-graphql-api
versions:
fpt: '*'
ghes: '*'
Expand Down
19 changes: 19 additions & 0 deletions content/rest/about-the-rest-api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: About the REST API
intro: 'Learn more about the {% data variables.product.prodname_dotcom %} REST API and what you can do with it.'
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- API
children:
- /comparing-githubs-rest-api-and-graphql-api
- /api-versions
- /breaking-changes
- /about-the-openapi-description-for-the-rest-api
autogenerated: rest
---

<!-- Content after this section is automatically generated -->
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: You can authenticate to the REST API to access more endpoints and have a
redirect_from:
- /v3/auth
- /rest/overview/other-authentication-methods
- /rest/overview/authenticating-to-the-rest-api
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ title: Endpoints available for fine-grained personal access tokens
intro: 'Your {% data variables.product.pat_v2 %} can make requests to the following REST endpoints.'
versions:
feature: pat-v2
shortTitle: 'Endpoints for fine-grained PATs'
shortTitle: Endpoints for fine-grained PATs
autogenerated: github-apps
redirect_from:
- /rest/overview/endpoints-available-for-fine-grained-personal-access-tokens
---

<!-- The content of this page is rendered as a NextJS page component. -->
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ redirect_from:
- /v3/apps/available-endpoints
- /rest/reference/endpoints-available-for-github-apps
- /rest/overview/endpoints-available-for-github-apps
- /rest/overview/endpoints-available-for-github-app-installation-access-tokens
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Endpoints available for GitHub App user access tokens
shortTitle: Endpoints for GitHub App user tokens
intro: 'Your GitHub App can make requests to the following REST endpoints with a user access token.'
intro: Your GitHub App can make requests to the following REST endpoints with a user access token.
permissions: 'You can use a user access token to access these endpoints using your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)."'
versions:
fpt: '*'
Expand All @@ -12,6 +12,8 @@ topics:
- API
- GitHub Apps
autogenerated: github-apps
redirect_from:
- /rest/overview/endpoints-available-for-github-app-user-access-tokens
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: REST API overview
shortTitle: Overview
intro: 'Learn about resources, libraries, previews and troubleshooting for {% data variables.product.prodname_dotcom %}''s REST API.'
title: Authenticating to the REST API
shortTitle: Authentication
intro: 'Learn how to authenticate your REST API requests.'
versions:
fpt: '*'
ghes: '*'
Expand All @@ -10,25 +10,11 @@ versions:
topics:
- API
children:
- /comparing-githubs-rest-api-and-graphql-api
- /resources-in-the-rest-api
- /rate-limits-for-the-rest-api
- /api-versions
- /media-types
- /authenticating-to-the-rest-api
- /keeping-your-api-credentials-secure
- /troubleshooting-the-rest-api
- /libraries-for-the-rest-api
- /about-the-openapi-description-for-the-rest-api
- /issue-event-types
- /github-event-types
- /endpoints-available-for-github-app-installation-access-tokens
- /endpoints-available-for-github-app-user-access-tokens
- /endpoints-available-for-fine-grained-personal-access-tokens
- /permissions-required-for-github-apps
- /permissions-required-for-fine-grained-personal-access-tokens
- /breaking-changes
redirect_from:
- /developers/overview
---

Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
title: Keeping your API credentials secure
shortTitle: Keeping API credentials secure
intro: 'Follow these best practices to keep your API credentials and tokens secure.'
intro: Follow these best practices to keep your API credentials and tokens secure.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- API
redirect_from:
- /rest/overview/keeping-your-api-credentials-secure
---

## Choose an appropriate authentication method
Expand Down
Loading
Loading