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
more vale
  • Loading branch information
aevesdocker committed Feb 25, 2025
commit 5b19427bc37a2e1c4f8407da0e286a960e34e129
2 changes: 1 addition & 1 deletion content/manuals/projects/_index.md
Original file line number Diff line number Diff line change
@@ -44,9 +44,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 47 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": 47, "column": 8}}}, "severity": "INFO"}
- Minimal Docker expertise required: Ideal for both beginners and experienced developers.
- Custom `run` commands for your projects: Define and store preconfigured `run` commands that are equivalent to running `docker compose up`.
- Custom `run` commands for your projects: Define and store pre-configured `run` commands that are equivalent to running `docker compose up`.
- Local and remote projects: Work on projects locally or sync artifacts to the cloud for cross-device access and easy collaboration.

{{< grid >}}
18 changes: 9 additions & 9 deletions content/manuals/projects/about.md
Original file line number Diff line number Diff line change
@@ -13,30 +13,30 @@ Docker Projects works as follows:

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.
- 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.
- Enable pre-run tasks, such as executing scripts before starting the services.
- Work like `docker compose up`, launching services based on the Compose file.
- Can be customized with additional flags, multiple Compose files, and environment variables.
- Enable 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 pre-defined run commands, reducing setup time.
- Work across devices: Open a project from any machine and instantly access stored configurations.
- Share configurations: Team members can access pre-defined run commands, reducing setup time.

Collaboration is easy — 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.
- View logs to debug issues and track service activity.
- Edit configurations and run commands as requirements change.

## What's next?

2 changes: 1 addition & 1 deletion content/manuals/projects/edit.md
Original file line number Diff line number Diff line change
@@ -25,7 +25,7 @@ weight: 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.

- **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.
- **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.
- **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**.
4 changes: 2 additions & 2 deletions content/manuals/projects/open.md
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@
weight: 20
---

> [!NOTE]
> [!IMPORTANT]
>
> In order to use Docker Projects, make sure you have enabled the **Access experimental features** setting on the **Features in development** tab.

@@ -64,7 +64,7 @@

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

2. Select **Clone a git repository**. This lets you specify a Git repository and a local folder to clone that repository to. The repository must contain at least your project’s code and a Compose file.

Check failure on line 67 in content/manuals/projects/open.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Git' instead of 'git'. Raw Output: {"message": "[Vale.Terms] Use 'Git' instead of 'git'.", "location": {"path": "content/manuals/projects/open.md", "range": {"start": {"line": 67, "column": 21}}}, "severity": "ERROR"}

3. Enter the remote source and choose the local destination to clone to.

@@ -90,7 +90,7 @@
>
> 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 deselecing the checkbox.
- **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.
- **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.

7. Select **Save changes**.
@@ -107,7 +107,7 @@

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

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.

Check warning on line 110 in content/manuals/projects/open.md

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.SentenceLength] Write short, concise sentences. (<=40 words) Raw Output: {"message": "[Docker.SentenceLength] Write short, concise sentences. (\u003c=40 words)", "location": {"path": "content/manuals/projects/open.md", "range": {"start": {"line": 110, "column": 1}}}, "severity": "WARNING"}

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

4 changes: 2 additions & 2 deletions content/manuals/projects/share.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Share and collaborate on a project
linkTitle: Collaborate
description: TBD
keywords: TBD
description: Learn how to collaborate on a project
keywords: collaborate, projects, docker desktop, local, remote
weight: 60
---

Loading
Oops, something went wrong.