8000 Merge pull request #33187 from github/repo-sync · github/docs@984aefb · GitHub
[go: up one dir, main page]
Skip to content

Commit 984aefb

Browse files 8000
docs-botdocs-bot
authored
Merge pull request #33187 from github/repo-sync
Repo sync
2 parents ad3f828 + a1cd6b2 commit 984aefb

23 files changed

+635
-668
lines changed

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,20 @@ For a full list of the features and functionality available on each {% data vari
3838

3939
## Getting access to {% data variables.product.prodname_copilot %}
4040

41-
You can access {% data variables.product.prodname_copilot %} as part of one of the following paid plans.
41+
You can access {% data variables.product.prodname_copilot %} as part of one of the following paid plans:
42+
43+
- **{% data variables.product.prodname_copilot_individuals_short %}** - Get access to {% data variables.product.prodname_copilot %} in an IDE, or on the command line, for your personal or independent use. You can <a href="https://github.com/github-copilot/signup?ref_cta=Copilot+trial&ref_loc=about+github+copilot&ref_page=docs" target="_blank"><span>try {% data variables.product.prodname_copilot %} for free</span></a> with a one-time 30-day trial. After the free trial, you will need a paid subscription for continued use. For more information, see "[AUTOTITLE](/copilot/copilot-individual/about-github-copilot-individual)."
44+
45+
If you're a verified student, teacher, or maintainer of a popular open source project, {% data variables.product.prodname_copilot %} is free to use. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)."
4246

43-
- **{% data variables.product.prodname_copilot_individuals_short %}** - Get access to {% data variables.product.prodname_copilot %} in an IDE, or on the command line, for your personal or independent use. For more information, see "[AUTOTITLE](/copilot/copilot-individual/about-github-copilot-individual)."
4447
- **{% data variables.product.prodname_copilot_business_short %}** - Access {% data variables.product.prodname_copilot %} as a member of an organization. Owners of the organization can manage access for individual members or for teams. For more information, see "[AUTOTITLE](/copilot/copilot-business/about-github-copilot-business)."
45-
- **{% data variables.product.prodname_copilot_enterprise_short %}** - In addition to accessing {% data variables.product.prodname_copilot_short %} in an IDE or on the command line, use {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}. This includes the ability to:
48+
- **{% data variables.product.prodname_copilot_enterprise_short %}** - Access {% data variables.product.prodname_copilot %} as a member of an enterprise. Enterprise owners can allow some or all organizations in the enterprise to access {% data variables.product.prodname_copilot %}. If an organization has access to {% data variables.product.prodname_copilot_short %}, owners of the organization can grant access to {% data variables.product.prodname_copilot_enterprise_short %} for some or all members of the organization. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)."
49+
50+
With {% data variables.product.prodname_copilot_enterprise_short %}, in addition to accessing {% data variables.product.prodname_copilot_short %} in an IDE or on the command line, you can use {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}. This includes the ability to:
4651

4752
- Chat with {% data variables.product.prodname_copilot_short %} to get help with your code, or to ask general tech-related questions.
4853
- Create tailored knowledge bases to use as the context for chat.
4954
- Generate automatic summaries of pull requests.
5055

51-
For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)."
52-
53-
{% data reusables.copilot.copilot-one-account-short %}
56+
> [!NOTE]
57+
> {% data reusables.copilot.copilot-one-account-short %}

‎content/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Configuring GitHub Copilot in your environment
3-
shortTitle: In your environment
3+
shortTitle: Copilot in your environment
44
intro: 'You can enable, configure, or disable {% data variables.product.prodname_copilot %} in a supported IDE.'
55
product: '{% data reusables.gated-features.copilot %}'
66
redirect_from:

