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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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 c0088ed380da722b90d256c88c45f235a0c59806
2 changes: 2 additions & 0 deletions content/manuals/projects/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,17 @@
link: /projects/faq/
---

{{< summary-bar feature_name="Docker Projects" >}}

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.

A project organizes your code and Docker artifacts into a single object. These artifacts include logs as well as customizable run commands. These artifacts can persist remotely in the cloud, which lets you access your projects from any device that has Docker Desktop.

### 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 47 in content/manuals/projects/_index.md

View workflow job for this annotation

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": 47, "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 49 in content/manuals/projects/_index.md

View workflow job for this annotation

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": 49, "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 50 in content/manuals/projects/_index.md

View workflow job for this annotation

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": 50, "column": 28}}}, "severity": "ERROR"}

{{< grid >}}
1 change: 1 addition & 0 deletions content/manuals/projects/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: How it works
description: Understand how Docker Projects works
keywords: docker projects
weight: 10
---

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.
Expand All @@ -19,7 +20,7 @@

- 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 23 in content/manuals/projects/about.md

View workflow job for this annotation

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": 23, "column": 4}}}, "severity": "INFO"}

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

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/projects/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: 30
weight: 40
---

## 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

View workflow job for this annotation

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

View workflow job for this annotation

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

View workflow job for this annotation

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.
Expand All @@ -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

View workflow job for this annotation

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

View workflow job for this annotation

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

View workflow job for this annotation

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**.
2 changes: 1 addition & 1 deletion content/manuals/projects/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
linkTitle: FAQs
description: Find common FAQs for Docker Projects
keywords: faqs, docker projects, local, remote
weight: 60
weight: 70
---

## Why is a Compose file required?
Expand All @@ -17,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

View workflow job for this annotation

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"}

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/projects/manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: 40
weight: 50
---

## 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

View workflow job for this annotation

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.

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/projects/open.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Open a new project
description: Learn how to open a new local or remote project, or an existing project in Docker Projects.
keywords: Docker, projects, docker deskotp, containerization, open, remote, local
weight: 10
weight: 20
---

## New projects
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/projects/share.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Share and collaborate on a project
linkTitle: Collaborate
description: TBD
keywords: TBD
weight: 50
weight: 60
---

Incoming..
2 changes: 1 addition & 1 deletion content/manuals/projects/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +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
weight: 30
---


View a project’s readme

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

View workflow job for this annotation

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

View workflow job for this annotation

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"}

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

View workflow job for this annotation

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": 132}}}, "severity": "ERROR"}
To view a project’s readme:
Open a new or existing project.
Select the README tab..
Expand Down
2 changes: 2 additions & 0 deletions data/summary.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ Docker Desktop CLI update:
requires: Docker Desktop 4.38 and later
Docker GitHub Copilot:
availability: Early Access
Docker Projects:
availability: Beta
Docker Scout exceptions:
availability: Experimental
requires: Docker Scout CLI [1.15.0](/manuals/scout/release-notes/cli.md#1150) and later
Expand Down
Loading