Skip to content

Commit a074f75

Browse files
add getting started page (#8)
Co-authored-by: Rakesh Lakshminarayana <rakesh.lakshminarayana@insight.com>
1 parent a8af171 commit a074f75

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

docs/01-Getting Started.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "Getting Started"
3+
slug: /getting-started
4+
---
5+
6+
Choose the exercise that best suits your interests and skill level.To complete the exercises, you will need an environment with GitHub Copilot and a supported IDE such as VS Code.
7+
8+
The following section provides instructions on setting up your environment. There may be additional setup steps required for specific exercises, so be sure to read the README file for the exercise you choose.
9+
10+
:::tip
11+
It is recommended to fork the repository to your GitHub account before starting the exercise. This will allow you to save your changes and track your progress. Navigate to the exercise repository and click the "Fork" button in the top right corner to create a copy in your GitHub account.
12+
:::
13+
14+
## Setting Up Your Environment
15+
16+
### Step 1: GitHub Copilot License
17+
18+
Check with your organization to see if you have a GitHub Copilot license available.
19+
20+
If you do not have a license, you can sign up for a trial [here](https://github.com/github-copilot/signup).
21+
22+
### Step 2: Setting Up Your IDE
23+
24+
**OPTION 1: Use your local computer**
25+
26+
The following IDEs are supported for GitHub Copilot:
27+
28+
- VSCode (Recommended)
29+
- Visual Studio
30+
- NeoVIM
31+
- JetBrains IDE
32+
33+
You can choose the IDE that suits your preference and install it on your local machine.
34+
35+
### Step 3: Install GitHub Copilot Extension
36+
37+
Install the GitHub Copilot extension for your chosen IDE:
38+
39+
- **VSCode**: [Install VSCode Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=vscode#installing-the-visual-studio-code-extension)
40+
- **Visual Studio**: [Install Visual Studio Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=visualstudio#installing-the-visual-studio-extension)
41+
- **NeoVIM**: [Install NeoVIM Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=neovim#installing-the-neovim-extension-on-macos)
42+
- **JetBrains IDE**: [Install JetBrains Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=jetbrains#installing-the-github-copilot-extension-in-your-jetbrains-ide)
43+
44+
:::tip
45+
If you encounter issues due to Firewall or VPN restrictions, contact your IT team to whitelist the GitHub Copilot extension. Troubleshooting information can be found [here](https://docs.github.com/en/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot).
46+
:::
47+
48+
**OPTION 2: Use CodeSpaces**
49+
50+
CodeSpaces is a cloud-based development environment that allows you to develop entirely in the cloud. You can use CodeSpaces to complete the exercises without installing any software on your local machine. Check with your organization if you have access to CodeSpaces and confirm if the lab exercises are supported in CodeSpaces.
51+
52+
You can find more information on how to use CodeSpaces [here](https://docs.github.com/en/codespaces/getting-started/quickstart).
53+
54+
### Step 4: Fork and Clone the Repository
55+
56+
1. **Fork the Repository**: Navigate to the exercise repository and fork it to your GitHub account.
57+
2. **Clone the Repository**: Clone the forked repository to your local machine using Git. If you are using CodeSpaces, you can open the repository directly in CodeSpaces.
58+
3. **Open in IDE**: Open the cloned repository in your chosen IDE.
59+
4. **Enable GitHub Copilot**: Ensure the GitHub Copilot extension is enabled and sign in to your GitHub account if required. Check the status bar in your IDE to confirm that GitHub Copilot is active.
60+
61+
### Step 5: Additional Setup
62+
63+
- Follow any additional setup mentioned in the README file of the exercise repository.

0 commit comments

Comments
 (0)