David Karlsson
f1befabe9f
docs: use gh alert syntax for callouts
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-08-16 11:02:10 +02:00
Kevin Alvarez
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
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
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
039018b6d3
docs: remove deprecated orchestrator flags
...
Removes the flags that have been deprecated or removed;
- --default-stack-orchestrator
- --kubernetes
- --kubeconfig
- --namespace
- --orchestrator
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2022-02-24 12:28:29 +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
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
Sebastiaan van Stijn
0f07b9ffc7
Update command usage and documentation
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2018-06-21 23:16:27 -07:00
Silvin Lubecki
65526a201f
Add namespace column for docker stack ls command while targeting Kubernetes orchestrator
...
Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com >
2018-05-09 17:33:16 +02:00
Silvin Lubecki
13d0c9c695
Add an orchestrator column in the docker stack ls command
...
Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com >
2018-04-30 12:04:02 +02: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
Boaz Shuster
5be9e57c51
Add format to docker stack ls
...
Signed-off-by: Boaz Shuster <ripcurld.github@gmail.com >
2017-06-02 00:11:03 +00:00
French Ben
6fe11272d3
docs: added support for CLI yaml file generation
...
Signed-off-by: French Ben <frenchben@docker.com >
Signed-off-by: Tibor Vass <tibor@docker.com >
2017-06-02 00:10:58 +00:00
Misty Stanley-Jones
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
lixiaobing10051267
d408f74d07
stack_config.md not exist and delete it
...
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn >
2017-06-02 00:10:44 +00:00
Harald Albers
7e37dd4329
Add aliases and options to docker stack ls docs
...
Signed-off-by: Harald Albers <github@albersweb.de >
2017-06-02 00:10:41 +00:00
Harald Albers
d16010d737
Move docker stack docs out of experimental
...
Signed-off-by: Harald Albers <github@albersweb.de >
2017-06-02 00:10:40 +00:00
Gaetan de Villele
572c6bb89a
fix frontmatter keywords value type (string, instead of []string) in /docs/reference
...
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com >
2017-06-02 00:10:31 +00:00
yuexiao-wang
d74d024775
Add stack service and fix typos
...
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn >
2017-06-02 00:10:31 +00:00
Misty Stanley-Jones
7f36c3a1a0
Sync docker/docker refs with files mistakenly edited in docker.github.io repo
...
Signed-off-by: Misty Stanley-Jones <misty@docker.com >
2017-06-02 00:10:26 +00:00
Misty Stanley-Jones
2845676cc2
Convert Markdown frontmatter to YAML
...
Some frontmatter such as the weights, menu stuff, etc is no longer used
'draft=true' becomes 'published: false'
Signed-off-by: Misty Stanley-Jones <misty@docker.com >
2017-06-02 00:10:24 +00:00
Alicia Lauerman
f840df5a2b
add documentation for docker stack ps
...
also updates related stack docs and removes stack_tasks.md
Signed-off-by: Alicia Lauerman <allydevour@me.com >
2017-06-02 00:10:13 +00:00
Akihiro Suda
268c22d77b
add docker stack ls
...
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp >
2017-06-02 00:10:11 +00:00