Skip to content

Commit b23cfe8

Browse files
committed
edits
1 parent c0088ed commit b23cfe8

File tree

7 files changed

+149
-45
lines changed

7 files changed

+149
-45
lines changed

content/manuals/projects/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ A project organizes your code and Docker artifacts into a single object. These a
4545
### Key features and benefits
4646

4747
- One-click project setup: Open a local folder or clone a Git repository and run your project instantly.
48-
- Minimal Docker expertise required: Ideal for both beginners and experienced engineers.
48+
- Minimal Docker expertise required: Ideal for both beginners and experienced developers.
4949
- Custom `run` commands for your projects: Define and store preconfigured `run` commands that are equivalent to running `docker compose up`.
50-
- Local & remote projects: Work on projects locally or sync artifacts to the cloud for cross-device access and easy collaboration.
50+
- Local and remote projects: Work on projects locally or sync artifacts to the cloud for cross-device access and easy collaboration.
5151

5252
{{< grid >}}

content/manuals/projects/about.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,41 @@ keywords: docker projects
55
weight: 10
66
---
77

8-
Docker Projects requires a Compose file (docker-compose.yml) to define your application's services, networks, and configurations. When you open a project, Docker Projects automatically detects the Compose file, allowing you to configure and run services with pre-set commands.
8+
Docker Projects requires a Compose file (`compose.yml`) to define your application's services, networks, and configurations. When you open a project, Docker Projects automatically detects the Compose file, allowing you to configure and run services with pre-set commands.
99

1010
By integrating with Docker Compose, Docker Projects ensures a consistent, easy-to-manage workflow for both individual developers and teams. Whether you're starting a new project, configuring it, or collaborating with a team, Docker Projects keeps the process simple.
1111

12+
Docker Projects works as follows:
13+
1214
1. Create or open a project. You can:
1315

1416
- Open a local project: Select a folder on your machine that contains your project code.
15-
- Clone a Git repository:Provide a repository URL and clone the project into a local directory.
17+
- Clone a Git repository: Provide a repository URL and clone the project into a local directory.
1618

17-
Once a project is opened, Docker Desktop detects the Compose file and prepares the project for execution.
19+
Once a project is opened, Docker Desktop detects the Compose file and prepares the project for execution.
1820

1921
2. Configure and run your project with pre-configured commands. These commands:
2022

2123
- Work like `docker compose up`, launching services based on the Compose file.
2224
- Can be customized with additional flags, multiple Compose files, and environment variables.
23-
- Allow pre-run tasks, such as executing scripts before starting the services.
25+
- Enable pre-run tasks, such as executing scripts before starting the services.
2426

25-
All of which means you can fine-tune your configurations without manually running complex CLI commands.
27+
All of which means you can fine-tune your configurations without manually running complex CLI commands.
2628

2729
3. Collaborate and share with teams. For projects linked to a Git repository, Docker Projects stores artifacts in the cloud, enabling easy collaboration:
2830

2931
- Work across devices: Open a project from any machine and instantly access stored configurations.
30-
- Share configurations: Team members can access predefined run commands, reducing setup time.
32+
- Share configurations: Team members can access pre-defined run commands, reducing setup time.
3133

32-
Collaboration is seamless—new developers can join a team, open a project, and start working without complex setup steps.
34+
Collaboration is easy — new developers can join a team, open a project, and start working without complex setup steps.
3335

3436
4. Manage and iterate. Once a project is up and running, Docker Projects makes it easy to monitor, update, and troubleshoot:
3537

3638
- View logs to debug issues and track service activity.
37-
- Edit configurations and run commands as requirements change.
39+
- Edit configurations and run commands as requirements change.
40+
41+
## What's next?
42+
43+
- [Learn how to open a new project](/manuals/projects/new.md)
44+
- [Explore common FAQs](/manuals/projects/faq.md)
45+

content/manuals/projects/edit.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,39 @@ weight: 40
99

1010
1. Open an existing project and ensure that it is stopped.
1111

12-
2. From the command dopdown menu, select **New run command**.
12+
2. From the command drop-down menu, select **New run command**.
1313

1414
3. Specify the following information for the run command:
1515

1616
> [!TIP]
1717
>
18-
> While configuring your run command, you can view the equivalent docker compose up command in the Run command section on the configuration page. You can also use this command to run your project from the command line. You can refer to the docker compose up reference documentation to learn more about the options you configure.
18+
> While configuring your run command, you can view the equivalent `docker compose up` command in the **Run command** section on the configuration page. You can also use this command to run your project from the command line. You can refer to the [`docker compose up` reference documentation](/reference/cli/docker/compose/up.md) to learn more about the options you configure.
1919
2020
- **Name**: Specify a name to identify the run command.
2121
- **Compose files**: Select one or more Compose files from your project.
2222
- **Flags**: Optionally, select one or more flags for your run command.
2323

