Skip to content

Commit e46818b

Browse files
LucasRoesleralexellis
authored andcommitted
Improve wording for build_options reference docs
Signed-off-by: Lucas Roesler <[email protected]>
1 parent cca2a48 commit e46818b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/reference/yaml.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,16 +65,16 @@ This an optional boolean field, set to `false` by default.
6565

6666
#### Function: Build Options
6767

68-
The `build_options` allows you to pass a list of [Docker build arguments](https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg) to the build process. When the language template supports it, this allows you to customize the build without modifying the underlying template.
68+
The `build_options` field can be used to you to pass a list of [Docker build arguments](https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg) to the build process. When the language template supports it, this allows you to customize the build without modifying the underlying template.
6969

70-
For example, the [official python3 language template](https://github.com/openfaas/templates/blob/master/template/python3/Dockerfile) allows passing additional Alpine `apk` packages to be installed during build process. To isntall the [`ca-certificates`](https://pkgs.alpinelinux.org/package/edge/main/x86_64/ca-certificates) package for your `python3` function, you can specify
70+
For example, the [official python3 language template](https://github.com/openfaas/templates/blob/master/template/python3/Dockerfile) allows passing additional Alpine `apk` packages to be installed during build process. To install the [`ca-certificates`](https://pkgs.alpinelinux.org/package/edge/main/x86_64/ca-certificates) package for your `python3` function, you can specify
7171

7272
```yaml
7373
build_options:
7474
- ca-certificates
7575
```
7676

77-
Important note: that the configuration of this value is dependent on the language template.
77+
Important note: that the configuration of this value is dependent on the language template. The template author must specify one or more [`ARG`](https://docs.docker.com/engine/reference/builder/#arg) in the `Dockerfile`.
7878

7979
#### Function: Environmental variables
8080

0 commit comments

Comments
 (0)