Skip to content

Commit a043a78

Browse files
author
Greg Van Liew
committed
Update images
1 parent 569d035 commit a043a78

9 files changed

+48
-22
lines changed

docs/ide/codespaces/codespaces-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Overview of GitHub Codespaces (Preview)
3-
description: Learn more about GitHub Codespaces and how it can help extend extend your development environment to the cloud.
3+
description: Learn more about GitHub Codespaces for Visual Studio and how it can help extend your development environment to the cloud.
44
ms.topic: overview
55
ms.date: 09/04/2020
66
author: TerryGLee
@@ -17,14 +17,14 @@ monikerRange: vs-2019
1717

1818
Welcome to Codespaces! We're glad you're here.
1919

20-
GitHub Codespaces provides you with a cloud-powered development environment for any activity, whether it's a long-term project, or a short-term task like reviewing a pull request. You can work with a codespace from within Visual Studio 2019 ([sign up for the Preview](https://aka.ms/vsfutures-signup)).
20+
GitHub Codespaces for Visual Studio provides you with a cloud-powered development environment for any activity, whether it's a long-term project, or a short-term task like reviewing a pull request. You can work with a codespace from within Visual Studio 2019 ([sign up for the public beta](https://github.com/features/codespaces)).
2121

22-
Additionally, GitHub Codespaces brings many of the benefits of DevOps, like repeatability and reliability—which have typically been reserved for production workloads—to a development environment. You can also personalize GitHub Codespaces so that the tools, processes, and configurations that you prefer and rely on are there, too.
22+
Additionally, GitHub Codespaces for Visual Studio brings many of the benefits of DevOps, like repeatability and reliability—which have typically been reserved for production workloads—to a development environment. You can also personalize GitHub Codespaces so that the tools, processes, and configurations that you prefer and rely on are there, too.
2323

2424
This document will explain key concepts and introduce Codespaces features. If you're looking to get started, check out [Use Visual Studio with a codespace](use-visual-studio-with-codespaces.md).
2525

