Skip to content

Commit 87251ef

Browse files
isaacmbrownCopilotdocs-botmchammer01
authored
Add GHES-versioned section to Copilot docs (#63135)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
1 parent 1af247a commit 87251ef

8 files changed

Lines changed: 76 additions & 24 deletions

File tree

‎content/admin/github-copilot/copilot-cli/index.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎content/admin/github-copilot/index.md‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎content/admin/index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ children:
106106
- /enforcing-policies
107107
- /monitoring-activity-in-your-enterprise
108108
- /monitoring-and-managing-your-instance
109-
- /github-copilot
110109
- /managing-github-apps-for-your-enterprise
111110
- /managing-github-actions-for-your-enterprise
112111
- /configuring-packages
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: About GitHub Copilot on GitHub Enterprise Server
3+
shortTitle: About Copilot on GHES
4+
intro: 'Most {% data variables.product.prodname_copilot_short %} features require a presence on {% data variables.product.prodname_ghe_cloud %}, but some features are available on {% data variables.product.prodname_ghe_server %}.'
5+
versions:
6+
ghes: '*'
7+
contentType: concepts
8+
category:
9+
- Learn about Copilot
10+
---
11+
12+
If your enterprise is primarily hosted on {% data variables.product.prodname_ghe_server %}, you must take extra steps for your developers to use {% data variables.product.prodname_copilot %}.
13+
14+
{% data variables.product.prodname_copilot %} is available on {% data variables.product.github %}'s cloud-hosted platforms: {% data variables.product.prodname_dotcom_the_website %} and {% data variables.enterprise.data_residency_site %}.
15+
16+
* {% data variables.product.prodname_copilot_short %} licenses can **only** be assigned to users through one of these platforms. A {% data variables.product.prodname_copilot_short %} license is required for all {% data variables.product.prodname_copilot_short %} functionality, with the exception of local "bring your own key" (BYOK) setups.
17+
* Administrative features such as policies and managed settings are configured on these platforms.
18+
* {% data variables.product.prodname_copilot_short %} features, such as {% data variables.copilot.copilot_chat_short %}, are integrated into these platforms, and **not** into {% data variables.product.prodname_ghe_server %}.
19+
20+
However, if your enterprise is primarily hosted on {% data variables.product.prodname_ghe_server %}, your developers can still benefit from {% data variables.product.prodname_copilot %}. The following sections explain your options.
21+
22+
> [!IMPORTANT]
23+
> {% data variables.product.prodname_copilot %} documentation on this version of {% data variables.product.prodname_docs %} is limited to content that applies specifically to {% data variables.product.prodname_ghe_server %}. View documentation for usage and administration on the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/copilot) of the site.
24+
25+
## Assigning licenses on a cloud platform
26+
27+
Your {% data variables.product.prodname_enterprise %} license also entitles you to an enterprise account on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %}.
28+
29+
You can use your cloud-hosted enterprise account to assign {% data variables.product.prodname_copilot_short %} licenses to users and configure policies for {% data variables.product.prodname_copilot_short %}. Users will then be able to authenticate to their cloud account to use {% data variables.product.prodname_copilot_short %} in local clients such as {% data variables.copilot.copilot_cli_short %}.
30+
31+
{% data variables.product.prodname_copilot_short %} will have access to locally checked-out code and files. Users can configure their local [GitHub MCP server](https://github.com/github/github-mcp-server?tab=readme-ov-file#local-github-mcp-server) so that {% data variables.product.prodname_copilot_short %} can connect to your instance and perform actions like opening issues or pull requests.
32+
33+
If you enable license sync with {% data variables.product.prodname_github_connect %}, each individual will only consume one {% data variables.product.prodname_enterprise %} license, even with an account on both cloud and server. See [AUTOTITLE](/admin/configuring-settings/configuring-github-connect/about-github-connect).
34+
35+
## Using {% data variables.product.prodname_copilot_short %} in an air-gapped environment
36+
37+
Alternatively, you can configure {% data variables.copilot.copilot_cli_short %} to work with {% data variables.product.prodname_ghe_server %} in disconnected or air-gapped environments, without connecting to {% data variables.product.github %}'s cloud platforms or requiring a {% data variables.product.prodname_copilot_short %} license.
38+
39+
{% ifversion copilot-cli-ghes %}
40+
41+
An administrator configures a model provider for the instance, and users connect {% data variables.copilot.copilot_cli_short %} with their {% data variables.product.prodname_ghe_server %} credentials.
42+
43+
For more information, see [AUTOTITLE](/copilot/copilot-on-ghes/set-up-copilot-cli).
44+
45+
> [!NOTE]
46+
> This feature is in {% data variables.release-phases.technical_preview %} and subject to change.
47+
48+
{% else %}
49+
50+
To use this feature, upgrade your instance to **version 3.22 or later**, where this feature is available in {% data variables.release-phases.technical_preview %}.
51+
52+
{% endif %}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: '{% data variables.product.prodname_copilot %} on GitHub Enterprise Server'
3+
shortTitle: '{% data variables.product.prodname_copilot_short %} on GHES'
4+
intro: Specific documentation about using {% data variables.product.prodname_copilot %} in a server-hosted enterprise.
5+
versions:
6+
ghes: '*'
7+
redirect_from:
8+
- /admin/github-copilot
9+
- /admin/github-copilot/copilot-cli
10+
children:
11+
- about-copilot-on-ghes
12+
- set-up-copilot-cli
13+
---
14+

content/admin/github-copilot/copilot-cli/set-up-and-use-copilot-cli.md renamed to content/copilot/copilot-on-ghes/set-up-copilot-cli.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
2-
title: Set up and use GitHub Copilot CLI
3-
shortTitle: 'Set up and use {% data variables.copilot.copilot_cli_short %}'
2+
title: Set up GitHub Copilot CLI for GitHub Enterprise Server
3+
shortTitle: Set up {% data variables.copilot.copilot_cli_short %}
44
intro: Configure a model provider for your {% data variables.product.prodname_ghe_server %} instance, then connect {% data variables.copilot.copilot_cli_short %} clients to the instance.
55
allowTitleToDifferFromFilename: true
66
versions:
77
feature: copilot-cli-ghes
88
contentType: how-tos
9-
category:
10-
- Configure Copilot CLI
119
docsTeamMetrics:
1210
- copilot-cli
11+
redirect_from:
12+
- /admin/github-copilot/copilot-cli/set-up-and-use-copilot-cli
13+
category:
14+
- Manage Copilot for a team
1315
---
1416

1517
> [!NOTE]

‎content/copilot/get-started/about-github-copilot.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ You can start using {% data variables.product.prodname_copilot_short %} in sever
9292

9393
{% data reusables.copilot.plans.subscribe-for-enterprise %}
9494

95+
If you are on **{% data variables.product.prodname_ghe_server %}**, see [AUTOTITLE](/enterprise-server@latest/copilot/copilot-on-ghes/about-copilot-on-ghes).
96+
9597
## Control for organizations and enterprises
9698

9799
If you use {% data variables.product.prodname_copilot_short %} through an organization or enterprise, administrators decide how it can be used. They control which members have access, set policies for which features are available, exclude files that {% data variables.product.prodname_copilot_short %} shouldn't see, and review usage data and audit logs to understand how it's being used.

‎content/copilot/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ layout: discovery-landing
1212
heroImage: /assets/images/banner-images/hero-6
1313
versions:
1414
feature: copilot
15+
ghes: '*'
1516
children:
1617
- /get-started
1718
- /concepts
1819
- /how-tos
1920
- /reference
2021
- /tutorials
2122
- /responsible-use
23+
- /copilot-on-ghes
2224
contentType: landing
2325
includedCategories:
2426
- Learn about Copilot

0 commit comments

Comments
 (0)