From 28caf0b8e2dc79281f35461a875343d01eff1a35 Mon Sep 17 00:00:00 2001 From: Ahmed Youssef <98500446+ayoussef-insight@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:32:29 +1100 Subject: [PATCH] Refactor getting started page to improve IDE setup instructions and clarify repository forking process (#18) --- docs/01-Getting Started.md | 63 +++++++++++++++++++++++--------------- 1 file changed, 39 insertions(+), 24 deletions(-) diff --git a/docs/01-Getting Started.md b/docs/01-Getting Started.md index 8420bdf..6283496 100644 --- a/docs/01-Getting Started.md +++ b/docs/01-Getting Started.md @@ -23,52 +23,67 @@ Navigate to the exercise repository and click the "Fork" button in the top right ### Step 2: Setting Up Your IDE - **OPTION 1: Use your local computer** +You have two options to set up your IDE: - The following IDEs are supported for GitHub Copilot: +**OPTION 1: Use your local computer** - - VSCode (Recommended) - - Visual Studio - - NeoVIM - - JetBrains IDE +The following IDEs are supported for GitHub Copilot: - You can choose the IDE that suits your preference and install it on your local machine. +- VSCode (Recommended) +- Visual Studio +- NeoVIM +- JetBrains IDE -**OPTION 2: Use CodeSpaces** +You can choose the IDE that suits your preference and install it on your local machine. -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. +**OPTION 2: Use Codespaces** -Check with your organization if you have access to CodeSpaces and confirm if the lab exercises are supported in CodeSpaces. +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. -You can find more information on how to use CodeSpaces here - https://docs.github.com/en/codespaces/getting-started/quickstart +Check with your organization if you have access to Codespaces and confirm if the lab exercises are supported in Codespaces. + +You can find more information on how to use Codespaces here - https://docs.github.com/en/codespaces/getting-started/quickstart ![image](./images/474979958-8f0799d2-ec1f-4b8e-9f5a-16f8d0bc2611.png) ### Step 3: Install GitHub Copilot Extension - Install the GitHub Copilot extension for your chosen IDE: +Install the GitHub Copilot extension for your chosen IDE: - | IDE | Download Link | - |-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| - | **VSCode** | [VSCode Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=vscode#installing-the-visual-studio-code-extension) | - | **Visual Studio** | [Visual Studio Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=visualstudio#installing-the-visual-studio-extension) | - | **NeoVIM** | [NeoVIM Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=neovim#installing-the-neovim-extension-on-macos) | - | **JetBrains IDE** | [JetBrains Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=jetbrains#installing-the-github-copilot-extension-in-your-jetbrains-ide) | +| IDE | Download Link | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| **VSCode** | [VSCode Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=vscode#installing-the-visual-studio-code-extension) | +| **Visual Studio** | [Visual Studio Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=visualstudio#installing-the-visual-studio-extension) | +| **NeoVIM** | [NeoVIM Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=neovim#installing-the-neovim-extension-on-macos) | +| **JetBrains IDE** | [JetBrains Extension](https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=jetbrains#installing-the-github-copilot-extension-in-your-jetbrains-ide) | :::tip 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). ::: -### Step 4: Fork and Clone the Repository +### Step 4: Fork the Repository (Optional) + +If you have a github account and want to save your progress, you can fork the repository to your GitHub account: + +- Navigate to the exercise repository and fork it to your GitHub account, then clone the repository to your local machine. + +### Step 5: Clone the Repository -1. Navigate to the exercise repository and fork it to your GitHub account. -2. Clone the forked repository to your local machine using Git. If you are using CodeSpaces, you can open the repository directly in CodeSpaces. -3. Open the cloned repository in your chosen IDE. -4. 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. +1. Clone the repository or the forked repository to your local machine using git: + +In your terminal, run the following command to clone the repository to your local machine: +```bash +git clone https://github.com/GitHub-Insight-ANZ-Lab/github-copilot-labs-list.git +``` +:::tip +If you are using Codespaces, you can open the repository directly in Codespaces. +::: +2. Open the cloned repository in your chosen IDE. +3. 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. ![image](./images/574979958-8f0799d2-ec1f-4b8e-9f5a-16f8d0bc2622.png) -### Step 5: Additional Setup +### Step 6: Additional Setup - Follow any additional setup mentioned in the **README** file of the exercise repository.