‎content/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Configuring GitHub Copilot settings on GitHub.com
3+
shortTitle: Copilot on GitHub.com
34
intro: 'You can change your personal settings on {% data variables.product.prodname_dotcom_the_website %} to configure {% data variables.product.prodname_copilot %}''s behavior. This affects how {% data variables.product.prodname_copilot %} functions in any supported IDE you use.'
45
product: '{% data reusables.gated-features.copilot %}'
56
permissions: 'People with individual {% data variables.product.prodname_copilot %} subscriptions can configure their settings on {% data variables.product.prodname_dotcom_the_website %}.'
@@ -10,7 +11,6 @@ versions:
1011
redirect_from:
1112
- /github/copilot/about-github-copilot-telemetry
1213
- /github/copilot/github-copilot-telemetry-terms
13-
shortTitle: GitHub.com
1414
---
1515

1616
## About {% data variables.product.prodname_copilot %} settings on {% data variables.product.prodname_dotcom_the_website %}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ topics:
99
children:
1010
- /configuring-github-copilot-settings-on-githubcom
1111
- /configuring-github-copilot-in-your-environment
12+
- /installing-the-github-copilot-extension-in-your-environment
1213
- /configuring-network-settings-for-github-copilot
1314
---

‎content/c F438 opilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment.md

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
---
2+
title: Installing the GitHub Copilot extension in your environment
3+
shortTitle: Install Copilot extension
4+
intro: 'To use {% data variables.product.prodname_copilot_short %} in your preferred coding environment, you must install the {% data variables.product.prodname_copilot %} extension.'
5+
versions:
6+
feature: copilot
7+
defaultTool: vscode
8+
topics:
9+
- Copilot
10+
---
11+
12+
{% azure_data_studio %}
13+
14+
Installing the {% data variables.product.prodname_copilot %} extension in Azure Data Studio allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.
15+
16+
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
17+
18+
## Installing the {% data variables.product.prodname_copilot %} extension in Azure Data Studio
19+
20+
1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."
21+
22+
1. Make sure you have a compatible version of Azure Data Studio. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. See the [Azure Data Studio download page](https://docs.microsoft.com/sql/azure-data-studio/download-azure-data-studio) in the Azure Data Studio documentation.
23+
24+
1. Install the {% data variables.product.prodname_copilot %} extension in Azure Data Studio. See [Install the {% data variables.product.prodname_copilot %} extension](https://learn.microsoft.com/en-us/azure-data-studio/extensions/github-copilot-extension-overview#install-the-github-copilot-extension) in the Microsoft documentation.
25+
26+
1. If a popup window in Azure Data Studio prompts you to sign in to use {% data variables.product.prodname_copilot %}, click **Sign in to {% data variables.product.prodname_dotcom %}** and follow the instructions on screen.
27+
28+
- If you have previously authorized Azure Data Studio for your account on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_copilot %} will be automatically authorized.
29+
- If you don't get the prompt to authorize, you can view notifications by clicking the bell icon in the bottom panel of the Azure Data Studio window.
30+
31+
1. If you are following the authorization steps, in your browser, {% data variables.product.prodname_dotcom %} will request the necessary permissions for {% data variables.product.prodname_copilot %}. To approve these permissions, click **Authorize Azure Data Studio**.
32+
33+
{% endazure_data_studio %}
34+
35+
{% jetbrains %}
36+
37+
Installing the {% data variables.product.prodname_copilot %} extension in JetBrains IDEs allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.
38+
39+
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
40+
41+
## Installing the {% data variables.product.prodname_copilot %} plugin in your JetBrains IDE
42+
43+
The following procedure will guide you through installation of the {% data variables.product.prodname_copilot %} plugin in IntelliJ IDEA. Steps to install the plugin in another supported IDE may differ.
44+
45+
1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."
46+
47+
1. Make sure you have a JetBrains IDE that is compatible with {% data variables.product.prodname_copilot %}. {% data variables.product.prodname_copilot %} is compatible with the following IDEs:
48+
49+
- IntelliJ IDEA (Ultimate, Community, Educational)
50+
- Android Studio
51+
- AppCode
52+
- CLion
53+
- Code With Me Guest
54+
- DataGrip
55+
- DataSpell
56+
- GoLand
57+
- JetBrains Client
58+
- MPS
59+
- PhpStorm
60+
- PyCharm (Professional, Community, Educational)
61+
- Rider
62+
- RubyMine
63+
- RustRover
64+
- WebStorm
65+
66+
For more information, see the [JetBrains IDEs](https://www.jetbrains.com/products/) tool finder.
67+
68+
1. Install the {% data variables.product.prodname_copilot %} plugin for JetBrains. See [{% data variables.product.prodname_copilot %} plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot) in the JetBrains Marketplace.
69+
70+
1. After {% data variables.product.prodname_copilot %} is installed, click **Restart IDE**.
71+
72+
1. After your JetBrains IDE has restarted, click the **Tools** menu. Click **{% data variables.product.prodname_copilot %}**, then click **Login to {% data variables.product.prodname_dotcom %}**.
73+
74+
![Screenshot of the expanded "Tools" menu and "{% data variables.product.prodname_copilot %}" sub-menu. The "Login to {% data variables.product.prodname_dotcom %}" option is highlighted in blue.](/assets/images/help/copilot/jetbrains-tools-menu.png)
75+
76+
1. In the "Sign in to {% data variables.product.prodname_dotcom %}" dialog box, to copy the device code and open the device activation window, click **Copy and Open**.
77+
78+
![Screenshot of the "Sign in to {% data variables.product.prodname_dotcom %}" dialog. A device code is displayed above a button labeled "Copy and Open".](/assets/images/help/copilot/device-code-copy-and-open.png)
79+
80+
1. A device activation window will open in your browser. Paste the device code, then click **Continue**.
81+
82+
1. {% data variables.product.prodname_dotcom %} will request the necessary permissions for {% data variables.product.prodname_copilot %}. To approve these permissions, click **Authorize {% data variables.product.prodname_copilot %} Plugin**.
83+
84+
1. After the permissions have been approved, your JetBrains IDE will show a confirmation. To begin using {% data variables.product.prodname_copilot %}, click **OK**.
85+
86+
{% endjetbrains %}
87+
88+
{% vimneovim %}
89+
90+
Installing the {% data variables.product.prodname_copilot %} extension in Vim/Neovim allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.
91+
92+
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
93+
94+
## Installing the {% data variables.product.prodname_copilot %} extension in Vim/Neovim
95+
96+
{% data variables.product.prodname_dotcom %} recommends that you install the {% data variables.product.prodname_copilot %} plugin with Vim/Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install `github/copilot.vim`. For more information, see the [copilot.vim repository](https://github.com/github/copilot.vim).
97+
98+
1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."
99+
100+
1. Make sure you have a compatible version of Vim/Neovim installed. To use {% data variables.product.prodname_copilot %} in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above. See the [Vim](https://vimhelp.org/) / [Neovim documentation](https://neovim.io/doc/) and the [Node.js website](https://nodejs.org/en/).
101+
102+
1. Install {% data variables.product.prodname_copilot %} using the built-in plugin manager:
103+
104+
- For **Vim on macOS or Linux**, run the following command in the terminal.
105+
106+
```shell copy
107+
git clone https://github.com/github/copilot.vim \
108+
~/.vim/pack/github/start/copilot.vim
109+
```
110+
111+
- For **Vim on Windows**, run the following command in Git Bash:
112+
113+
```shell copy
114+
git clone https://github.com/github/copilot.vim.git \
115+
$HOME/vimfiles/pack/github/start/copilot.vim
116+
```
117+
118+
- For **Neovim on macOS or Linux**, run the following command in the terminal.
119+
120+
```shell copy
121+
git clone https://github.com/github/copilot.vim \
122+
~/.config/nvim/pack/github/start/copilot.vim
123+
```
124+
125+
- For **Neovim on Windows**, run the following command in Git Bash:
126+
127+
```shell copy
128+
git clone https://github.com/github/copilot.vim.git \
129+
$HOME/AppData/Local/nvim/pack/github/start/copilot.vim
130+
```
131+
132+
{% data reusables.copilot.config-enable-copilot-in-vimneovim %}
133+
134+
{% endvimneovim %}
135+
136+
{% visualstudio %}
137+
138+
Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vs %} allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.
139+
140+
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
141+
142+
## Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vs %}
143+
144+
1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."
145+
146+
1. Make sure you have a compatible version of {% data variables.product.prodname_vs %} installed. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have version 2022 17.6 or later of {% data variables.product.prodname_vs %} for Windows. Note that {% data variables.product.prodname_copilot_short %} is not currently available in {% data variables.product.prodname_vs %} for Mac. For more information, see "[Install {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio)" in the Microsoft documentation.
147+
148+
1. Install the {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %} See "[Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/visual-studio-github-copilot-install-and-states)" in the Microsoft documentation.
149+
150+
1. After installing the {% data variables.product.prodname_copilot %} extension, to enable {% data variables.product.prodname_copilot %}, ensure you have added your {% data variables.product.prodname_dotcom %} account to {% data variables.product.prodname_vs %}. For more information, see [Add your {% data variables.product.prodname_dotcom %} accounts to your {% data variables.product.prodname_vs %} keychain](https://learn.microsoft.com/en-us/visualstudio/ide/work-with-github-accounts) in the Microsoft documentation.
151+
152+
{% endvisualstudio %}
153+
154+
{% vscode %}
155+
156+
Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vscode %} allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type. It also automatically installs the {% data variables.product.prodname_copilot_chat %} extension, which allows you to chat with {% data variables.product.prodname_copilot_short %}.
157+
158+
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
159+
160+
## Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vscode %}
161+
162+
1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."
163+
164+
1. Install {% data variables.product.prodname_vscode %}. See the [{% data variables.product.prodname_vscode %} download page](https://code.visualstudio.com/Download).
165+
166+
1. Install the [{% data variables.product.prodname_copilot %} extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) in {% data variables.product.prodname_vscode %}. For detailed instructions, see "[Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/setup)" in the {% data variables.product.prodname_vscode %} documentation.
167+
168+
{% endvscode %}

‎content/copilot/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ introLinks:
1111
quickstart: /copilot/quickstart
1212
featuredLinks:
1313
startHere:
14-
- /copilot/using-github-copilot/getting-started-with-github-copilot
14+
- /copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor
1515
popular:
1616
- /billing/managing-billing-for-github-copilot/about-billing-for-github-copilot
1717
- /copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment

‎content/copilot/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ To use {% data variables.product.prodname_copilot %} in {% data variables.produc
5252
{% data reusables.copilot.create-js-file %}
5353
{% data reusables.copilot.type-function-header %}
5454
{% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. The exact suggestion may vary.
55-
{% data reusables.copilot.accept-suggestion %}
55+
1. {% data reusables.copilot.accept-suggestion %}
5656

5757
{% ifversion fpt %}
5858

@@ -150,7 +150,7 @@ As an enterprise owner, you must decide whether to allow all organizations in yo
150150

151151
## Next steps
152152

153-
{% data reusables.copilot.next-steps %}
153+
You successfully installed {% data variables.product.prodname_copilot %} and received your first suggestion, but that's just the beginning! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_copilot %}.
154154

155155
- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)": As an organization owner, learn how to grant access to {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or{% endif %} {% data variables.product.prodname_copilot_business_short %} in your organization.
156156
- "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot)": You've learned how to get your first suggestion in {% data variables.product.prodname_vscode %}. These guides show you how to set up and navigate the various functions of {% data variables.product.prodname_copilot %} across all of the supported environments.

‎content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Finding public code that matches GitHub Copilot suggestions
3-
shortTitle: Finding matching code
3+
shortTitle: Find matching code
44
intro: 'If you allow {% data variables.product.prodname_copilot %} to make suggestions that match publicly available code, you can see references to the matching code on {% data variables.product.prodname_dotcom_the_website %}.'
55
redirect_from:
66
- /early-access/copilot/code-referencing-in-github-copilot

0 commit comments

Comments
 (0)
0