update docs with currently supported features options #1314
Conversation
|
cc @andrewhsu |
Codecov Report
@@ Coverage Diff @@
## master #1314 +/- ##
=======================================
Coverage 54.73% 54.73%
=======================================
Files 292 292
Lines 19267 19267
=======================================
Hits 10545 10545
Misses 8063 8063
Partials 659 659 |
| `buildkit` as the default docker image builder. | ||
|
|
||
| The list of currently supported feature options: | ||
| - `buildkit`: It enables `buildkit` as default builder when set to `true` or disable it by |
| @@ -1423,6 +1423,15 @@ This is a full example of the allowed configuration options on Windows: | |||
| "insecure-registries": [] | |||
| } | |||
| ``` | |||
| #### Feature options | |||
There was a problem hiding this comment.
Can you add an empty line before this header? Perhaps not needed, but I've seen some markdown processors liking to have that 😅
|
|
||
| The list of currently supported feature options: | ||
| - `buildkit`: It enables `buildkit` as default builder when set to `true` or disable it by | ||
| `false`. Note that if this option is not explicitly set in the daemon config file, then it |
There was a problem hiding this comment.
We generally reserve "Note" for a "Note" block. This could be written as;
If this option is not set in the daemon configuration file, then it is up to the cli
to specify which builder to invoke.There was a problem hiding this comment.
Just a thought; perhaps we should describe a bit more what happens when set to false (i.e., BuildKit is disabled, and cannot be invoked by the CLI; the "classic" builder is used instead. Do we have a standard name for the classic builder? (legacy builder? v1 builder?))
| @@ -1423,6 +1423,15 @@ This is a full example of the allowed configuration options on Windows: | |||
| "insecure-registries": [] | |||
| } | |||
| ``` | |||
| #### Feature options | |||
| The optional field `features` in `daemon.json` grants docker users more granularity to | |||
There was a problem hiding this comment.
"docker users" feels a bit strange here (it's a daemon-level option, so users <--> administrators?).
Perhaps
The optional field `features` in `daemon.json` allows you to enable or disable specific daemon features.Signed-off-by: Anda Xu <[email protected]>
update docs with currently supported features options Signed-off-by: nashasha1 <[email protected]>
update docs with currently supported features options Signed-off-by: nashasha1 <[email protected]>
update docs with currently supported features options Signed-off-by: nashasha1 <[email protected]>
- What I did
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)
Signed-off-by: Anda Xu [email protected]