Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Engdocs 2428 #22068

Merged
merged 11 commits into from
Mar 5, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
draft
  • Loading branch information
aevesdocker committed Feb 20, 2025
commit 2e9f5f99bbcaaeefc3c5093b4665c5c9b06921a0
45 changes: 12 additions & 33 deletions content/manuals/projects/_index.md
Original file line number Diff line number Diff line change
@@ -10,6 +10,10 @@
description: Learn how to use Docker Projects which provides a unified, project-based workflow to run your containerized projects.
keywords: Docker, projects, docker deskotp, containerization
grid:
- title: How Docker Projects works
description: Learn How Docker Projects works
icon: category
link: /projects/about/
- title: Open a new project
description: Learn how to open a new local or remote projects.
icon: checklist
@@ -22,6 +26,14 @@
description: Run or remove your projects.
icon: tune
link: /projects/manage/
- title: View your projects
description: View detailed information about your projects and services within your projects
icon: visibility
link: /projects/view/
- title: FAQs
description: View common FAQs about Docker Projects
icon: help
link: /projects/faq/
---

Docker Projects provides a simplified, project-based workflow for running and managing containerized applications. It organizes your code, configurations, and logs across local and cloud environments into a single view, making it easy to collaborate and share across teams.
@@ -30,42 +42,9 @@

### Key features and benefits

- One-click project setup: Open a local folder or clone a Git repository and run your project instantly.

Check warning on line 45 in content/manuals/projects/_index.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'select' instead of 'click' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'select' instead of 'click'", "location": {"path": "content/manuals/projects/_index.md", "range": {"start": {"line": 45, "column": 8}}}, "severity": "INFO"}
- Minimal Docker expertise required: Ideal for both beginners and experienced engineers.
- Custom `run` commands for your projects: Define and store preconfigured `run` commands that are equivalent to running `docker compose up`.

Check failure on line 47 in content/manuals/projects/_index.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'preconfigured'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'preconfigured'?", "location": {"path": "content/manuals/projects/_index.md", "range": {"start": {"line": 47, "column": 62}}}, "severity": "ERROR"}
- Local & remote projects: Work on projects locally or sync artifacts to the cloud for cross-device access and easy collaboration.

Check failure on line 48 in content/manuals/projects/_index.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.Spacing] ' ' should have one space. Raw Output: {"message": "[Docker.Spacing] ' ' should have one space.", "location": {"path": "content/manuals/projects/_index.md", "range": {"start": {"line": 48, "column": 28}}}, "severity": "ERROR"}

## How it works

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.

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.

1. Create or open a project. You can:

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

Once a project is opened, Docker Desktop detects the Compose file and prepares the project for execution.

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

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

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

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

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

Collaboration is seamless—new developers can join a team, open a project, and start working without complex setup steps.

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

- View logs to debug issues and track service activity.
- Edit configurations and run commands as requirements change.

{{< grid >}}
36 changes: 36 additions & 0 deletions content/manuals/projects/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: How it works
description: Understand how Docker Projects works
keywords: docker projects
---

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.

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.

1. Create or open a project. You can:

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

Once a project is opened, Docker Desktop detects the Compose file and prepares the project for execution.

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

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

Check warning on line 22 in content/manuals/projects/about.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'let' instead of 'Allow' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'let' instead of 'Allow'", "location": {"path": "content/manuals/projects/about.md", "range": {"start": {"line": 22, "column": 4}}}, "severity": "INFO"}

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

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

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

Collaboration is seamless—new developers can join a team, open a project, and start working without complex setup steps.

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

- View logs to debug issues and track service activity.
- Edit configurations and run commands as requirements change.
2 changes: 1 addition & 1 deletion content/manuals/projects/edit.md
Original file line number Diff line number Diff line change
@@ -2,20 +2,20 @@
title: Add or edit your run commands
description: Learn how to add or edit your run commands in Docker Projects
keywords: Docker, projects, docker deskotp, containerization, open, remote, local, run commands
weight: 20
weight: 30
---

## Add a run command to a project

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

2. From the command dopdown menu, select **New run command**.

Check failure on line 12 in content/manuals/projects/edit.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'dopdown'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'dopdown'?", "location": {"path": "content/manuals/projects/edit.md", "range": {"start": {"line": 12, "column": 21}}}, "severity": "ERROR"}

3. Specify the following information for the run command:

> [!TIP]
>
> 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.

Check failure on line 18 in content/manuals/projects/edit.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.Capitalization] Please capitalize Docker. Raw Output: {"message": "[Docker.Capitalization] Please capitalize Docker.", "location": {"path": "content/manuals/projects/edit.md", "range": {"start": {"line": 18, "column": 69}}}, "severity": "ERROR"}

Check failure on line 18 in content/manuals/projects/edit.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.Capitalization] Please capitalize Docker. Raw Output: {"message": "[Docker.Capitalization] Please capitalize Docker.", "location": {"path": "content/manuals/projects/edit.md", "range": {"start": {"line": 18, "column": 243}}}, "severity": "ERROR"}

