Skip to content

Commit

Permalink
Merge pull request #7748 from microsoft/very-buzzard
Browse files Browse the repository at this point in the history
Refresh Copilot Setup and FAQ
  • Loading branch information
ntrogh authored Nov 7, 2024
2 parents 00574b2 + 8dbc48f commit f8af0bd
Show file tree
Hide file tree
Showing 10 changed files with 37 additions and 32 deletions.
21 changes: 13 additions & 8 deletions docs/copilot/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,25 +27,30 @@ Learn more about [billing for GitHub Copilot](https://docs.github.com/billing/ma

### My Copilot subscription is not detected in VS Code

- To use Copilot Chat in Visual Studio Code, you must be signed into Visual Studio Code with the same GitHub ID that has access to GitHub Copilot. If your Copilot subscription is associated with another GitHub account, you might have to sign out of your GitHub account and sign in with another account. Use the **Accounts** menu in the Activity bar for signing out of your current GitHub account.
- To use Copilot Chat in Visual Studio Code, you must be signed into Visual Studio Code with a GitHub ID that has access to GitHub Copilot. If your Copilot subscription is associated with another GitHub account, you might have to sign out of your GitHub account and sign in with another account. Use the **Accounts** menu in the Activity Bar for signing out of your current GitHub account.

- Verify that your Copilot subscription is still active in [GitHub Copilot settings](https://github.com/settings/copilot).

### How can I switch accounts for Copilot

To switch to another GitHub account for using Copilot, first sign out of your GitHub account in VS Code, and then sign in with another account.
To switch to another GitHub account for using Copilot:

1. Sign out of your current GitHub account in VS Code:
1. Open the Extensions view from the Activity Bar ( or use `kb(workbench.view.extensions)`) and enter *GitHub Copilot* in the search box.

Select the **Accounts** menu in the Activity Bar, and then select **Sign out** for the account you're currently signed in with for Copilot.
![Extensions view in VS Code, showing the GitHub Copilot extension.](images/faq/copilot-extensions.png)

![Accounts menu in VS Code, showing the option to sign out of the current GitHub account.](images/setup/vscode-accounts-menu-signout.png)
> [!NOTE]
> There are two Copilot extensions: GitHub Copilot and GitHub Copilot Chat.
1. Sign in to GitHub in VS Code:
1. For the **GitHub Copilot** extension, select the gear icon, and then select **Account Preferences**.

Select the **Accounts** menu in the Activity Bar, and then select **Sign in with GitHub to use GitHub Copilot**.
![Accounts menu in VS Code, showing the option to sign out of the current GitHub account.](images/faq/extension-account-preferences.png)

![Accounts menu in VS Code, showing the option to sign in with GitHub to use GitHub Copilot.](images/setup/vscode-accounts-menu.png)
1. From the Account Preferences Quick Pick, choose an existing account or select **Use a new account...** to sign in with a different GitHub account.

![Accounts menu in VS Code, showing the option to sign in with GitHub to use GitHub Copilot.](images/faq/account-preferences-quick-pick.png)

1. Repeat these steps for the **GitHub Copilot Chat** extension.

## General

Expand Down
3 changes: 3 additions & 0 deletions docs/copilot/images/faq/account-preferences-quick-pick.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/copilot/images/faq/copilot-extensions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/copilot/images/faq/extension-account-preferences.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/copilot/images/setup/command-center-open-chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions docs/copilot/images/setup/copilot-status-menu.png

This file was deleted.

3 changes: 0 additions & 3 deletions docs/copilot/images/setup/vscode-chat-view.png

This file was deleted.

This file was deleted.

24 changes: 9 additions & 15 deletions docs/copilot/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,12 @@ For an overview of what you can do with GitHub Copilot in VS Code, see the [GitH

## Step 1: Set up your GitHub Copilot subscription

If you want to use GitHub Copilot, you either need an active subscription for GitHub Copilot in your personal account, or you need to be assigned a seat in a subscription managed by an organization or enterprise.
If you want to use GitHub Copilot, you either need an active subscription for GitHub Copilot in your personal account, or you need to be assigned a seat in a subscription managed by an organization or enterprise. Learn more about [billing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot).

| Account type | Instructions |
| ------------ | ------------ |
| Personal account | Set up a subscription to **GitHub Copilot Individual** with your personal GitHub account. You can [activate a one-time 30-day trial to evaluate GitHub Copilot](https://github.com/github-copilot/signup).<br/><br/>If you didn't yet activate your free trial for Copilot, the GitHub Copilot extension notifies you in VS Code.<br/>![Copilot sign up notification in VS Code](images/setup/copilot-access-toast.png) |
| Member of an organization | You need to be assigned a seat by an organization owner.<br/><br/>You can request access to **GitHub Copilot Business** from the [GitHub Copilot settings](https://github.com/settings/copilot) for your personal account.<br/>![Screenshot of Copilot settings, showing how to request access from an organization.](images/setup/request-cfb-access-settings.png) |

Learn more about [billing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot).
| Personal account | Set up a subscription to **GitHub Copilot Individual** with your personal GitHub account. You can [activate a one-time 30-day trial to evaluate GitHub Copilot](https://github.com/github-copilot/signup).<br/><br/>If you didn't yet activate your free trial for Copilot, the GitHub Copilot extension notifies you in VS Code.<br/><br/>![Copilot sign up notification in VS Code](images/setup/copilot-access-toast.png) |
| Member of an organization | You need to be assigned a seat by an organization owner.<br/><br/>You can request access to **GitHub Copilot Business** from the [GitHub Copilot settings](https://github.com/settings/copilot) for your personal account.<br/><br/>![Screenshot of Copilot settings, showing how to request access from an organization.](images/setup/request-cfb-access-settings.png) |

## Step 2: Install the GitHub Copilot extension

Expand All @@ -35,7 +33,7 @@ When you install the GitHub Copilot extension, the [GitHub Copilot Chat](https:/

## Step 3: Sign in to GitHub

To use GitHub Copilot in Visual Studio Code, you must be signed into Visual Studio Code with the same GitHub account that has access to GitHub Copilot.
To use GitHub Copilot in Visual Studio Code, you must be signed into Visual Studio Code with a GitHub account that has access to GitHub Copilot.

If you didn't previously authorize VS Code in your GitHub account, you're prompted to sign in to GitHub in VS Code:

Expand All @@ -53,19 +51,15 @@ Now that you've signed up for GitHub Copilot and activated the extension, let's

1. Open Visual Studio Code.

1. Notice the GitHub Copilot icon in the status bar, which indicates that GitHub Copilot is active.

![Screenshot showing the VS Code status bar, highlighting the Copilot icon that indicates Copilot is active.](./images/setup/vscode-status-bar-copilot-active.png)

1. Select the GitHub Copilot icon to open the Copilot status.
1. Notice the GitHub Copilot icon next to the Command Center that gives you quick access to Copilot functionality in VS Code.

The GitHub Copilot status should show **Ready**.
![Screenshot showing the GitHub Copilot icon in the Command Center in VS Code.](./images/setup/copilot-chat-menu-command-center.png)

![Screenshot showing the GitHub Copilot status menu in VS Code, indicating that the Copilot status is ready.](./images/setup/copilot-status-menu.png)
1. Select the Copilot icon and select **Open Chat** to open the Chat view.

1. You should also see the Chat view in the Activity Bar, which you can use to chat with Copilot.
The Copilot Chat view should open in the Secondary Side Bar, where you can chat with Copilot.

![Screenshot showing the Chat view in the Activity Bar in VS Code.](./images/setup/vscode-chat-view.png)
![Screenshot showing the Chat view in the Activity Bar in VS Code.](./images/setup/command-center-open-chat.png)

## Sign out of GitHub Copilot

Expand Down

0 comments on commit f8af0bd

Please sign in to comment.