Create Copilot Getting started category (#56309)
Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: Evan Bonsignori <ebonsignori@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
This commit is contained in:
Siara
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: Setting up GitHub Copilot
|
||||
shortTitle: Set up
|
||||
intro: 'Learn how to set up {% data variables.product.prodname_copilot %}.'
|
||||
topics:
|
||||
- Copilot
|
||||
versions:
|
||||
feature: copilot
|
||||
children:
|
||||
- /setting-up-github-copilot-for-yourself
|
||||
- /setting-up-github-copilot-for-your-organization
|
||||
- /setting-up-github-copilot-for-your-enterprise
|
||||
redirect_from:
|
||||
- /copilot/setting-up-github-copilot
|
||||
---
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Setting up GitHub Copilot for your enterprise
|
||||
shortTitle: Set up for enterprise
|
||||
intro: 'Follow these steps to set up {% data variables.product.prodname_copilot %} in your enterprise.'
|
||||
permissions: Enterprise owners
|
||||
product: 'Enterprises with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/github-copilot-enterprise/enabling-github-copilot-enterprise-features
|
||||
- /copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise
|
||||
- /copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features
|
||||
- /copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise
|
||||
---
|
||||
|
||||
## 1. Enable {% data variables.product.prodname_copilot %} in your Enterprise through payment verification
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
1. Click the **{% octicon "check-circle" aria-hidden="true" aria-label="check-circle" %} Getting Started** tab.
|
||||
1. Under "Next steps", click **Verify your payment method**. This will enable {% data variables.product.prodname_copilot %} in your enterprise.
|
||||
|
||||
After you've completed these steps, you will be able to confirm that {% data variables.product.prodname_copilot %} is enabled in your enterprise's **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies** tab.
|
||||
|
||||
## 2. Set policies
|
||||
|
||||
Control which {% data variables.product.prodname_copilot_short %} features are available in your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise).
|
||||
|
||||
## 3. Set up networking (if necessary)
|
||||
|
||||
If your enterprise users connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot).
|
||||
|
||||
You may also need to install custom SSL certificates on your users' machines. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#installing-custom-certificates).
|
||||
|
||||
## 4. Grant access to organizations
|
||||
|
||||
Enable {% data variables.product.prodname_copilot_short %} for some or all organizations in your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise). Each organization owner can then grant {% data variables.product.prodname_copilot_short %} access to some or all of the members of their organization.
|
||||
|
||||
If your enterprise is on {% data variables.enterprise.data_residency_site %}, users must perform some additional setup to authenticate to their account from their development environment. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom).
|
||||
|
||||
## 5. Drive {% data variables.product.prodname_copilot_short %} adoption
|
||||
|
||||
Planning and implementing an effective enablement process is essential to drive adoption of {% data variables.product.prodname_copilot_short %} in your enterprise. See [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/driving-copilot-adoption-in-your-company).
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Setting up GitHub Copilot for your organization
|
||||
shortTitle: Set up for organization
|
||||
intro: 'Follow these steps to set up {% data variables.product.prodname_copilot %} in your organization.'
|
||||
permissions: Organization owners
|
||||
product: 'Organizations with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/copilot-business/enabling-and-setting-up-github-copilot-business
|
||||
- /copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business
|
||||
- /copilot/managing-copilot-business/enabling-and-setting-up-github-copilot-for-business
|
||||
- /copilot/managing-copilot-business/enabling-and-setting-up-github-copilot-business
|
||||
- /copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-organization
|
||||
---
|
||||
|
||||
## 1. Subscribe your organization to {% data variables.product.prodname_copilot %}
|
||||
|
||||
Set up a {% data variables.copilot.copilot_business_short %} plan for your organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization).
|
||||
|
||||
If your organization is part of an enterprise with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan, your enterprise owner can instead enable {% data variables.product.prodname_copilot_short %} for your organization. You can request access from your enterprise owner by going to [https://github.com/settings/copilot](https://github.com/settings/copilot) and requesting access under "Get Copilot from an organization."
|
||||
|
||||
## 2. Set policies
|
||||
|
||||
Control which {% data variables.product.prodname_copilot_short %} features are available in your organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization).
|
||||
|
||||
## 3. Set up networking (if necessary)
|
||||
|
||||
If your organization members connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot).
|
||||
|
||||
You may also need to install custom SSL certificates on your members' machines. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#-installing-custom-certificates).
|
||||
|
||||
## 4. Grant access to members
|
||||
|
||||
Enable {% data variables.product.prodname_copilot_short %} for some or all members of your organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization).
|
||||
|
||||
To help drive adoption of {% data variables.product.prodname_copilot_short %} in your organization, think about what teams or members are most excited about {% data variables.product.prodname_copilot_short %} or could benefit the most from {% data variables.product.prodname_copilot_short %}. You may want to enable {% data variables.product.prodname_copilot_short %} for those members before enabling {% data variables.product.prodname_copilot_short %} for your whole organization. This can help you discover blockers, demonstrate early success, and set your organization up for a successful {% data variables.product.prodname_copilot_short %} rollout.
|
||||
|
||||
{% data reusables.copilot.self-serve-license-link %}
|
||||
|
||||
If your organization is part of an enterprise on {% data variables.enterprise.data_residency_site %}, users must perform some additional setup to authenticate to their account from their development environment. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom).
|
||||
|
||||
## 5. Drive {% data variables.product.prodname_copilot_short %} adoption
|
||||
|
||||
Planning and implementing an effective enablement process is essential to drive adoption of {% data variables.product.prodname_copilot_short %} in your organization. See [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/driving-copilot-adoption-in-your-company).
|
||||
|
||||
## 6. Enhance the {% data variables.product.prodname_copilot_short %} experience
|
||||
|
||||
Enhance the {% data variables.product.prodname_copilot_short %} experience for your organization by:
|
||||
|
||||
* **Setting up knowledge bases** for use with {% data variables.copilot.copilot_chat_short %} _({% data variables.copilot.copilot_enterprise_short %} only)_. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-copilot-knowledge-bases).
|
||||
* **Installing {% data variables.copilot.copilot_extensions_short %}** to integrate other tools with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/installing-github-copilot-extensions-for-your-organization).
|
||||
* **Adding {% data variables.copilot.copilot_coding_agent %}** as a team member to work asynchronously on issues. See [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org).
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Setting up GitHub Copilot for yourself
|
||||
shortTitle: Set up for self
|
||||
intro: Follow these steps to start using Copilot.
|
||||
permissions: Individuals
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/setting-up-github-copilot/setting-up-github-copilot-for-yourself
|
||||
---
|
||||
|
||||
## 1. Get access to {% data variables.product.prodname_copilot %}
|
||||
|
||||
There are a few ways that you can get access to {% data variables.product.prodname_copilot %}:
|
||||
|
||||
* **Use {% data variables.copilot.copilot_free_short %}**. Get a limited experience of {% data variables.product.prodname_copilot_short %} with up to 2,000 code completion requests and 50 premium requests per month-no paid plan required. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free).
|
||||
|
||||
* **Sign up for a paid plan**. You can subscribe to either:
|
||||
|
||||
* **{% data variables.copilot.copilot_pro_short %}**, which includes a <a href="https://github.com/github-copilot/signup?ref_cta=Copilot+trial&ref_loc=about+github+copilot&ref_page=docs" target="_blank"><span>one-time 30-day free trial</span></a> and 300 monthly premium requests.
|
||||
* **{% data variables.copilot.copilot_pro_plus_short %}**, which includes 1,500 monthly premium requests and full access to all available models. [Subscribe to {% data variables.copilot.copilot_pro_plus_short %}](https://github.com/github-copilot/signup?ref_cta=Copilot+Pro%2B&ref_loc=subscriptions+page&ref_page=docs).
|
||||
|
||||
* **Use {% data variables.product.prodname_copilot_short %} through your organization or enterprise**. If you're part of an organization or enterprise with a {% data variables.product.prodname_copilot_short %} plan, you can request access at [https://github.com/settings/copilot](https://github.com/settings/copilot) under "Get {% data variables.product.prodname_copilot_short %} from an organization."
|
||||
|
||||
* **Verified students, teachers, or open source maintainers**. You may be eligible to use {% data variables.product.prodname_copilot_short %} for free. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer).
|
||||
|
||||
## 2. Install the {% data variables.product.prodname_copilot_short %} extension for your IDE
|
||||
|
||||
If you want to use {% data variables.product.prodname_copilot_short %} in your IDE, install the {% data variables.product.prodname_copilot_short %} extension for your IDE. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment).
|
||||
|
||||
## 3. Install the {% data variables.product.prodname_copilot_short %} extension for the command line
|
||||
|
||||
If you want to use {% data variables.product.prodname_copilot_short %} in the command line, install the {% data variables.product.prodname_copilot_short %} extension for the {% data variables.product.prodname_cli %}. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-github-copilot-in-the-cli).
|
||||
|
||||
## 4. Use {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %}
|
||||
|
||||
If you want to chat with {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %}, connect {% data variables.product.prodname_copilot_short %} with Terminal Chat in {% data variables.product.prodname_windows_terminal %} Canary. See [AUTOTITLE](/copilot/quickstart?tool=windowsterminal).
|
||||
|
||||
## 5. Set up networking (if necessary)
|
||||
|
||||
If you connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot).
|
||||
|
||||
You may also need to install a custom SSL certificate on your machine. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#installing-custom-certificates).
|
||||
|
||||
## 6. Configure settings (optional)
|
||||
|
||||
All users can configure {% data variables.product.prodname_copilot_short %} settings in their IDE or in the CLI. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment) and [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-the-cli).
|
||||
|
||||
If you have your own {% data variables.product.prodname_copilot_short %} plan (instead of using your organization or enterprise's plan), you can:
|
||||
|
||||
* **Install {% data variables.copilot.copilot_extensions_short %}** to integrate other tools with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/installing-github-copilot-extensions-for-your-personal-account).
|
||||
* **Manage policies**. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber).
|
||||
|
||||
## 7. Start using {% data variables.product.prodname_copilot_short %}
|
||||
|
||||
Start using {% data variables.product.prodname_copilot_short %} to help you write code faster and more efficiently. For all the ways you can use {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/using-github-copilot). {% data variables.product.prodname_copilot_short %} code suggestions, {% data variables.copilot.copilot_chat_dotcom_short %}, and {% data variables.copilot.copilot_chat_short %} in your IDE are a great place to start.
|
||||
|
||||
To learn how to best use {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot) and [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat).
|
||||
Reference in New Issue
Block a user