2424
> [!TIP]
2525
>
26-
> While the --env-file flag isn't currently supported, you can specify environment variables in your Compose file, or use the Tasks option to run a script that sets your environment variables.
26+
> While the `--env-file` flag isn't currently supported, you can specify environment variables in your Compose file, or use the **Tasks** option to run a script that sets your environment variables.
2727
28-
- **Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by unchecking it.
29-
- **Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named set-vars.sh, you can specify bash set-vars.sh. Or, on Windows to run a script with cmd.exe named set-vars.bat, specify set-vars.bat. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
28+
- **Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by deselecing the checkbox.
29+
- **Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named `set-vars.sh`, you can specify bash `set-vars.sh`. Or, on Windows to run a script with `cmd.exe` named `set-vars.bat`, specify `set-vars.bat`. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
3030

3131
4. Select **Save changes**.
3232

33-
You can now select the new run command from the dropdown menu after opening the project.
33+
You can now select the new run command from the drop-down menu after opening the project.
3434

3535
## Edit a run command
3636

3737
1. Open an existing project and ensure that it is stopped.
38-
2. Select the run command you want to change from the command dropdown menu.
38+
39+
2. Select the run command you want to change from the command drop-down menu.
40+
3941
3. Select the **Edit** icon next to the **Run** button.
42+
4043
4. Specify your changes and then select **Save changes**.
44+
45+
## What's next?
46+
47+
- [Manage your projects](/manuals/projects/manage.md)

content/manuals/projects/manage.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ weight: 50
99

1010
1. Open a new or existing project.
1111

12-
2. Select a run command from the dropdown menu.
12+
2. Select a run command from the drop-down menu.
1313

1414
3. Select the **Run** button for the project or the **Play** button next to the service you'd like to run.
1515

@@ -21,14 +21,16 @@ weight: 50
2121

2222
## Remove a project from Docker Desktop
2323

24-
If a project is associated with a Git repository, you can remove it from Docker Desktop. When a project is deleted, you can no longer run the project from the **Projects** view, but its run configuration still exists remotely in the cloud.
24+
If a project is associated with a Git repository, you can remove it from Docker Desktop. When a project is deleted, you can no longer run the project from the **Projects** view, but its run configuration still exists remotely in the cloud.
2525

