Skip to content

Commit 027e97f

Browse files
committed
edit pass: microsoft-dev-box-docset-how-to
1 parent 9c7d73a commit 027e97f

File tree

5 files changed

+65
-69
lines changed

5 files changed

+65
-69
lines changed

articles/dev-box/how-to-manage-dev-box-definitions.md

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: how-to
1515

1616
A dev box definition is a Microsoft Dev Box Preview resource that specifies a source image, compute size, and storage size. You can use a source image from Azure Marketplace or a custom image from Azure Compute Gallery.
1717

18-
Depending on their task, development teams have different software, configuration, compute, and storage size requirements. You can create a new dev box definition to fulfill each team's needs. There's no limit to the number of dev box definitions that you can create, and you can use dev box definitions across multiple projects in a dev center.
18+
Depending on their task, development teams have different software, configuration, compute, and storage requirements. You can create a new dev box definition to fulfill each team's needs. There's no limit to the number of dev box definitions that you can create, and you can use dev box definitions across multiple projects in a dev center.
1919

2020
## Permissions
2121

@@ -37,7 +37,7 @@ When you're selecting an Azure Marketplace image, consider using an image that h
3737

3838
### Azure Compute Gallery
3939

40-
Azure Compute Gallery enables you to store and manage a collection of custom images. You can build an image to your dev team's exact requirements and store it in a gallery. To use the custom image while creating a dev box definition, attach the gallery to your dev center. TO learn how to attach a gallery, see [Configure Azure Compute Gallery](how-to-configure-azure-compute-gallery.md).
40+
Azure Compute Gallery enables you to store and manage a collection of custom images. You can build an image to your dev team's exact requirements and store it in a gallery. To use the custom image while creating a dev box definition, attach the gallery to your dev center. To learn how to attach a gallery, see [Configure Azure Compute Gallery](how-to-configure-azure-compute-gallery.md).
4141

4242
## Image versions
4343

@@ -50,85 +50,83 @@ When you select an image to use in your dev box definition, you must specify if
5050

5151
You can create multiple dev box definitions to meet the needs of your developer teams.
5252

53-
The following steps show you how to create a dev box definition using an existing dev center.
54-
55-
If you don't have an available dev center, follow the steps in [Quickstart: Configure the Microsoft Dev Box service](./quickstart-configure-dev-box-service.md) to create one.
53+
The following steps show you how to create a dev box definition by using an existing dev center. If you don't have an available dev center, follow the steps in [Quickstart: Configure Microsoft Dev Box](./quickstart-configure-dev-box-service.md) to create one.
5654

