From 7d3aa6dfda26799bddeaea5d6558746809a83c1a Mon Sep 17 00:00:00 2001 From: Amy Burns Date: Tue, 2 Nov 2021 19:20:32 -0400 Subject: [PATCH] Minor improvements to Codespaces docs (#22476) * adding about paragraph for visual studio content, giving other visual studio related links * crossing linking to forwarding ports guide * Adding some additional papercuts --- .../personalizing-codespaces-for-your-account.md | 2 +- .../developing-in-a-codespace.md | 2 ++ .../forwarding-ports-in-your-codespace.md | 2 +- .../using-codespaces-in-visual-studio-code.md | 9 ++++++++- content/codespaces/overview.md | 4 ++-- .../setting-up-your-dotnet-project-for-codespaces.md | 2 +- .../setting-up-your-java-project-for-codespaces.md | 2 +- .../setting-up-your-nodejs-project-for-codespaces.md | 2 +- .../setting-up-your-python-project-for-codespaces.md | 2 +- data/reusables/codespaces/about-port-forwarding.md | 2 +- data/reusables/codespaces/links-to-get-started.md | 1 + 11 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 data/reusables/codespaces/links-to-get-started.md diff --git a/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md b/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md index 4c035e4c66..fb6299d73c 100644 --- a/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md +++ b/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md @@ -14,7 +14,7 @@ topics: - Set up - Fundamentals product: '{% data reusables.gated-features.codespaces %}' -shortTitle: Personalize your account +shortTitle: Personalize your codespaces --- diff --git a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index 06517caaf1..29d0a8e09f 100644 --- a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -22,6 +22,8 @@ topics: {% data variables.product.prodname_codespaces %} provides you with the full development experience of {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %} +{% data reusables.codespaces.links-to-get-started %} + ![Codespace overview with annotations](/assets/images/help/codespaces/codespace-overview-annotated.png) 1. Side Bar - By default, this area shows your project files in the Explorer. diff --git a/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md index 411d0d81c5..ed01105cf3 100644 --- a/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ b/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md @@ -19,7 +19,7 @@ shortTitle: Forward ports Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on a particular port in your codespace, you can forward that port. This allows you to access the application from the browser on your local machine for testing and debugging. -When an application running inside a codespace prints output to the terminal that contains a localhost URL, such as `http://localhost:PORT` or `http://127.0.0.1:PORT`, the port is automatically forwarded. If you're using {% data variables.product.prodname_github_codespaces %} in the browser or in {% data variable.product.prodname_vscode %}, the URL string in the terminal is converted into a link that you can click to view the web page on your local machine. By default, {% data variables.product.prodname_codespaces %} forwards ports using HTTP. +When an application running inside a codespace prints output to the terminal that contains a localhost URL, such as `http://localhost:PORT` or `http://127.0.0.1:PORT`, the port is automatically forwarded. If you're using {% data variables.product.prodname_codespaces %} in the browser or in {% data variables.product.prodname_vscode %}, the URL string in the terminal is converted into a link that you can click to view the web page on your local machine. By default, {% data variables.product.prodname_codespaces %} forwards ports using HTTP. ![Automatic port forwarding](/assets/images/help/codespaces/automatic-port-forwarding.png) diff --git a/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md index cf6f84d6f5..3ec571164e 100644 --- a/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ b/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md @@ -18,10 +18,17 @@ shortTitle: Visual Studio Code --- +## About {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode %} + +You can use your local install of {% data variables.product.prodname_vscode %} to create, manage, work in, and delete codespaces. To use {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode %}, you need to install the {% data variables.product.prodname_github_codespaces %} extension. For more information on setting up Codespaces in {% data variables.product.prodname_vscode %}, see "[Prerequisites](#prerequisites)." + +By default, if you create a new codespace on {% data variables.product.prodname_dotcom_the_website %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode %}. For more information, see "[Setting your default editor for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces)." + +If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode %} extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)." ## Prerequisites -To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must sign into the {% data variables.product.prodname_github_codespaces %} extension. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later. +To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must install and sign into the {% data variables.product.prodname_github_codespaces %} extension with your {% data variables.product.product_name %} credentials. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later. Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode %} documentation. diff --git a/content/codespaces/overview.md b/content/codespaces/overview.md index 043dd161b3..3aa1fd900c 100644 --- a/content/codespaces/overview.md +++ b/content/codespaces/overview.md @@ -28,7 +28,7 @@ A codespace is a development environment that's hosted in the cloud. You can cus ## Using Codespaces -You can create a codespace from any branch or commit in your repository and begin developing using cloud-based compute resources. +You can create a codespace from any branch or commit in your repository and begin developing using cloud-based compute resources. {% data reusables.codespaces.links-to-get-started %} To customize the runtimes and tools in your codespace, you can create a custom configuration to define an environment (or _dev container_) that is specific for your repository. Using a dev container allows you to specify a Docker environment for development with a well-defined tool and runtime stack that can reference an image, Dockerfile, or docker-compose. This means that anyone using the repository will have the same tools available to them when they create a codespace. @@ -38,6 +38,6 @@ You can also personalize aspects of your codespace environment by using a public ## About billing for {% data variables.product.prodname_codespaces %} -For information on billing for {% data variables.product.prodname_codespaces %}, see "[Managing billing for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces)." +For information on pricing, storage, and usage for {% data variables.product.prodname_codespaces %}, see "[Managing billing for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces)." {% data reusables.codespaces.codespaces-spending-limit-requirement %} For information on how organizations owners and billing managers can manage the spending limit for {% data variables.product.prodname_codespaces %} for an organization, see "[Managing your spending limit for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)." diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md index 2325a7374a..ffa7251bdf 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md @@ -135,7 +135,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. - **Extensions** - These are extensions included by default. - **ms-dotnettools.csharp** - The Microsoft C# extension provides rich support for developing in C#, including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." - **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `dotnet restore`, you can do that here. - **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md index a8a3b72aac..7b2fdad704 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md @@ -113,7 +113,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. - **Extensions** - These are extensions included by default. - **Vscjava.vscode-java-pack** - The Java Extension Pack provides popular extensions for Java development to get you started. -- **forwardPorts** - Any ports listed here will be forwarded automatically. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." - **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. - **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md index 8b5a18b6c8..e8e9c2062b 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md @@ -107,7 +107,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. - **Extensions** - These are extensions included by default. - **Dbaeumer.vscode-eslint** - ES lint is a great extension for linting, but for JavaScript there are a number of great Marketplace extensions you could also include. -- **forwardPorts** - Any ports listed here will be forwarded automatically. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." - **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, you can do that here. - **remoteUser** - By default, you’re running as the vscode user, but you can optionally set this to root. diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md index 3383e2a889..47c32e220d 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md @@ -127,7 +127,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr - **Terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. - **Extensions** - These are extensions included by default. - **ms-python.python** - The Microsoft Python extension provides rich support for the Python language (for all actively supported versions of the language: >=3.6), including features such as IntelliSense, linting, debugging, code navigation, code formatting, refactoring, variable explorer, test explorer, and more. -- **forwardPorts** - Any ports listed here will be forwarded automatically. +- **forwardPorts** - Any ports listed here will be forwarded automatically. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." - **postCreateCommand** - If you want to run anything after you land in your codespace that’s not defined in the Dockerfile, like `pip3 install -r requirements`, you can do that here. - **remoteUser** - By default, you’re running as the `vscode` user, but you can optionally set this to `root`. diff --git a/data/reusables/codespaces/about-port-forwarding.md b/data/reusables/codespaces/about-port-forwarding.md index b574e292ca..d95e5c6b95 100644 --- a/data/reusables/codespaces/about-port-forwarding.md +++ b/data/reusables/codespaces/about-port-forwarding.md @@ -1 +1 @@ -You can forward ports in your codespace to test and debug your application. +You can forward ports in your codespace to test and debug your application. You can also manage the port protocol and share the port within your organization or publicly. diff --git a/data/reusables/codespaces/links-to-get-started.md b/data/reusables/codespaces/links-to-get-started.md new file mode 100644 index 0000000000..1bc8aa681b --- /dev/null +++ b/data/reusables/codespaces/links-to-get-started.md @@ -0,0 +1 @@ +To get started with {% data variables.product.prodname_codespaces %}, see "[Quickstart for {% data variables.product.prodname_codespaces %}](/codespaces/getting-started/quickstart)." To learn more about how {% data variables.product.prodname_codespaces %} works, see "[Deep dive into Codespaces](/codespaces/getting-started/deep-dive)." \ No newline at end of file