- **Name**: Specify a name to identify the run command.
- **Compose files**: Select one or more Compose files from your project.
@@ -25,16 +25,16 @@
>
> 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.

- **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.

Check failure on line 28 in content/manuals/projects/edit.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'unchecking'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'unchecking'?", "location": {"path": "content/manuals/projects/edit.md", "range": {"start": {"line": 28, "column": 214}}}, "severity": "ERROR"}
- **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.

4. Select **Save changes**.

You can now select the new run command from the dropdown menu after opening the project.

Check warning on line 33 in content/manuals/projects/edit.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'drop-down' instead of 'dropdown' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'drop-down' instead of 'dropdown'", "location": {"path": "content/manuals/projects/edit.md", "range": {"start": {"line": 33, "column": 49}}}, "severity": "INFO"}

## Edit a run command

1. Open an existing project and ensure that it is stopped.
2. Select the run command you want to change from the command dropdown menu.

Check warning on line 38 in content/manuals/projects/edit.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'drop-down' instead of 'dropdown' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'drop-down' instead of 'dropdown'", "location": {"path": "content/manuals/projects/edit.md", "range": {"start": {"line": 38, "column": 63}}}, "severity": "INFO"}
3. Select the **Edit** icon next to the **Run** button.
4. Specify your changes and then select **Save changes**.
1 change: 1 addition & 0 deletions content/manuals/projects/faq.md
Original file line number Diff line number Diff line change
@@ -3,6 +3,7 @@
linkTitle: FAQs
description: Find common FAQs for Docker Projects
keywords: faqs, docker projects, local, remote
weight: 60
---

## Why is a Compose file required?
@@ -16,5 +17,5 @@

Without a Compose file, Docker Projects doesn't have a way to understand how your application should be structured or executed.

## What if my project doesn’t have a Compose file?

Check warning on line 20 in content/manuals/projects/faq.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.HeadingLength] Try to keep headings short (< 8 words). Raw Output: {"message": "[Docker.HeadingLength] Try to keep headings short (\u003c 8 words).", "location": {"path": "content/manuals/projects/faq.md", "range": {"start": {"line": 20, "column": 4}}}, "severity": "INFO"}

2 changes: 1 addition & 1 deletion content/manuals/projects/manage.md
Original file line number Diff line number Diff line change
@@ -2,14 +2,14 @@
title: Manage your projects
description: Learn how to delete or completely remove a project.
keywords: Docker, projects, docker deskotp, containerization, open, remote, local
weight: 30
weight: 40
---

## Run a project or service

1. Open a new or existing project.

2. Select a run command from the dropdown menu.

Check warning on line 12 in content/manuals/projects/manage.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'drop-down' instead of 'dropdown' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'drop-down' instead of 'dropdown'", "location": {"path": "content/manuals/projects/manage.md", "range": {"start": {"line": 12, "column": 34}}}, "severity": "INFO"}

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

@@ -21,7 +21,7 @@

## Remove a project from Docker Desktop

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.

Check failure on line 24 in content/manuals/projects/manage.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.Spacing] ' ' should have one space. Raw Output: {"message": "[Docker.Spacing] ' ' should have one space.", "location": {"path": "content/manuals/projects/manage.md", "range": {"start": {"line": 24, "column": 89}}}, "severity": "ERROR"}

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.
None of your local code is deleted when removing a project from Docker Desktop.
2 changes: 1 addition & 1 deletion content/manuals/projects/open.md
Original file line number Diff line number Diff line change
@@ -91,7 +91,7 @@ To clone and open a remote project:

2. Open your project by selecting your project under **Recents**, or by selecting the specific owner that your project is associated with and then select your project.

## Open an existing remote project
### Open an existing remote project

In the Projects page in Docker Desktop, existing remote projects display No local copy under the project.

1 change: 1 addition & 0 deletions content/manuals/projects/share.md
Original file line number Diff line number Diff line change
@@ -3,6 +3,7 @@ title: Share and collaborate on a project
linkTitle: Collaborate
description: TBD
keywords: TBD
weight: 50
---

Incoming..
1 change: 1 addition & 0 deletions content/manuals/projects/view.md
Original file line number Diff line number Diff line change
@@ -2,11 +2,12 @@
title: View your project
description: View information about your project or the services within your project.
keywords: containers, docker projects, local, remote, docker desktop
weight: 20
---


View a project’s readme

Check failure on line 9 in content/manuals/projects/view.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'readme'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'readme'?", "location": {"path": "content/manuals/projects/view.md", "range": {"start": {"line": 9, "column": 18}}}, "severity": "ERROR"}
If a project has a readme file, you can view it via Docker Projects. Note that the README tab is only visible if the project has a readme file.

Check failure on line 10 in content/manuals/projects/view.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'readme'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'readme'?", "location": {"path": "content/manuals/projects/view.md", "range": {"start": {"line": 10, "column": 20}}}, "severity": "ERROR"}
To view a project’s readme:
Open a new or existing project.
Select the README tab..
Loading
Oops, something went wrong.