5755
1. Sign in to the [Azure portal](https://portal.azure.com).
5856

5957
1. In the search box, enter **dev center**. In the list of results, select **Dev centers**.
6058

61-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/discover-devcenter.png" alt-text="Screenshot showing a search for dev center from the Azure portal search box.":::
59+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/discover-devcenter.png" alt-text="Screenshot that shows a search for dev centers from the Azure portal search box.":::
6260

63-
1. Open the dev center in which you want to create the new dev box definition, and then select **Dev box definitions**.
61+
1. Open the dev center in which you want to create the dev box definition, and then select **Dev box definitions**.
6462

65-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/select-dev-box-definitions.png" alt-text="Screenshot showing the dev center overview page with Dev box definitions highlighted.":::
63+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/select-dev-box-definitions.png" alt-text="Screenshot that shows the dev center overview page and the menu item for dev box definitions.":::
6664

67-
1. On the Dev box definitions page, select **Create**.
65+
1. On the **Dev box definitions** page, select **Create**.
6866

69-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/create-dev-box-definition.png" alt-text="Screenshot of the list of existing dev box definitions with Create highlighted.":::
67+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/create-dev-box-definition.png" alt-text="Screenshot of the Create button and the list of existing dev box definitions.":::
7068

71-
1. On the Create dev box definition page, enter the following values:
69+
1. On the **Create dev box definition** pane, enter the following values:
7270

7371
|Name|Value|
7472
|----|----|
7573
|**Name**|Enter a descriptive name for your dev box definition. You can't change the dev box definition name after it's created. |
76-
|**Image**|Select the base operating system for the dev box. You can select an image from the Marketplace or from an Azure Compute Gallery. </br> If you're creating a dev box definition for testing purposes, consider using the **Visual Studio 2022 Enterprise on Windows 11 Enterprise + Microsoft 365 Apps 22H2** image or the **Visual Studio 2022 Pro on Windows 11 Enterprise + Microsoft 365 Apps 22H2**.|
77-
|**Image version**|Select a specific, numbered version to ensure all the dev boxes in the pool always use the same version of the image. Select **Latest** to ensure new dev boxes use the latest image available.|
74+
|**Image**|Select the base operating system for the dev box. You can select an image from Azure Marketplace or from Azure Compute Gallery. </br> If you're creating a dev box definition for testing purposes, consider using the **Visual Studio 2022 Enterprise on Windows 11 Enterprise + Microsoft 365 Apps 22H2** or **Visual Studio 2022 Pro on Windows 11 Enterprise + Microsoft 365 Apps 22H2** image.|
75+
|**Image version**|Select a specific, numbered version to ensure that all the dev boxes in the pool always use the same version of the image. Select **Latest** to ensure that new dev boxes use the latest image available.|
7876
|**Compute**|Select the compute combination for your dev box definition.|
7977
|**Storage**|Select the amount of storage for your dev box definition.|
8078

81-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/recommended-test-image.png" alt-text="Screenshot showing the Create dev box definition page.":::
79+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/recommended-test-image.png" alt-text="Screenshot that shows the pane for creating a dev box definition.":::
8280

83-
1. To create the dev box definition, select **Create**.
81+
1. To finish creating the dev box definition, select **Create**.
8482

8583
## Update a dev box definition
8684

87-
Over time, your needs for dev boxes will change. You may want to move from a Windows 10 base operating system to a Windows 11 base operating system, or increase the default compute specification for your dev boxes. Your initial dev box definitions may no longer be appropriate for your needs. You can update a dev box definition, so that new dev boxes will use the new configuration.
85+
Over time, your needs for dev boxes will change. You might want to move from a Windows 10 base operating system to a Windows 11 base operating system, or increase the default compute specification for your dev boxes. Your initial dev box definitions might no longer be appropriate for your needs. You can update a dev box definition so that new dev boxes will use the new configuration.
8886

89-
You can update the image, image version, compute, and storage settings for a dev box definition.
87+
You can update the image, image version, compute, and storage settings for a dev box definition:
9088

9189
1. Sign in to the [Azure portal](https://portal.azure.com).
9290

9391
1. In the search box, enter **dev center**. In the list of results, select **Dev centers**.
9492

95-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/discover-devcenter.png" alt-text="Screenshot showing a search for devcenter from the Azure portal search box.":::
93+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/discover-devcenter.png" alt-text="Screenshot that shows a search for dev centers in the Azure portal search box.":::
9694

97-
1. Open the dev center that contains the dev box definition you want to update, and then select **Dev box definitions**.
95+
1. Open the dev center that contains the dev box definition that you want to update, and then select **Dev box definitions**.
9896

99-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/select-dev-box-definitions.png" alt-text="Screenshot showing the dev center overview page with Dev box definitions highlighted.":::
97+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/select-dev-box-definitions.png" alt-text="Screenshot that shows the dev center overview page and the menu option for dev box definitions.":::
10098

101-
1. Select the dev box definition(s) you want to update and then select the edit button.
99+
1. Select the dev box definitions that you want to update, and then select the edit button.
102100

103-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/update-dev-box-definition.png" alt-text="Screenshot of the list of existing dev box definitions, with the edit button highlighted.":::
101+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/update-dev-box-definition.png" alt-text="Screenshot of the list of existing dev box definitions and the edit button.":::
104102

105-
1. On the Edit *dev box definition name* page, you can select a new image, change the image version, change the compute, or modify the storage available.
103+
1. On the page for editing a dev box definition, you can select a new image, change the image version, change the compute, or modify the available storage.
106104

107-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/update-dev-box-definition-page.png" alt-text="Screenshot of the edit dev box definition page.":::
105+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/update-dev-box-definition-page.png" alt-text="Screenshot of the page for editing a dev box definition.":::
108106

109-
1. When you have made your updates, select **Save**.
107+
1. Select **Save**.
110108

111109
## Delete a dev box definition
112110

113-
You can delete a dev box definition when you no longer want to use it. Deleting a dev box definition is permanent, and can't be undone. Dev box definitions can't be deleted if they are in use by one or more dev box pools.
111+
You can delete a dev box definition when you no longer want to use it. Deleting a dev box definition is permanent and can't be undone. Dev box definitions can't be deleted if one or more dev box pools are using them.
114112

115113
1. Sign in to the [Azure portal](https://portal.azure.com).
116114

117-
1. In the search box, enter **dev center**. In this list of results, select **Dev centers**.
115+
1. In the search box, enter **dev center**. In the list of results, select **Dev centers**.
118116

119-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/discover-devcenter.png" alt-text="Screenshot showing a search for devcenter from the Azure portal search box.":::
117+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/discover-devcenter.png" alt-text="Screenshot of a search for dev centers from the Azure portal search box.":::
120118

121119
1. Open the dev center from which you want to delete the dev box definition, and then select **Dev box definitions**.
122120

123-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/select-dev-box-definitions.png" alt-text="Screenshot showing the dev center overview page with Dev box definitions highlighted.":::
121+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/select-dev-box-definitions.png" alt-text="Screenshot of the dev center overview page and the menu item for dev box definitions.":::
124122

125-
1. Select the dev box definition you want to delete and then select **Delete**.
123+
1. Select the dev box definition that you want to delete, and then select **Delete**.
126124

127-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/delete-dev-box-definition.png" alt-text="Screenshot of the list of existing dev box definitions, with the one to be deleted selected.":::
125+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/delete-dev-box-definition.png" alt-text="Screenshot of a selected dev box definition and the Delete button.":::
128126

129127
1. In the warning message, select **OK**.
130128

131-
:::image type="content" source="./media/how-to-manage-dev-box-definitions/delete-warning.png" alt-text="Screenshot of the Delete dev box definition warning message.":::
129+
:::image type="content" source="./media/how-to-manage-dev-box-definitions/delete-warning.png" alt-text="Screenshot of the warning message about deleting a dev box definition.":::
132130

133131
## Next steps
134132

articles/dev-box/how-to-manage-dev-boxes.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: How to manage a dev box using the developer portal
2+
title: Manage a dev box by using the developer portal
33
titleSuffix: Microsoft Dev Box
4-
description: This article describes how to create, delete, and connect to Microsoft Dev Box dev boxes using the developer portal.
4+
description: Learn how to create, delete, and connect to Microsoft Dev Box Preview dev boxes by using the developer portal.
55
services: dev-box
66
ms.service: dev-box
77
author: RoseHJM
@@ -10,54 +10,50 @@ ms.date: 09/18/2022
1010
ms.topic: how-to
1111
---
1212

13+
# Manage a dev box by using the developer portal
1314

14-
# Manage a dev box using the developer portal
15-
You can pre-configure a dev box to manage all of your tools, services, source-code and pre-built binaries specific to your project so you can immediately start working. Dev box enables you to get started quickly with an environment that's ready to build on so you can run your app in minutes.
15+
You can preconfigure a dev box to manage all of your tools, services, source code, and prebuilt binaries specific to your project. Microsoft Dev Box Preview provides an environment that's ready to build on, so you can run your app in minutes.
1616

1717
## Permissions
1818

19-
As a dev box developer, you can:
20-
- Create, view, and delete dev boxes you create
21-
- View pools within a project
22-
- Connect to dev boxes
19+
As a dev box developer, you can:
2320

24-
## Create a dev box
21+
- Create, view, and delete dev boxes that you create.
22+
- View pools within a project.
23+
- Connect to dev boxes.
2524

26-
Create a dev box through the developer portal. You can create as many dev boxes as you need, however there are common ways to split up your workload.
25+
## Create a dev box
2726

28-
You could create a dev box for your front-end work and a separate dev box for your back-end work. You could also create multiple dev boxes for your back-end.
27+
Create a dev box through the developer portal. You can create as many dev boxes as you need, but there are common ways to split up your workload.
2928

30-
For example, say you were working on a bug. You could a separate dev box for the bug fix to work on the specific task, troubleshoot the issue and avoid poisoning your primary machine.
29+
You could create a dev box for your front-end work and a separate dev box for your back-end work. You could also create multiple dev boxes for your back end.
3130

31+
For example, say you're working on a bug. You could a separate dev box for the bug fix to work on the specific task and troubleshoot the issue without poisoning your primary machine.
3232

3333
[!INCLUDE [create a dev box](./includes/create-dev-box.md)]
3434

35-
3635
## Connect to a dev box
37-
Once you create your dev box, you can connect to it through the remote desktop app, or through the browser.
3836

39-
:::image type="content" source="./media/how-to-manage-dev-boxes/open-rdp-client.jpg" alt-text="Screenshot of dev box showing open an RDP client.":::
37+
After you create your dev box, you can connect to it through a Remote Desktop app or through a browser.
4038

41-
For most cases, use the remote desktop app when accessing a dev box. The remote desktop provides the highest performance and best user-experience for heavy workloads.
39+
:::image type="content" source="./media/how-to-manage-dev-boxes/open-rdp-client.jpg" alt-text="Screenshot of the option to open a dev box in an RDP client.":::
4240

43-
- [Quickstart: Use a remote desktop client to connect to a dev box](./quickstart-connect-to-dev-box-with-remote-desktop-app.md)
41+
For most cases, use the Remote Desktop app when you're accessing a dev box. Remote Desktop provides the highest performance and best user experience for heavy workloads. For more information, see [Quickstart: Use a Remote Desktop client to connect to a dev box](./quickstart-connect-to-dev-box-with-remote-desktop-app.md).
4442

45-
Use the browser for lighter workloads. When you access your dev box via your phone or chrome book, you can use the browser. The browser is useful for tasks such as a quick bug fix, or a pull request (PR) review.
46-
47-
- [Use a browser to connect to a dev box](./quickstart-create-dev-box.md#connect-to-a-dev-box)
43+
Use the browser for lighter workloads. When you access your dev box via your phone or computer, you can use the browser. The browser is useful for tasks such as a quick bug fix or a review of a GitHub pull request. For more information, see the [steps for using a browser to connect to a dev box](./quickstart-create-dev-box.md#connect-to-a-dev-box).
4844

4945
## Delete a dev box
46+
5047
When you no longer need a dev box, you can delete it.
5148

52-
There are many reasons why you might not need a dev box anymore. Maybe you're finished testing, or you finished working on a specific project within your product.
49+
There are many reasons why you might not need a dev box anymore. Maybe you finished testing, or you finished working on a specific project within your product.
5350

54-
You can delete dev boxes once you finish your tasks. Say you finished fixing your bug and merged your pull request. Now, you can delete your dev box and create new dev boxes to work on new items.
51+
You can delete dev boxes after you finish your tasks. Say you finished fixing your bug and merged your pull request. Now, you can delete your dev box and create new dev boxes to work on new items.
5552

56-
> [!NOTE]
57-
> Ensure that neither you, nor your team members need the dev box before deleting as dev boxes cannot be retrieved after deletion.
53+
> [!NOTE]
54+
> Ensure that neither you nor your team members need the dev box before deleting. You can't retrieve dev boxes after deletion.
5855
5956
[!INCLUDE [clean up resources](./includes/clean-up-resources.md)]
60-
6157

6258
## Next steps
6359

articles/dev-box/how-to-project-admin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.date: 10/12/2022
1010
ms.topic: how-to
1111
---
1212

13-
# Manage Microsoft Dev Box Preview projects
13+
# Provide access to projects for project admins
1414

1515
You can create multiple Microsoft Dev Box Preview projects in the dev center to align with each team's specific requirements. By using the built-in DevCenter Project Admin role, you can delegate project administration to a member of a team. Project admins can use the network connections and dev box definitions configured at the dev center level to create and manage dev box pools within their project.
1616

articles/dev-box/includes/clean-up-resources.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ ms.service: dev-box
88

99
1. Sign in to the [developer portal](https://aka.ms/devbox-portal).
1010

11-
1. For the dev box you want to delete, from the setting menu, select **Delete**.
12-
:::image type="content" source="../media/quickstart-create-dev-box/dev-portal-delete-dev-box.png" alt-text="Screenshot of the dev box Settings menu with the Delete option highlighted.":::
11+
1. For the dev box that you want to delete, from the **Actions** menu, select **Delete**.
12+
13+
:::image type="content" source="../media/quickstart-create-dev-box/dev-portal-delete-dev-box.png" alt-text="Screenshot of the dev box Actions menu with the Delete option.":::
1314

1415
1. To confirm the deletion, select **Delete**.
15-
:::image type="content" source="../media/quickstart-create-dev-box/dev-portal-delete-dev-box-confirm.png" alt-text="Screenshot of the Delete dev box confirmation message with the Delete button highlighted.":::
16+
17+
:::image type="content" source="../media/quickstart-create-dev-box/dev-portal-delete-dev-box-confirm.png" alt-text="Screenshot of the confirmation message about deleting a dev box.":::

0 commit comments

Comments
 (0)