Commit Graph

124 Commits

Author SHA1 Message Date
Christian Dupuis
76ecc1103c Update Scout ref docs to v0.17.0 2023-06-29 10:11:09 +02:00
CrazyMax
a090389dd2 buildx: remove hidden commands from cli ref
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2023-06-27 19:55:59 +02:00
David Karlsson
6dd9522756 Merge pull request #17539 from docker-tools-robot/dispatch/buildx-ref-v0.11.0
Update buildx reference to v0.11.0
2023-06-26 16:13:43 +02:00
jedevc
bd6ac8f856 build: update buildx reference to v0.11.0
Signed-off-by: GitHub <noreply@github.com>
2023-06-26 16:08:52 +02:00
Sebastiaan van Stijn
5ab15e702d reference: update comments in scout stubs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-06-22 15:44:45 +02:00
Sebastiaan van Stijn
759123d89d scout: fetch yaml-docs from upstream repository
This removes the vendored yaml-docs, and fetches them from upstream
during build. The https://github.com/docker/scout-cli repository
contains the generated docs for the scout cli plugin.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-06-22 15:44:37 +02:00
Allie Sadler
f58e3c8d06 ENGDOCS-1309 (#17142) 2023-04-19 10:18:33 +01:00
Sebastiaan van Stijn
9375c27049 scout: add consistent banners for "early access"
Docker Scout is in early access, but some parts of the documentation
(reference docs) did not contain a banner for this.

This patch:

- Changes the "note" to "early access" (just a minor improvment)
- Adds banners to all the CLI reference pages
- Adds (Early Access) in the CLI reference navigation (TOC)
- Moves the banner to an include

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-07 16:36:37 +02:00
Sebastiaan van Stijn
e0642390a8 add docker init (#17016)
Manually combining the generated YAML docs with the Markdown
that was written by Craig.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Co-authored-by: craig-osterhout <craig.osterhout@docker.com>
2023-04-05 16:52:37 +01:00
Yves Brissaud
df7dfffa24 scout: update cli documentation
Signed-off-by: Yves Brissaud <yves.brissaud@docker.com>
2023-03-24 19:52:17 +01:00
David Karlsson
c0402932ca scout: add docs for docker scout hub and cli
- add: new docker scout section
- add: advanced image analysis
- add: scout artifactory integration
- add: image details view
- add: docker scout cli reference
- change: hub vulnerability scanning
- change: security best practices (previously /develop/scan-images)
- change: prune references to docker scan
- deprecate: docker scan
- remove: atomist section
2023-02-24 15:25:56 +01:00
Guillaume Lours
3923985d51 Update Compose reference API to v2.16.0 (#16702)
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Co-authored-by: glours <glours@users.noreply.github.com>
2023-02-10 09:14:54 +00:00
Sebastiaan van Stijn
d62fa28810 engine: update reference docs for 23.0.0
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-02-01 20:29:56 +01:00
Sebastiaan van Stijn
0f35683784 reference: remove docs for deprecated "docker app"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-02-01 20:24:58 +01:00
David Karlsson
cb962307f5 fix: add redirect for /reference/commandline/run 2023-01-31 14:02:53 +01:00
David Karlsson
bc8fde23b9 doc refresh: Linux postinstall instructions (#15969)
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2022-10-26 09:08:21 +00:00
David Karlsson
8f77e55567 rename master -> main 2022-10-19 15:52:14 +02:00
CrazyMax
561118ec5b rename docs repository
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-29 11:07:53 +02:00
Justin Chadwell
fd9fe19061 lint: tidy up ordered list prefixes 2022-07-28 11:27:10 +01:00
CrazyMax
5088f2d82b fix redirects
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-07-13 18:02:43 +02:00
Usha Mandya
9403431ff7 Add Compose v2 reference (#14716)
* Add compose v2 reference
* Fix broken links
* Remove v1 compose reference files
* Remove Compose CLI completion

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-06-21 13:12:05 +02:00
Dan Bámíkíyá
da03cff6d7 Add link to Docker Compose repo to fix reference text 2022-02-11 15:52:36 +01:00
Usha Mandya
c13a6d5eff Remove cluster cli reference
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-10-11 15:59:59 +01:00
Sebastiaan van Stijn
8a85eaca60 update compose-cli reference docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 23:02:40 +02:00
Nicolas De Loof
041277d14d document compose.v2 new repository and RC3 release
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-09-02 12:34:00 +02:00
Sebastiaan van Stijn
1583678203 Add missing code-hints, and minor markdown edits
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
  put in separate blocks. With the "console" code-hint, this
  is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
  numbered-list to be interrupted.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-16 12:59:23 +02:00
Sebastiaan van Stijn
116e3a838f engine: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:20:02 +02:00
Sebastiaan van Stijn
54ed39dd1e fix missing stubs and TOC entries for docker compose
Also updated one link in language/golang to .md

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-07-30 10:22:35 +02:00
Usha Mandya
bfa7894d07 Merge pull request #12935 from usha-mandya/il-221
Remove Docker App docs
2021-06-07 09:49:47 +01:00
Usha Mandya
69a66dad14 Remove docker registry CLI reference
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-06-03 00:44:25 +01:00
Usha Mandya
6047b8f8bd Remove Docker App docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-06-03 00:16:18 +01:00
Metal
47260ee549 Remove Command-line reference to a removed feature of docker app 2021-05-10 17:59:38 +07:00
Anca Iordache
5161d0fd07 Document compose images command
Signed-off-by: Anca Iordache <anca.iordache@docker.com>
2021-04-15 17:59:04 +02:00
Sebastiaan van Stijn
1898b1b09c add buildx install/uninstall
these commands are hidden in the cli, but functional, and mentioned
in the "working with buildx" introduction.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-07 16:12:08 +02:00
Nicolas De Loof
4a68e6cca3 compose cli reference documentation
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-03-09 12:16:34 +01:00
Sebastiaan van Stijn
3ed7250644 Update engine reference for 20.10 release
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-12-09 00:50:04 +01:00
Sebastiaan van Stijn
2091f8ec57 engine/reference/commandline: disable read-time through config
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-22 17:08:00 +02:00
Sebastiaan van Stijn
c485685d74 reference: update buildx reference docs for v0.4.2
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-09-29 23:05:40 +02:00
Sebastiaan van Stijn
17ff6ff8fd engine: remove stub for deprecated top-level "deploy" command
This is a follow-up to d4ead1b120,
which removed the datafile for `docker deploy`, but didn't remove
the stub or removed it from the TOC.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-28 10:57:37 +02:00
Sebastiaan van Stijn
777c5d23da engine: use relative markdown links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:32 +02:00
Usha Mandya
77b9d95273 Remove Template docs 2020-03-23 16:46:42 +00:00
Usha Mandya
2caa6c64e6 Remove Assemble docs 2020-03-23 16:33:04 +00:00
Sebastiaan van Stijn
e4c227b0c9 reference: update "generated docs" comment
The "Sorry, but" was bothering me; no need to apologise :D

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 15:26:06 +01:00
Sebastiaan van Stijn
7fb9bc05e4 Merge pull request #9984 from thaJeztah/remove_engine_commands
Remove "docker engine" commands
2020-01-22 16:40:27 +01:00
Sebastiaan van Stijn
f24e2f1b4d Remove "docker engine" subcommands
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-22 15:49:27 +01:00
Sebastiaan van Stijn
d4ead1b120 Remove "bundle" subcommand and support for DAB files
Deploying stacks using the "Docker Application Bundle" (`.dab`) file
format was introduced as an experimental feature in Docker 1.13 /
17.03, but superseded by support for Docker Compose files in the CLI.

With no development being done on this feature, and no active use of the file
format, support for the DAB file format and the top-level `docker deploy` command
(hidden by default in 19.03), will be removed from the CLI, in favour of
`docker stack deploy` using compose files.

This patch removes documentation for the `docker-compose bundle` subcommand,
which was used to convert compose files into DAB files (and given the above,
will no longer be needed).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-22 15:34:58 +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
e1a28d694b Adding redirect
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-10-17 10:22:33 -07:00
Adrian Plata
60d5ae7d7e removing reading time from Reference
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-10-14 13:50:42 -07:00
Sebastiaan van Stijn
0266be38d7 Move cluster reference docs, and generate from YAML
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-06-20 14:27:17 +02:00