Cli fixups#30804
Conversation
docs/reference/commandline/attach.md
Outdated
There was a problem hiding this comment.
I wonder console is preferred over bash for better rendering, but it can be other PR.
There was a problem hiding this comment.
Highlighting will probably improve once we can do docker/docs#1021, unfortunately that's currently blocked by changes upstream
There was a problem hiding this comment.
Either bash is a synonym for console or the other way around. They are equivalent. We have pretty much standardized on bash over time.
docs/reference/commandline/build.md
Outdated
There was a problem hiding this comment.
Perhaps we should change this to "use a custom parent cgroup". The "optional" seems to refer to the fact that this flag is not required; that applies to most flags, so is irrelevant
docs/reference/commandline/cli.md
Outdated
There was a problem hiding this comment.
Correct. It screws up the formatting in the whole rest of the file. :(
docs/reference/commandline/events.md
Outdated
There was a problem hiding this comment.
For a follow up we should consider making this a table, and describe when each event is fired / a short description
docs/reference/commandline/rm.md
Outdated
There was a problem hiding this comment.
Actually, this only removes the "link" (if it's a legacy link on the default bridge network; the same may not apply when using --link on a custom network)
docs/reference/commandline/rm.md
Outdated
There was a problem hiding this comment.
For a follow up; we may want to express the dangers of using -f, as it not only forces removal of a container is still running, but also can result in layers being left behind if they fail to be removed
docs/reference/commandline/wait.md
Outdated
There was a problem hiding this comment.
Can you check this to be sure (per our discussion)
thaJeztah
added
process/docs-cherry-pick
status/3-docs-review
and removed
status/0-triage
labels
|
Addressed feedback so far, except for follow-up issues. |
Signed-off-by: Misty Stanley-Jones <[email protected]>
Signed-off-by: Misty Stanley-Jones <[email protected]>
Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <[email protected]>
|
Rebase complete, @thaJeztah |
|
Let's go! |
Cli fixups (cherry picked from commit 40dbbd3) Signed-off-by: Sebastiaan van Stijn <[email protected]>
Cli fixups (cherry picked from commit 40dbbd3) Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit c611906) Signed-off-by: Tibor Vass <[email protected]>
4 participants
Two smaller commits address docker/docs#1451 and remove an unused GIF from
docs/reference/commandline/.The big commit standardizes formatting of CLI reference commands:
These changes will enable us to automate use of the CLI reference files in generated YAML output.
cc/ @FrenchBen