2626
This means that you can later [open the project](/manuals/projects/open.md#open-an-existing-remote-project) and associate it with the remote run configuration without having to specify the run command again.
2727
None of your local code is deleted when removing a project from Docker Desktop.
2828

2929
To remove a project from Docker Desktop:
30-
Sign in to Docker Desktop, and go to Projects.
31-
Select the options menu () next to the project, and then select Remove from Docker Desktop.
30+
31+
1. Sign in to Docker Desktop, and go to **Projects**.
32+
33+
2. Select the **More actions** menu next to the project, and then select **Remove from Docker Desktop**.
3234

3335
## Delete a project
3436

content/manuals/projects/open.md

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@ keywords: Docker, projects, docker deskotp, containerization, open, remote, loca
55
weight: 20
66
---
77

8+
> [!NOTE]
9+
>
10+
> In order to use Docker Projects, make sure you have enabled the **Access experimental features** setting on the **Features in development** tab.
11+
812
## New projects
913

10-
When you open a new or remote project, Docker Projects stores all your code and Docker artifacts locally. In order to run a project, it must be stored locally. In the Projects page in Docker Desktop, local projects display the local path under the project.
14+
In order to run a new project, it must be stored locally. In the **Projects** view in Docker Desktop, local projects display the local path under the project.
1115

1216
### Open a new local project
1317

@@ -17,30 +21,34 @@ To open a new project:
1721

1822
1. Sign in to Docker Desktop, and go to **Projects**.
1923

20-
2. Select one **Open a local folder**. This lets you select a local folder that contains at least your project’s code and a Compose file.
24+
2. Select **Open a local folder**. This lets you select a local folder that contains your project’s code and a Compose file.
2125

2226
> [!NOTE]
2327
>
2428
> A local folder can also be the folder of a Git repository that you have already cloned.
2529
2630
3. Configure your project by giving it a name and setting the owner, then select **Next**.
2731

32+
> [!NOTE]
33+
>
34+
> If you are part of a Docker organization you have the option to [share your project](share.md) with the organization.
35+
2836
4. Specify how to run your project by selecting **New run command**:
2937

3038
> [!TIP]
3139
>
32-
> While configuring your run command, you can view the equivalent docker compose up command in the Run command section on the configuration page. You can also use this command to run your project from the command line. You can refer to the docker compose up reference documentation to learn more about the options you configure.
40+
> While configuring your run command, you can view the equivalent `docker compose up` command in the **Run command** section on the configuration page. You can also use this command to run your project from the command line. You can refer to the [`docker compose up` reference documentation](/reference/cli/docker/compose/up.md) to learn more about the options you configure.
3341
3442
- **Name**: Specify a name to identify the run command.
3543
- **Compose files**: Select one or more Compose files from your project.
3644
- **Flags**: Optionally, select one or more flags for your run command.
3745

3846
> [!TIP]
3947
>
40-
> While the --env-file flag isn't currently supported, you can specify environment variables in your Compose file, or use the Tasks option to run a script that sets your environment variables.
48+
> While the `--env-file` flag isn't currently supported, you can specify environment variables in your Compose file, or use the **Tasks** option to run a script that sets your environment variables.
4149
42-
- **Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by unchecking it.
43-
- **Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named set-vars.sh, you can specify bash set-vars.sh. Or, on Windows to run a script with cmd.exe named set-vars.bat, specify set-vars.bat. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
50+
- **Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by deselecting the checkbox.
51+
- **Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named `set-vars.sh`, you can specify bash `set-vars.sh`. Or, on Windows to run a script with `cmd.exe` named `set-vars.bat`, specify `set-vars.bat`. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
4452

4553
5. Select **Save changes**.
4654

@@ -50,7 +58,7 @@ Your project is now ready to run.
5058

5159
The following steps prompt you to clone the Git repository for your project.
5260

53-
If you have already cloned the repository outside of Docker Projects, then you can open the project as a new project and Docker Projects will automatically detect and link the repository.
61+
If you have already cloned the repository outside of Docker Projects, then you can open the project as a new project and Docker Projects will automatically detect and link the repository.
5462

5563
To clone and open a remote project:
5664

@@ -64,22 +72,26 @@ To clone and open a remote project:
6472

6573
5. Configure your project by giving it a name and setting the owner, then select **Next**.
6674

75+
> [!NOTE]
76+
>
77+
> If you are part of a Docker organization you have the option to [share your project](share.md) with the organization.
78+
6779
6. Specify how to run your project by selecting **New run command**:
6880

6981
> [!TIP]
7082
>
71-
> While configuring your run command, you can view the equivalent docker compose up command in the Run command section on the configuration page. You can also use this command to run your project from the command line. You can refer to the docker compose up reference documentation to learn more about the options you configure.
83+
> While configuring your run command, you can view the equivalent `docker compose up` command in the **Run command** section on the configuration page. You can also use this command to run your project from the command line. You can refer to the [`docker compose up` reference documentation](/reference/cli/docker/compose/up.md) to learn more about the options you configure.
7284
7385
- **Name**: Specify a name to identify the run command.
7486
- **Compose files**: Select one or more Compose files from your project.
7587
- **Flags**: Optionally, select one or more flags for your run command.
7688

7789
> [!TIP]
7890
>
79-
> While the --env-file flag isn't currently supported, you can specify environment variables in your Compose file, or use the Tasks option to run a script that sets your environment variables.
91+
> While the `--env-file` flag isn't currently supported, you can specify environment variables in your Compose file, or use the **Tasks** option to run a script that sets your environment variables.
8092
81-
- **Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by unchecking it.
82-
- **Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named set-vars.sh, you can specify bash set-vars.sh. Or, on Windows to run a script with cmd.exe named set-vars.bat, specify set-vars.bat. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
93+
- **Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by deselecing the checkbox.
94+
- **Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named `set-vars.sh`, you can specify bash `set-vars.sh`. Or, on Windows to run a script with `cmd.exe` named `set-vars.bat`, specify `set-vars.bat`. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
8395

8496
7. Select **Save changes**.
8597

@@ -93,11 +105,17 @@ To clone and open a remote project:
93105

94106
### Open an existing remote project
95107

96-
In the Projects page in Docker Desktop, existing remote projects display No local copy under the project.
108+
In the **Projects** view in Docker Desktop, existing remote projects display **No local copy** under the project.
97109

98-
You’ll see remote projects when you remove a project from Docker Desktop, or access Docker Desktop from a new device after creating a project associated with a Git repository.
110+
You’ll see remote projects when you are new to the team and are accessing a shared project, remove a project from Docker Desktop, or access Docker Desktop from a new device after creating a project associated with a Git repository.
99111

100112
To open an existing remote project, you can choose between:
101113

102114
- Cloning the project into a local destination.
103115
- Linking to an existing folder where the project has already been cloned
116+
117+
## What's next?
118+
119+
- [View your project](/manuals/projects/view.md)
120+
- [Add or edit your run commands](/manuals/projects/edit.md)
121+
- [Manage your projects](/manuals/projects/manage.md)

content/manuals/projects/share.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,22 @@ keywords: TBD
66
weight: 60
77
---
88

9-
Incoming..
9+
Docker Projects makes it easy for teams to share, manage, and collaborate on containerized applications.
10+
11+
Collaboration is managed by associating a project with a Docker organization, and leveraging cloud-stored configurations. This allows team members to easily access and work on the same project without needing extensive manual setup.
12+
13+
Once a project is associated with an organization, other team members can access it by:
14+
15+
1. Signing into Docker Desktop and navigating to **Projects**.
16+
17+
2. Selecting the correct organization tab.
18+
19+
3. Selecting the project from the list of shared projects.
20+
21+
4. Cloning the project into a local destination.
22+
23+
## What's next
24+
25+
- [View your project](/manuals/projects/view.md)
26+
- [Add or edit your run commands](/manuals/projects/edit.md)
27+
- [Manage your projects](/manuals/projects/manage.md)

0 commit comments

Comments
 (0)