[20.10 backport] docs: add anchor tags for command-line flags #3525
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## 20.10 #3525 +/- ##
=======================================
Coverage 58.57% 58.57%
=======================================
Files 299 299
Lines 21457 21457
=======================================
Hits 12569 12569
Misses 7970 7970
Partials 918 918 |
thaJeztah
force-pushed
the
20.10_backport_anchor_tags
branch
from
174deaa to
cd3555d
Compare
thaJeztah
force-pushed
the
20.10_backport_anchor_tags
branch
from
cd3555d to
5420464
Compare
Member
Author
|
This probably also needs |
thaJeztah
force-pushed
the
20.10_backport_anchor_tags
branch
from
5420464 to
8fa2c67
Compare
With this, the sections are linked from the "options" table when producing the documentation on docs.docker.com Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit b87a0c1) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This will generate "details_url" for options, so that the options table on the pages at docs.docker.com link to the section describing the option. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 2b97672) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Mathieu Rollet <matletix@gmail.com> (cherry picked from commit f41cbf9) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Docker v1.12 is really old, so no need to continue including this in the docs. Also reformatted a markdown table. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 82805ad) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Some touch-ups in the attach reference and man-page; - remove uses of old images (ubuntu 14.04) - adds some more wording about `-i` and `-t` to use the detach sequence. - use `--filter` instead of `grep` to list the container, to make the example more portable. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 74086bc) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
using latest ubuntu LTS, and alpine for some examples. Also syncing some wording between the man-pages and online docs. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 9ba371f) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Update the example output to not use deprecated storage drivers or Windows versions. Also removes the section about `--debug`, because the `docker info` output depends on the _daemon_ (not the client) to have debug mode enabled. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit cac78c2) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Use /bin/sh in the examples, as it's more likely to be present in a container than bash (some users got confused by this, so using plain "sh" in the examples could lead to less confusion). Also added some extra wording around defaults, and how they're inherited by the exec'd process. It's definitely not "perfect" yet (lots to do in this document to improve it), but it's a start :) Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 60833d2) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Djordje Lukic <djordje.lukic@docker.com> Signed-off-by: David Karlsson <david.karlsson@docker.com> (cherry picked from commit bfcadab) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: David Karlsson <david.karlsson@docker.com> (cherry picked from commit 7c0d6ec) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 71e5617) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 81b0512) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 186dcf3) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
20.10_backport_anchor_tags
branch
from
8fa2c67 to
fb1fb99
Compare
Member
Author
|
once docker/docs#16461 is merged, we should probably be able to merge this one (otherwise CI in the docs repository will fail) |
rumpl
approved these changes
Jan 9, 2023
crazy-max
approved these changes
Jan 9, 2023
vvoland
approved these changes
Jan 9, 2023
Member
Author
|
Thanks! Bringing this one in; then I'll update the docs PR (docker/docs#16460) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
back ports:
Some minor conflicts in the last cherry-pick due to adjacent line changes that are not in 20.10
I'm keeping this separate, as these commits require some changes in the docs repository.
- A picture of a cute animal (not mandatory but encouraged)