Commit Graph

22 Commits

Author SHA1 Message Date
Ashwin Maroli 02d087c63a
Stash computed data in a Liquid variable (#10462)
* Stash computed data in a variable

To avoid computing `site.data[include.datafolder][include.datafile]` multiple times for the same context.

* Revert change to hard-tab whitespace
2020-03-20 13:08:19 +00:00
Sebastiaan van Stijn e6a8b7e5e4
Reference: add anchor-link to examples section
Some commands provide a long list of options, which may
"hide" the examples section. To help discoverability, add
an anchor-link to the examples section (if present).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-16 13:13:51 +01:00
Sebastiaan van Stijn 252db13907
Reference: move "extended description" above "options"
The extended description usually provides a good introduction to
the command, which likely is useful to read before heading to
more detailed information (such as "which options does this command
have")

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-16 13:09:27 +01:00
Sebastiaan van Stijn a76cbe68a7
Reference: move "parent", "child", and "related" commands to bottom
For some commands, the list of "related" commands is lenghty, therefore
hiding the extended description and examples below the fold, which is
not ideal.

This patch moves the "parent command", "child commands", and "related
commands" sections to the bottom of the page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-16 13:06:48 +01:00
Sebastiaan van Stijn 8b53965237 Commandline reference: add note to "enterprise only" subcommands (#10008)
* Update CLI template for "enterprise-only" commands/plugins

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* reference: mark "assemble" subcommands as enterprise-only

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* reference: mark "cluster" subcommands as enterprise-only

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* reference: mark "registry" subcommands as enterprise-only

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* reference: mark "template" subcommands as enterprise-only

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-12-11 15:48:32 +00:00
Adrian Plata e7360acc79
Pointing to new experimental information section (#9569)
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-10-03 13:08:12 -07:00
Adrian Plata fc4d3872c4 Emphasizing no production environments for experimental features
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-09-27 10:50:22 -07:00
Adrian Plata 972d1929bd simply the experimental box
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-09-18 14:35:33 -07:00
Adrian Plata f2f0dca20c
Fixing broken sidebar (#9425)
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-09-10 13:24:40 -07:00
Maria Bermudez 9d7f9646d9
Add experimental note on Registry CLI reference pages (#1132) 2019-06-10 13:50:06 -07:00
Misty Stanley-Jones f688179d86
Add features to CLI ref template (#5736)
* Add features to CLI ref template

- Differentiate CLI experimental from daemon experimental
- When the whole command is experimental, point to docs for
  how to get it to show up
- Make badges links where possible
- Add tooltips to badges for more context
- Document in the test.md how to make badges into links and how to use tooltips
2018-01-16 12:02:10 -08:00
Misty Stanley-Jones 95d7ea7418 Update CLI template to add badges for orchestrator and experimentalcli 2018-01-11 16:39:12 -08:00
John Mulhausen 024ae953ba Fixes #4041 2017-10-13 15:16:11 -07:00
Misty Stanley-Jones acda699725 Don't print defaults from the YAML in cases where the meaning is really 'default to unset' (#4813) 2017-10-05 16:02:49 -07:00
Misty Stanley-Jones 7c800e7054 Tweak formatting of options tables (#4730) 2017-09-29 17:38:46 -07:00
Misty Stanley-Jones 0975a5c5ab Add info about deprecated and experimental options to CLI template (#4711) 2017-09-26 20:49:43 -07:00
Misty Stanley-Jones 10be60a80f Go back to small /edge (#2736)
* Go back to small /edge

* Update site front page

Add info about Editions
Reorganize components
Update headings

* Move logic of fetching content to a script

* Add v1.28 API

* Add info about versioned API
2017-04-13 18:58:56 -07:00
Misty Stanley-Jones b3ca1d6120 Add 17.04 CLI refs
Also adjust CLI stub pages and cli.md to look in a different
data folder for edge releases
2017-04-05 17:45:44 -07:00
Misty Stanley-Jones 77701141a0 Fix the template not to include Related Commands section for dockerd (#2287) 2017-03-13 14:55:57 -07:00
French Ben ff0e184ef3 Added examples parsing to liquid template
Signed-off-by: French Ben <frenchben@docker.com>
2017-02-14 14:47:44 -08:00
John Mulhausen 232ab64c09 Support for related commands in CLI 2017-01-31 18:52:24 -08:00
John Mulhausen 35898701eb YAML-sourced CLI refdocs 2017-01-19 11:12:55 -08:00