Skip to content

Commit 3ce7e88

Browse files
authored
Merge pull request compose-spec#273 from milas/misc-typo-fixes
chore: typo/link fixes backported from docker.github.io
2 parents f8ddb4f + 066ce4e commit 3ce7e88

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

build.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
## Introduction
1010

1111
Compose specification is a platform-neutral way to define multi-container applications. A Compose implementation
12-
focussing on development use-case to run application on local machine will obviously also support (re)building
12+
focusing on development use-case to run application on local machine will obviously also support (re)building
1313
application from sources. The Compose Build specification allows to define the build process within a Compose file
1414
in a portable way.
1515

@@ -73,9 +73,9 @@ services:
7373
7474
When used to build service images from source, such a Compose file will create three docker images:
7575
76-
* `awesome/webapp` docker image is build using `webapp` sub-directory within Compose file parent folder as docker build context. Lack of a `Dockerfile` within this folder will throw an error.
77-
* `awesome/database` docker image is build using `backend` sub-directory within Compose file parent folder. `backend.Dockerfile` file is used to define build steps, this file is searched relative to context path, which means for this sample `..` will resolve to Compose file parent folder, so `backend.Dockerfile` is a sibling file.
78-
* a docker image is build using `custom` directory within user's HOME as docker context. Compose implementation warn user about non-portable path used to build image.
76+
* `awesome/webapp` docker image is built using `webapp` sub-directory within Compose file parent folder as docker build context. Lack of a `Dockerfile` within this folder will throw an error.
77+
* `awesome/database` docker image is built using `backend` sub-directory within Compose file parent folder. `backend.Dockerfile` file is used to define build steps, this file is searched relative to context path, which means for this sample `..` will resolve to Compose file parent folder, so `backend.Dockerfile` is a sibling file.
78+
* a docker image is built using `custom` directory within user's HOME as docker context. Compose implementation warn user about non-portable path used to build image.
7979

8080
On push, both `awesome/webapp` and `awesome/database` docker images are pushed to (default) registry. `custom` service image is skipped as no `Image` attribute is set and user is warned about this missing attribute.
8181

@@ -101,7 +101,7 @@ Alternatively `build` can be an object with fields defined as follow
101101

102102
When the value supplied is a relative path, it MUST be interpreted as relative to the location of the Compose file.
103103
Compose implementations MUST warn user about absolute path used to define build context as those prevent Compose file
104-
for being portable.
104+
from being portable.
105105

106106
```yml
107107
build:
@@ -112,7 +112,7 @@ build:
112112

113113
`dockerfile` allows to set an alternate Dockerfile. A relative path MUST be resolved from the build context.
114114
Compose implementations MUST warn user about absolute path used to define Dockerfile as those prevent Compose file
115-
for being portable.
115+
from being portable.
116116

117117
```yml
118118
build:
@@ -313,11 +313,11 @@ build:
313313
```
314314

315315
### secrets
316-
`secrets` grants access to sensitive data defined by [secrets](secrets) on a per-service build basis. Two
316+
`secrets` grants access to sensitive data defined by [secrets](spec.md#secrets) on a per-service build basis. Two
317317
different syntax variants are supported: the short syntax and the long syntax.
318318

319319
Compose implementations MUST report an error if the secret isn't defined in the
320-
[`secrets`](#secrets-top-level-element) section of this Compose file.
320+
[`secrets`](spec.md#secrets-top-level-element) section of this Compose file.
321321

322322
#### Short syntax
323323

spec.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ available resources.
268268

269269
Deploy support is an OPTIONAL aspect of the Compose specification, and is
270270
described in detail in the [Deployment support](deploy.md) documentation.
271-
not implemented the Deploy section SHOULD be ignored and the Compose file MUST still be considered valid.
271+
If not implemented the Deploy section SHOULD be ignored and the Compose file MUST still be considered valid.
272272

273273
### build
274274

@@ -415,7 +415,7 @@ cgroup_parent: m-executor-abcd
415415
416416
### command
417417
418-
`command` overrides the the default command declared by the container image (i.e. by Dockerfile's `CMD`).
418+
`command` overrides the default command declared by the container image (i.e. by Dockerfile's `CMD`).
419419
420420
```
421421
command: bundle exec thin -p 3000
@@ -1601,13 +1601,13 @@ web:
16011601

16021602
### scale
16031603

1604-
-DEPRECATED: use [deploy/replicas](deploy.md#replicas)_
1604+
_DEPRECATED: use [deploy/replicas](deploy.md#replicas)_
16051605

16061606
`scale` specifies the default number of containers to deploy for this service.
16071607

16081608
### secrets
16091609

1610-
`secrets` grants access to sensitive data defined by [secrets](secrets) on a per-service basis. Two
1610+
`secrets` grants access to sensitive data defined by [secrets](#secrets) on a per-service basis. Two
16111611
different syntax variants are supported: the short syntax and the long syntax.
16121612

16131613
Compose implementations MUST report an error if the secret doesn't exist on the platform or isn't defined in the
@@ -1653,7 +1653,7 @@ the service's containers.
16531653
The following example sets the name of the `server-certificate` secret file to `server.crt`
16541654
within the container, sets the mode to `0440` (group-readable) and sets the user and group
16551655
to `103`. The value of `server-certificate` secret is provided by the platform through a lookup and
1656-
the secret lifecycle not directly managed by the Compose implementation.
1656+
the secret lifecycle is not directly managed by the Compose implementation.
16571657

16581658
```yml
16591659
services:

0 commit comments

Comments
 (0)