Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit b339e0b

Browse files
Merge pull request #744 from carolinebriaud/fix-readme
Fix minor issues in README file
2 parents 27a4e6e + 1976806 commit b339e0b

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,17 @@ Four primary steps comprise the Docker App process:
4747

4848
### Writing an App definition
4949

50-
The first step in using Docker App is to write the App definition. This definition can be created (1) from an existing Compose file using the `docker app init` command (2) via a template from the [Application Designer](https://docs.docker.com/ee/desktop/app-designer/), or (3) from scratch.
50+
The first step in using Docker App is to write the App definition. This definition can be created (1) from an existing [Compose file](https://docs.docker.com/compose/compose-file/) using the `docker app init` command (2) via a template from the [Application Designer](https://docs.docker.com/ee/desktop/app-designer/), or (3) from scratch.
5151

5252
The App definition is a .dockerapp folder that contains three distinct pieces: metadata, a service list, and the parameters.
5353

5454
| File | Description |
5555
| :------------ | :------------ |
5656
| metadata.yml | metadata including the App name and version |
57-
| docker-compose.yml | Service list defined in a [Compose file](https://docs.docker.com/compose/compose-file/) |
57+
| docker-compose.yml | Service list defined in a Compose file |
5858
| parameters.yml | Parameters that can be changed when running the App |
5959

60-
*Note: To store additional files in Docker Apps, such as* `prod.yml`*,* `test.yml` *or other config files, you need only to add these files to the *.dockerapp directory. All files will be packaged into the App image through the use of the* `docker app build` *command.*
60+
*Note: To store additional files in Docker Apps, such as `prod.yml`, `test.yml` or other config files, you need only to add these files to the *.dockerapp directory. All files will be packaged into the App image through the use of the `docker app build` command.*
6161

6262
### Building an App image
6363

@@ -88,7 +88,7 @@ First, create an App definition from an existing Compose file.
8888
Create a `docker-compose.yml` file that has the following content:
8989

9090
```yaml
91-
version: '3.2'
91+
version: '3.6'
9292
services:
9393
hello:
9494
image: hashicorp/http-echo
@@ -109,6 +109,7 @@ $ tree
109109
   ├── docker-compose.yml
110110
    ├── metadata.yml
111111
   └── parameters.yml
112+
```
112113

113114
A new folder named `hello.dockerapp` now exists, which contains three YAML documents:
114115
* metadata
@@ -133,7 +134,7 @@ The Compose file is the one that was passed in parameters. Thus, if you open `pa
133134
Edit the `docker-compose.yml` file in the `hello.dockerapp` directory to add some variables:
134135

135136
```yaml
136-
version: '3.2'
137+
version: '3.6'
137138
services:
138139
hello:
139140
image: hashicorp/http-echo
@@ -156,7 +157,8 @@ Next, build an App image:
156157
```console
157158
$ docker app build . -f hello.dockerapp -t myrepo/hello:0.1.0
158159
[+] Building 0.7s (6/6) FINISHED
159-
(...) (Build output) sha256:4a492748ae55170daadd1ddfff4db30e0ef3d38bf0f57a913512caa323e140de
160+
(...) (Build output)
161+
sha256:4a492748ae55170daadd1ddfff4db30e0ef3d38bf0f57a913512caa323e140de
160162
```
161163

162164
At this point, an App image with the `myrepo/hello:1.0.1` tag has been built from the `hello.dockerapp` App definition. This immutable App image includes all the service images at fixed versions that you can run or share.

0 commit comments

Comments
 (0)