mirror of https://github.com/docker/docs.git
144c8b1f8f
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>
|
||
|---|---|---|
| .. | ||
| analytics | ||
| content | ||
| guides | ||
| landing-page | ||
| api-version-matrix.md | ||
| breadcrumbs.html | ||
| cli.md | ||
| configure-registry-json.md | ||
| deploy.md | ||
| desktop-license-update.md | ||
| desktop-update.md | ||
| eula-modal.html | ||
| eula.md | ||
| experimental-feature.md | ||
| experimental.md | ||
| footer.html | ||
| github-pr.md | ||
| head.html | ||
| header.html | ||
| install-script.md | ||
| navigation.html | ||
| read_time.html | ||
| registry.md | ||
| sign-up-cta.html | ||
| theme-switch.html | ||
| toc_pure_liquid.html | ||
| upgrade-cta.html | ||