Skip to content

Commit

Permalink
more vale
Browse files Browse the repository at this point in the history
  • Loading branch information
aevesdocker committed Feb 25, 2025
1 parent aa301c2 commit 5b19427
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion content/manuals/projects/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ A project organizes your code and Docker artifacts into a single object. These a

- 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 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
Expand Up @@ -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?

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 @@ -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**.
Expand Down
4 changes: 2 additions & 2 deletions content/manuals/projects/open.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: Docker, projects, docker deskotp, containerization, open, remote, loca
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.
Expand Down Expand Up @@ -90,7 +90,7 @@ To clone and open a remote project:
>
> 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**.
Expand Down
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
---

Expand Down

0 comments on commit 5b19427

Please sign in to comment.