David Karlsson
2d7b8998c4
docs: use gh alert syntax for callouts
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit f1befabe9f )
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-08-21 11:41:15 +02:00
David Karlsson
0a8bb6e5b4
chore: regenerate docs
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit dc22572e3e )
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:48 +02:00
5eac07b103
update typos and style in docs
...
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com >
2023-12-19 19:30:55 +01:00
Kevin Alvarez and Sebastiaan van Stijn
79c9e527a3
docs: generate markdown
...
Keep frontmatter for docker, dockerd and index markdown files.
Also needs to move cli.md > docker.md before generation and
then move it back because cli.md is needed for yaml generation on docs
website: https://github.com/docker/cli/pull/3924#discussion_r1059986605
Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com >
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2023-01-06 22:36:47 +01:00
CrazyMax and Sebastiaan van Stijn
186dcf30b1
docs: fix anchors
...
Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com >
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2023-01-06 22:36:03 +01:00
Sebastiaan van Stijn
2b976720f4
docs: add anchor-tags for flags
...
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 >
2022-03-30 15:05:29 +02:00
Sebastiaan van Stijn
885f44a5ba
docs: fix (table) formatting, fix some broken links
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2022-03-30 15:03:25 +02:00
Silvin Lubecki and Sebastiaan van Stijn
b4af799686
Update reference documentation
...
Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com >
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2022-03-15 15:36:02 +01:00
Sebastiaan van Stijn
47ba76afb1
docs: use "console" code-hint for shell examples
...
This replaces the use of bash where suitable, to allow easier copy/pasting
of shell examples without copying the prompt or process output.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2021-08-21 18:29:13 +02:00
Sebastiaan van Stijn
e6ef3349f6
update docs usage output to match new format
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2020-10-02 15:51:01 +02:00
Sebastiaan van Stijn
e34c407516
docs/reference: explain "colon"
...
Colon may not be something non-native English readers
know about, so explain the symbol in the running text.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2020-04-19 17:53:17 +02:00
Sebastiaan van Stijn
6ae5df423a
reference docs: reformat notes
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2020-04-19 17:52:26 +02:00
Sebastiaan van Stijn
8919c228bd
reference docs: fix broken links and markdown touch-ups
...
- fix various broken links
- fix incorrect anchors
- updated links for content that moved, so that no
redirect to the new location is needed.
- touched-up Markdown;
- re-format some JSON output
- add blank line betweeen command and command output
- format "note" blocks
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2020-04-19 17:13:07 +02:00
Sebastiaan van Stijn
f30bde6adb
remove unneeded comment from reference files
...
these markdown files are not consumed directly in the docs,
but only their content is included through the YAML does,
so there's no need to have these comments in them
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2020-03-19 15:15:23 +01:00
Sebastiaan van Stijn
f540eae7fe
Docs: add note about management commands targeting a manager
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2019-12-12 14:57:05 +01:00
Frieder Bluemle
45c9b9b6c1
Fix GitHub spelling
...
Signed-off-by: Frieder Bluemle <frieder.bluemle@gmail.com >
2017-10-05 01:14:31 +08:00
Kir Kolyshkin
6d85a4f5f8
Fix repo references in docs
...
Since CLI was moved to a separate repo, these references are incorrect.
Fixed with the help of sed script, verified manually.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com >
2017-07-28 10:32:42 -07:00
allencloud and Tibor Vass
4903dd2ca2
make secret ls support filters in CLI
...
Signed-off-by: allencloud <allen.sun@daocloud.io >
2017-06-02 00:11:00 +00:00
allencloud and Tibor Vass
87f6e631ea
specify max size for secret in doc
...
Signed-off-by: allencloud <allen.sun@daocloud.io >
2017-06-02 00:11:00 +00:00
uhayate and Tibor Vass
da2f4802b6
update 3 old docs about secret in docs/reference/commandline/
...
Signed-off-by: uhayate <uhayate.gong@daocloud.io >
2017-06-02 00:10:59 +00:00
Boaz Shuster and Tibor Vass
33166e3364
Add format to secret ls
...
Signed-off-by: Boaz Shuster <ripcurld.github@gmail.com >
2017-06-02 00:10:58 +00:00
Misty Stanley-Jones and Tibor Vass
ddadd3db49
Standardized formatting of CLI reference commands
...
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 <misty@docker.com >
2017-06-02 00:10:53 +00:00
yuexiao-wang and Tibor Vass
0a6612f03f
Change tls to TLS
...
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn >
2017-06-02 00:10:46 +00:00
yuexiao-wang and Tibor Vass
021d177ed1
Fix the inconsistency for docker secret
...
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn >
2017-06-02 00:10:43 +00:00
cyli and Tibor Vass
50674ba5f6
Update docs to reflect no longer displaying secret digest or size.
...
Signed-off-by: cyli <cyli@twistedmatrix.com >
2017-06-02 00:10:40 +00:00
Evan Hazlett and Tibor Vass
6231e4899c
support labels for secrets upon creation; review updates
...
Signed-off-by: Evan Hazlett <ejhazlett@gmail.com >
2017-06-02 00:10:36 +00:00
Evan Hazlett and Tibor Vass
f0026b6e12
doc review updates
...
Signed-off-by: Evan Hazlett <ejhazlett@gmail.com >
2017-06-02 00:10:36 +00:00
Evan Hazlett and Tibor Vass
2161bbf176
docs: update cli reference for secret usage
...
Signed-off-by: Evan Hazlett <ejhazlett@gmail.com >
docs: minor update to service create usage
Signed-off-by: Evan Hazlett <ejhazlett@gmail.com >
2017-06-02 00:10:36 +00:00