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>
This metadata condition was used for features that were only available
on Docker Enterprise Edition ("Docker EE"), and is no longer used.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* updated registry.json
* updated install info
* fix some formatting issues for registry.json instructions
- use `console` blocks for command-line examples
- use different prompts for "powershell" and "non-powershell" examples
- fix path of registry.json on macOS
- wrap some of the lines to ~80 chars
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Co-authored-by: Sebastiaan van Stijn <github@gone.nl>
This code-block uses the "console" highlighting, which considers lines that do
not start with a prompt to be "output" of the command, and non-selectable.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Adjust text, add modal pop-up for browsers with JavaScript enabled, and show
EULA inline for browsers without JavaScript.
Added configuration options in the _config.json to set the correct URLs
once known.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This fixes various inconsistencies between the landing page and the
other pages by sharing more styles between both:
- fix homepage using a different color for the active tab
- fix homepage not having "hover" styles for the top navigation
I addition, this:
- fixes unwanted whitespace in the hamburger-menu on mobile
- fixes "active" menu item not being highlighted on mobile
- fixes left-side aligning of left-hand menu on desktop
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
put in separate blocks. With the "console" code-hint, this
is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
numbered-list to be interrupted.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Added .md files for SLES and RHEL engine installation. Added indexing to _data/toc.yaml and engine/install/index.md. Modified engine/install/index.md, includes/install-script.md, engine/security/rootless.md, storage/storagedriver/device-mapper-driver.md, and storage/storagedriver/select-storage-driver.md to add info for added RHEL and SLES support. Modified engine/install/ubuntu.md to add s390x repos and other info. Added tab target for RHEL and SLES to engine/security/rootless.md along with other info.
Signed-off-by: Nirman Narang <narang@us.ibm.com>
Markdown links don't work well in include files, so use a plain "HTML" link
instead.
Also removing the mention of Docker 18.09. Docker 18.09 has been released
3 years ago, so users not yet on that release (or up) did not update their
docker install for 3 years, which should be "rare" (hopefully)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Some works still to be done:
- styling may need some tweaking
- if we don't have breadcrumbs for a page, positioning of other elements should
be adjusted
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Rephrasing some of this section, and try to make it look less "cluttered".
It's not perfect yet (some other changes may be needed), but can be
addressed in a follow-up.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The YAML files now support a new "details_url" property for flags, which
can be set if there's an anchor on the same page, or an URL where to
find a detailed description of the flag (Currently only anchors are used).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This tones down the prompt and command output, so that the commands
to run stand out more clearly.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
= _includes/install-script.md, engine/install/linux-postinstall.md =
- Remove "Rootless mode is currently available as an experimental feature."
Close issue 12050
= engine/security/rootless.md =
== "Prerequiresites" section ==
- Remove information about old distros (Debian 9, CentOS 7.5-7.6)
== "Distribution-specific hint" section ==
- Tabified (`<div class="tab-content" />`)
== "Known limitations" section ==
- Kernel 5.11 supports rootless overlayfs, without the Ubuntu/Debian patch.
== "Install" section ==
- Promote RPM/DEB installation over TGZ installation.
See docker/roadmap issue 188
== "Uninstall" section ==
- Add "Uninstall" section.
Close issue 12053
== "Usage" section ==
- Added more information about systemd
- Move `nsenter` tips to "Tips for debugging" subsection under "Troubleshooting" section
== "Best practice" section ==
- Remove guide for `lxc-user-nic` network driver due to immaturity.
Will be brought back in future.
See rootless-containers/rootlesskit issue 138 .
== "Troubleshooting" section ==
- Add a guide for "can't open lock file /run/xtables.lock: Permission denied" (SELinux).
See moby/moby issue 41230
- Add a guide for "failed to register layer: ApplyLayer exit status 1 ..." (NFS).
Close docker/for-linux issue 1172
- Improve guides for slirp4netns.
- Remove v19.03 information (e.g., "cgroup v2 is unsupported, use cgroup v1")
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
Some flag descriptions contain point-brackets to indicate required
options, e.g.:
--ssh stringArray SSH agent socket or keys to expose to the build (format: default|<id>[=<socket>|<key>[,<key>]])
When rendering those options as HTML, those options were not visible as
they were rendered as a HTML element.
Given that flag-descriptions are not expected to have MarkDown or HTML
formatting, we can HTML-escape them to prevent this.
This patch escapes the flag-descriptions using liquid's `esacape` command.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
As we don't generate a metadata.json, auto-complete is non-functional,
so disabling the script for previews.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This reduces the time to build, as Jekyll doesn't have to
render the body, then copy it into the layout:
Production before: 62 seconds
Production after: 46 seconds
Development before: 35 seconds
Development after: 33 seconds
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
craig-osterhout
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
Usha Mandya
Peter Dave Hello
Nirman Narang
Ben McCann
Chris Crone
Akihiro Suda
38elements
Kenyon Ralph
Nicolas De Loof
Shu
Christian Clauss