The dashboard topic was rolled up into the "get-started" section in commit
ab0dee78a2, which removed links from the TOC.
The page itself was removed in 13ee3ff426, but
forgot to add/copy the redirects.
This patch adds the redirects back, and fixes some links to the page that's
now missing.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The previous instructions fixed situations where the directory
and file didn't exist, but had some issues remaining;
The `>>` _appends_ the content to the file; this would work if the file didn't
exist (before `touch`'ing it) but if there happened to be a file already, it
would append the content to the existing file, resulting in invalid JSON.
e.g. running it twice (which may be accidentally);
```bash
sudo echo '{"allowedOrgs":["myorg"]}' >> "/Library/Application Support/com.docker.docker/registry.json"
sudo echo '{"allowedOrgs":["myorg"]}' >> "/Library/Application Support/com.docker.docker/registry.json"
```
Would result in;
```bash
sudo cat "/Library/Application Support/com.docker.docker/registry.json"
{"allowedOrgs":["myorg"]}
{"allowedOrgs":["myorg"]}
```
(which is invalid JSON)
The `sudo echo` also had some issues; the `sudo` only applied to the `echo`, and
not to the piped output (see https://unix.stackexchange.com/questions/1416/redirecting-stdout-to-a-file-you-dont-have-write-permission-on);
```bash
$ sudo touch "/Library/Application Support/com.docker.docker/registry.json"
$ sudo echo '{"allowedOrgs":["myorg"]}' > "/Library/Application Support/com.docker.docker/registry.json"
bash: /Library/Application Support/com.docker.docker/registry.json: Permission denied
```
Instead, using `tee` to run as privileged process, similar to the approach taken
in c33d39a7ba/engine/install/debian.md (L106)
With that, the `touch` wouldn't be needed (the `mkdir` still would though);
```suggestion
$ sudo mkdir -p "/Library/Application Support/com.docker.docker"
$ echo '{"allowedOrgs":["myorg"]}' | sudo tee "/Library/Application Support/com.docker.docker/registry.json"
```
The new instructions will always overwrite the content with the new content,
replacing what's already there (that may need a small warning / note though) to
prevent the invalid JSON if someone runs the command multiple times, or if they
have to update the existing config with a new one.
Finally, some verification steps were added to verify content and permissions.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Experimental CLI features are enabled by default since docker 20.10, so the
instructions for enabling the features were no longer needed. Also tweaked the
description a bit to align how we describe experimental features elsewhere.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The reference pages show badges for commands and options (flags) that require
a minimum API version. While this information can be useful if an option was
added in a recent version of the Docker Engine (and API), these badges are no
longer relevant to most users if the minimum required version is quite "old".
We assume users reading these pages to be on the current version, or at most
on the version before that (which is already "unsupported"). Users running
older versions have bigger problems on their hand, so we're not accounting for
those.
So, to reduce unnecessary clutter on the page, we only show the minimum required
API version if it requires a relatively recent version of the Engine.
A new "min_api_threshold" option was added in the `_config.yml`, which specifies
the minimum required API version for which we show a badge (currently: API v1.40,
or "Docker 19.03").
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The "parent command" can be useful if the page describes a subcommand,
but generally having a link to `docker` may not provide much value.
This patch omits the "parent command" section if the parent command
is the `docker` command itself.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The "description" header included the short description of each command. In most
cases, this description was very short ("run a container"), and adding the extra
header before it only was adding extra noise.
This patch:
- removes the top "description" header
- renames the existing "extended description" header to "description" (a hidden
"extended-description" anchor is added for backward compatibility)
As the extended description can be long (hopefully!), there may be a long distance
between the `Usage` section and the `Options` section. To help users navigate
to the list of available options, an extra line is printed if an extended
description is available for the command, including a link to the corresponding
section:
> Refer to the options section for an overview of available OPTIONS for this command.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
CrazyMax
Craig Osterhout
andrei-z-albu
Allie Sadler
jerae-duffin
Sebastiaan van Stijn
aiordache
Jerae Duffin
James Ratliff
Antony Santhiago
Gavin
Usha Mandya
Sebastiaan van Stijn
Justin Chadwell
CrazyMax
Allie Sadler
Mark H
Anca Iordache