Commit Graph

25 Commits

Author SHA1 Message Date
Sebastiaan van Stijn 0f3caaca6a
compose: use relative markdown links
Unfortunately, the only reliable way to create internal links
is to use relative links to other Markdown files. This does
match the way links on GitHub work, but makes it harder to
create these links.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:10 +02:00
Sebastiaan van Stijn 331554f4b3
Fix various links that were generating URLs with `.md` (#10548)
* Fix incorrect links in compose section

there's a bug causing wrapped links to not work, and replacing
some links to point to the .md file, so that IDE's can check
if the anchors are valid. Also replaced some links to point
to their new location.

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

* engine/swarm: update links

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

* Fix various broken links

There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work.
Also replacing some links to point to the .md file, so that IDE's can check if the anchors
are valid. Finally, replaced some links to point to their new locations, so that users don't
get redirected..

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-01 12:05:50 +01:00
Douglas Naphas 3512d96117 Make minor grammar corrections (#9471) 2019-09-19 10:50:33 +01:00
Joffrey F 12757bf953 Compose 1.20.0 (#6266) 2018-03-20 11:23:36 -07:00
Misty Stanley-Jones a55ddf60a9
Move /engine/installation to /install (#5651)
* Move /engine/installation to /install

* Add Docker for IBM Cloud to the matrix
2018-01-26 10:29:14 -08:00
Misty Stanley-Jones a4f5e30249
Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788)
* Reword lots of instances of 'will'

* Reword lots of instances of won't

* Reword lots of instances of we'll

* Eradicate you'll

* Eradicate 'be able to' type of phrases

* Eradicate 'unable to' type of phrases

* Eradicate 'has / have to' type of phrases

* Eradicate 'note that' type of phrases

* Eradicate 'in order to' type of phrases

* Redirect to official Chef and Puppet docs

* Eradicate gratuitous 'please'

* Reduce use of e.g.

* Reduce use of i.e.

* Reduce use of N.B.

* Get rid of 'sexagesimal' and correct some errors
2018-01-25 17:37:23 -08:00
Logan Rakai 1ff98b6467 Typo Correction (#5550) 2017-12-18 15:37:13 -08:00
Joffrey F 0702f23aae Document Compose 1.16.0 additions (#4293)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-08-31 15:52:18 -07:00
Victoria Bialas 5522090c0f surfaced -f, -p options on docker-compose (#3586)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-13 10:49:55 -07:00
Victoria Bialas c239914df6 Compose CLI reference copyedits (#3499)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-05 17:35:44 -07:00
padoo fabedfbc8b Update overview.md (#2805)
It should say 'predecessors', not 'successors'. Otherwise the sentence and the subsequent example don't make sense.
2017-04-16 17:00:39 -07:00
Wang Jie 2b009778e3 Update overview.md (#2578) 2017-03-31 14:20:30 -07:00
Victoria Bialas 93bab5a66f Vnext compose (#2509)
* Adds documentation about the `--ignore-override` option

For PR https://github.com/docker/compose/pull/4543

When option `--ignore-override` is provided the `docker-compose.override.yml`
file, if it exists, will not be considered for any command. This option
has no effect when the `-f` option is used as that explicitly lists the
set of files to be considered.

Signed-off-by: Dennis Gove <dpgove@gmail.com>

* Compose 1.12.0 additions (#2472)

* Add mem_reservation to list of v2 options

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add dns_opt to v2 service configuration

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add pids_limit to service configurations

Signed-off-by: Joffrey F <joffrey@docker.com>

* Update list of options for docker-compose rm

Signed-off-by: Joffrey F <joffrey@docker.com>

* Update list of options for docker-compose config

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add --exit-code-from to docker-compose up documentation

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add --parallel to docker-compose pull reference

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add build-args to docker-compose build reference

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add --volume to docker-compose run reference

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add --project-directory to list of docker-compose options

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add reference docs for images command

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add documentation for COMPOSE_PATH_SEPARATOR

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add documentation for cache_from option

Signed-off-by: Joffrey F <joffrey@docker.com>
2017-03-28 10:50:44 -07:00
Victoria Bialas 4a70dd4cb2 removed on-page topic menu from ref pages
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-17 18:02:58 -08:00
John Mulhausen 9abc9e9f41 Add documentation for new top command (#1534) (#1601)
Update command lists to include recent additions

Signed-off-by: Joffrey F <joffrey@docker.com>
2017-02-10 13:59:06 -08:00
LRubin 7da6a0bd21 add 'none' cue to large screentext block
...to prevent weird syntax highlighting.
2016-11-17 09:31:06 -08:00
Gaetan 2ea564166d fix type of keywords entry in frontmatter (in /compose/ dir) (#481)
keywords should be a string, not an array containing one string

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-07 13:18:56 -08:00
Misty Stanley-Jones eb5c8670bc Change instances of alias: to redirect_from:
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-11-04 17:07:02 -07:00
John Mulhausen 558314bf56 Converges titles to imperative-form, front-matter based, and sentence-case (#438)
Multiple title fixes, consistency fixes, convergence into metadata-based titles.
2016-11-04 15:38:40 -07:00
Misty Stanley-Jones 0827ba283c Revert "fix frontmatter keywords values in compose/reference/ files" 2016-11-04 13:28:43 -07:00
Gaetan de Villele bb4f3be02e fix frontmatter keywords values in compose/reference/ files
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-03 10:13:21 -07:00
Bin Liu c8b449e7e0 remove redundant back slash
I think this is a redundant back slash, should be removed.
2016-10-18 22:31:25 +08:00
Misty Stanley-Jones d53c6798c9 Convert TOML to YAML, tweaks to work with Jekyll 2016-09-29 17:16:03 -07:00
Misty Stanley-Jones 701f170a21 Move docker-hub docs to docker-hub subdirectory 2016-09-29 10:38:52 -07:00
Misty Stanley-Jones 7629f462d5 Moved compose docs to compose subdirectory 2016-09-28 14:52:24 -07:00