From 412e2a3fe168787499befe9ff013122f112fae0e Mon Sep 17 00:00:00 2001 From: Jordan Stephens Date: Wed, 7 Aug 2024 15:16:43 -0700 Subject: [PATCH 1/3] Describe Projects --- docs/concepts/projects.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/concepts/projects.md diff --git a/docs/concepts/projects.md b/docs/concepts/projects.md new file mode 100644 index 000000000..306eef0fc --- /dev/null +++ b/docs/concepts/projects.md @@ -0,0 +1,15 @@ +--- +title: Projects +description: A _project_ refers to a cohesive collection of services, networks, and volumes which are defined and managed using a `compose.yml` file. +sidebar_position: 200 +--- + +# Projects + +A _project_ refers to a cohesive collection of services, networks, and volumes which are defined and managed using a `compose.yml` file. These are the components of your cloud application. + +## Project Names + +The _project name_ can be defined in the compose file with [the `name` property](https://docs.docker.com/compose/compose-file/04-version-and-name/#name-top-level-element), otherwise the base name of the project directory will be used. + +The [`--project-name` CLI flag](/docs/cli/defang) can be used to specify the target project name when the `compose.yaml` file is not present. From 1175de4bc8f3e1f3d598219d1a8f1eb8a08d6e54 Mon Sep 17 00:00:00 2001 From: Jordan Stephens Date: Wed, 7 Aug 2024 15:27:22 -0700 Subject: [PATCH 2/3] Prefer .yaml instead of .yml --- docs/concepts/projects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/projects.md b/docs/concepts/projects.md index 306eef0fc..ba7b64381 100644 --- a/docs/concepts/projects.md +++ b/docs/concepts/projects.md @@ -6,7 +6,7 @@ sidebar_position: 200 # Projects -A _project_ refers to a cohesive collection of services, networks, and volumes which are defined and managed using a `compose.yml` file. These are the components of your cloud application. +A _project_ refers to a cohesive collection of services, networks, and volumes which are defined and managed using a `compose.yaml` file. These are the components of your cloud application. ## Project Names From 45c01a09d4a4cc47fbd051c195be7d9a3426ccae Mon Sep 17 00:00:00 2001 From: Jordan Stephens Date: Thu, 8 Aug 2024 14:22:26 -0700 Subject: [PATCH 3/3] Addressing feedback --- docs/concepts/projects.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/concepts/projects.md b/docs/concepts/projects.md index ba7b64381..43ab41770 100644 --- a/docs/concepts/projects.md +++ b/docs/concepts/projects.md @@ -1,15 +1,22 @@ --- title: Projects -description: A _project_ refers to a cohesive collection of services, networks, and volumes which are defined and managed using a `compose.yml` file. +description: A _project_ refers to a cohesive collection of services which are defined and managed using a `compose.yml` file. sidebar_position: 200 --- # Projects -A _project_ refers to a cohesive collection of services, networks, and volumes which are defined and managed using a `compose.yaml` file. These are the components of your cloud application. +A _project_ refers to a cohesive collection of services which are defined and managed using a `compose.yaml` file. ## Project Names The _project name_ can be defined in the compose file with [the `name` property](https://docs.docker.com/compose/compose-file/04-version-and-name/#name-top-level-element), otherwise the base name of the project directory will be used. -The [`--project-name` CLI flag](/docs/cli/defang) can be used to specify the target project name when the `compose.yaml` file is not present. +The project name may then be used when performing project-wide operations such as listing services, tailing logs, or deprovisioning. For example: +``` +defang services --project-name +defang tail --project-name +defang compose down --project-name +``` + +By default `defang` will use the project name from the `compose.yaml` file in the working directory. The [`--project-name` CLI flag](/docs/cli/defang) may be used when running `defang` from outside the working directory.