diff --git a/docs/contributing/contributing-code/contributing-code-first-commit/first-commit-00-prerequisites/index.md b/docs/contributing/contributing-code/contributing-code-first-commit/first-commit-00-prerequisites/index.md index 2a134403f7..9af8e10c48 100644 --- a/docs/contributing/contributing-code/contributing-code-first-commit/first-commit-00-prerequisites/index.md +++ b/docs/contributing/contributing-code/contributing-code-first-commit/first-commit-00-prerequisites/index.md @@ -17,9 +17,9 @@ On our supported OSes using a package manager to install these dependencies is a ## Required installs -We recommend the usage of either GitHub Codespaces or dev containers to setup your development environment. Here are the links that provide more details: +We recommend the usage of dev containers to setup your development environment. Here are the links that provide more details: -- [Getting started - GitHub Codespaces](../contributing-code-prerequisites/README.md#github-codespaces) + - [Getting started - Dev Containers](../contributing-code-prerequisites/README.md#vs-code-and-dev-container) However, you can also install all tools locally. This is the list of core dependencies to install for the most common tasks. In general we expect all contributors to have all of these tools present: diff --git a/docs/contributing/contributing-code/contributing-code-first-commit/first-commit-01-development-tools/index.md b/docs/contributing/contributing-code/contributing-code-first-commit/first-commit-01-development-tools/index.md index 9069dff969..bf41422160 100644 --- a/docs/contributing/contributing-code/contributing-code-first-commit/first-commit-01-development-tools/index.md +++ b/docs/contributing/contributing-code/contributing-code-first-commit/first-commit-01-development-tools/index.md @@ -15,7 +15,7 @@ Alternatively, you can choose whichever editor you are most comfortable for work - [Visual Studio Code](https://code.visualstudio.com/) - [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go) -> 📝 **Tip** - If your are using GitHub Codespaces or Dev Containers, the Go extension is already installed for you. You find more details on these options in the [Repository Prerequisites](../contributing-code-prerequisites/README.md). +> 📝 **Tip** - If your are using Dev Containers, the Go extension is already installed for you. You find more details on these options in the [Repository Prerequisites](../contributing-code-prerequisites/README.md). Install both of these and then follow the steps in the *Quick Start* for the Go extension. diff --git a/docs/contributing/contributing-code/contributing-code-prerequisites/README.md b/docs/contributing/contributing-code/contributing-code-prerequisites/README.md index f592e98bdc..e25eb078dc 100644 --- a/docs/contributing/contributing-code/contributing-code-prerequisites/README.md +++ b/docs/contributing/contributing-code/contributing-code-prerequisites/README.md @@ -2,13 +2,13 @@ This page lists the prerequisites for working with the repository. In general, you have three options to get your development setup up and running: -- Remotely using GitHub Codespaces + - Using Visual Studio Code and dev containers - Locally by installing all prerequisites on your machine We will walk you through the options in the following sections. -> 📝 **Tip** - We recommend the usage of GitHub Codespaces or dev containers in Visual Studio Code as they are the most convenient way to get started. +> 📝 **Tip** - We recommend the usage of dev containers in Visual Studio Code as they are the most convenient way to get started. Depending on the task you need to perform, you may need to install more tools, but basic prerequisites should be sufficient for most contributors to get started. @@ -22,9 +22,9 @@ If you get stuck with any development setup option, please ask for help in our [ ## Development environment - setup options -The following sections describe the aforementioned alternatives of development setups in more detail. We recommend to use of _GitHub Codespaces_ or _dev containers_ in VS Code as they are the most convenient way to get started. +The following sections describe the aforementioned alternatives of development setups in more detail. We recommend use of _dev containers_ in VS Code as they are the most convenient way to get started. -### GitHub Codespaces + ### VS Code and Dev Container @@ -72,7 +72,7 @@ Once the container is up and running you can start with your contribution. Contributing to Radius requires several tools to get started. This section lists them grouped by their context -> 📝 **Tip** - If your are using [GitHub Codespaces](#github-codespaces) or [VS Code and Dev Container](#vs-code-and-dev-container), all these tools are already in place and available out-of-the-box. +> 📝 **Tip** - If your are using [VS Code and Dev Container](#vs-code-and-dev-container), all these tools are already in place and available out-of-the-box.