2626
> [!IMPORTANT]
27-
> You must sign up for the [Private Preview](https://aka.ms/vsfutures-signup) to use Codespaces. This Private Preview release is not intended for use on production computers or for creating production code. For more information about Preview releases, see the [Visual Studio 2019 Preview release notes](/visualstudio/releases/2019/release-notes-preview/).
27+
> You must sign up for the limited [public beta](https://github.com/features/codespaces) to use GitHub Codespaces. During the beta period, GitHub does not make any guarantees about the availability of Codespaces. For more information about joining the beta, see [About Codespaces](https://docs.github.com/github/developing-online-with-codespaces/about-codespaces#joining-the-beta).
2828
2929
## Concepts and features
3030

Loading
Loading
Loading
Loading
Binary file not shown.
Loading
Loading

docs/ide/codespaces/use-visual-studio-with-codespaces.md

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Visual Studio with a codespace (Preview)
3-
description: Learn which Visual Studio IDE features work when you're connected to a codespace.
3+
description: Learn about using Visual Studio IDE with GitHub Codespaces for Visual Studio.
44
ms.topic: how-to
55
ms.date: 09/21/2020
66
author: gregvanl
@@ -15,16 +15,16 @@ monikerRange: vs-2019
1515

1616
# How to use Visual Studio with a codespace (Preview)
1717

18-
Visual Studio has great support for developing in GitHub Codespaces. You can create and connect to a codespace and have the full power of Visual Studio to work on your projects on a remote, hosted environment. Even though your source code and tools are in a codespace and your compilation and debugging is happening in the cloud, your development experience will feel as fast and friction-free as if you were working locally.
18+
Visual Studio has great support for developing in GitHub Codespaces for Visual Studio. You can create and connect to a codespace and have the full power of Visual Studio to work on your projects on a remote, hosted environment. Even though your source code and tools are in a codespace and your compilation and debugging is happening in the cloud, your development experience will feel as fast and friction-free as if you were working locally.
1919

2020
> [!NOTE]
21-
> This article specifically describe using Visual Studio when connected to Windows codespaces. You can learn about connecting with other clients to a codespace in the [Visual Studio Code](https://docs.github.com/github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code) or [in-browser editor](https://docs.github.com/en/github/developing-online-with-codespaces/developing-in-a-codespace) documentation.
22-
23-
## Creating a Windows codespace
21+
> This article specifically describe using Visual Studio when connected to GitHub Codespaces for Visual Studio. You can learn about connecting with other clients to a codespace in the [Visual Studio Code](https://docs.github.com/github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code) or [in-browser editor](https://docs.github.com/en/github/developing-online-with-codespaces/developing-in-a-codespace) documentation.
2422
2523
> [!NOTE]
2624
> If you don't have [Visual Studio 2019 Preview](https://aka.ms/vspreview) installed already, you can [download it from visualstudio.microsoft.com](https://aka.ms/vspreview).
2725
26+
## Creating a GitHub Codespaces for Visual Studio codespace
27+
2828
If you don't already have a GitHub codespace, you can create one from Visual Studio.
2929

3030
1. When you launch Visual Studio, the Start Window will show a **Connect to a codespace** button under "Get started".
@@ -35,27 +35,36 @@ If you don't already have a GitHub codespace, you can create one from Visual Stu
3535

3636
![Visual Studio sign in to GitHub](media/visual-studio-sign-in-to-github.png)
3737

38-
Once you click **Sign in to GitHub**, follow the online GitHub sign in workflow.
38+
Once you select **Sign in to GitHub**, follow the online GitHub sign in workflow.
3939

40-
3. If you've never created a codespace, you can start by clicking the **New codespace** button.
40+
3. If you've never created a codespace, you will be prompted to create one.
4141

42-
![Visual Studio New codespace button](media/visual-studio-new-codespace.png)
43-
44-
4. Under "Codespace details", you need to provide a **Repository URL**, which can be any valid GitHub or Azure DevOps repository URL. GitHub Codespaces will clone the specified repository into your codespace when it is created.
42+
Under "Codespace details", you need to provide a **Repository URL**, which can be any valid GitHub or Azure DevOps repository URL. GitHub Codespaces will clone the specified repository into your codespace when it is created.
4543

4644
You can also modify the **Instance Type** and **Suspend after** timeout via their dropdowns. Once you have set the codespace details, select the **Create and Connect** button.
4745

4846
![Visual Studio codespace details](media/visual-studio-codespace-details.png)
4947

50-
GitHub Codespaces will begin preparing the codespace and open Visual Studio, once it is ready.
48+
GitHub Codespaces will begin preparing the codespace and open Visual Studio, once the codespace is ready.
49+
50+
The codespace name will appear in the remote indicator in the menu bar.
51+
52+
![Visual Studio connected to eShopOnWeb repository codespace](media/visual-studio-eshoponweb-codespace.png)
53+
54+
4. Start using your codespace, just as you would working locally. Things to try:
55+
56+
- Browse source code.
57+
- Select a solution file, and build the solution (**Ctrl+Shift+B**).
58+
- Set a breakpoint in a source file and press **F5** to launch the application in the debugger.
59+
- Make changes and commit them to your repository.
5160

5261
<!-- TBD ### Create from github.com portal -->
5362

5463
## Connecting to a codespace
5564

56-
After you've created your codespace, you can open it directly from Visual Studio.
65+
After you've created your codespace, you can open your codespace directly from Visual Studio.
5766

58-
1. When you launch Visual Studio, the Start Window will show an option to Connect to a codespace.
67+
1. When you launch Visual Studio, the Start Window will show a **Connect to a codespace** button under "Get started".
5968

6069
![Visual Studio Start window with Connect to a codespace](media/visual-studio-start-window.png)
6170

@@ -65,30 +74,46 @@ After you've created your codespace, you can open it directly from Visual Studio
6574

6675
2. Select **Connect to a codespace**. You will be prompted to sign in to GitHub, if you haven't already.
6776

68-
3. You will then see all of your GitHub codespaces along with their details presented in the right panel.
77+
3. You will then see all of your GitHub codespaces, along with their details presented in the right panel.
6978

7079
![Visual Studio displaying available GitHub codespaces and details](media/visual-studio-connect-codespace.png)
7180

81+
Any codespaces cloning an Azure DevOps repository will only be visible here in Visual Studio and not on GitHub's Codespaces page.
82+
7283
4. Choose a codespace and select the **Connect** button. If the codespace has been suspended, it will be restarted and Visual Studio will open connected to that codespace.
7384

85+
The codespace name will appear in the remote indicator in the menu bar.
86+
87+
![Visual Studio connected to eShopOnWeb repository codespace](media/visual-studio-eshoponweb-codespace.png)
88+
89+
5. Start using your codespace, just as you would working locally. Things to try:
90+
91+
- Browse source code.
92+
- Select a solution file, and build the solution (**Ctrl+Shift+B**).
93+
- Set a breakpoint in a source file and press **F5** to launch the application in the debugger.
94+
- Make changes and commit them to your repository.
95+
7496
<!-- TBD ## Suspend a codespace -->
7597

7698
<!-- TBD ## Disconnect from a codespace -->
7799

78100
## Visual Studio features
79101

80-
Visual Studio provides a rich development experience when connecting to a codespace. You get the Visual Studio inner-loop tools you're familiar with to edit, debug, test, and version your source code as well as productivity features like project templates, rich code navigation, and IntelliSense. In the current GitHub Codespaces beta, some Visual Studio features may not have full support or may be initially missing. The following sections outline what you can expect with Visual Studio and the GitHub Codespaces beta and what you can look forward to in the future.
102+
Visual Studio provides a rich development experience when connecting to a codespace. You get the Visual Studio inner-loop tools you're familiar with to edit, debug, test, and version your source code as well as productivity features like project templates, rich code navigation, and IntelliSense. In the current GitHub Codespaces beta, some Visual Studio features may not have full support or may be initially missing. The following sections outline what you can expect with Visual Studio and the GitHub Codespaces beta and what you can look forward to in the future. This is **not meant to be an exhaustive list**, but to explain Visual Studio's general capabilities when connected to codespace.
81103

82104
> [!NOTE]
83105
> If there is a feature you are missing while using codespaces with Visual Studio, please let us know by opening an issue on https://developercommunity.visualstudio.com/. This helps us prioritize the most wanted features.
84106
107+
> [!NOTE]
108+
> The features described below are for Visual Studio and not the two other GitHub Codespaces clients, Visual Studio Code and the in-browser editor.
109+
85110
### Edit and navigation
86111

87112
You should notice little difference editing source code in a codespace as you get smart language features like IntelliSense, code navigation, and diagnostics and suggestions.
88113

89114
* Syntax highlighting and IntelliSense
90115
* Code navigation
91-
* Code formatting and cleanup
116+
* Code formatting
92117
* IntelliCode
93118
* Test Explorer
94119

@@ -139,8 +164,9 @@ Since you are working with the Visual Studio client connected to a remote enviro
139164

140165
Not yet available:
141166

142-
* NuGet Package Manager UI - NuGet command line is supported
143-
* Live Unit Testing
167+
* NuGet Package Manager UI - NuGet command line is supported.
168+
* Live Unit Testing - support in progress.
169+
* Microsoft Fakes, Code coverage, and Intellitest
144170
* Publishing - Publish to Azure through Git Actions is supported.
145171
* Third-party Visual Studio extensions
146172

0 commit comments

Comments
 (0)