Commit Graph

23 Commits

Author SHA1 Message Date
Sebastiaan van Stijn 3a794b3197
(temporarily) replace compose-file deep links to v3 docs
The documentation curently doesn't contain reference docs for the
unified (version-less) compose-file syntax, so for now replacing
all links to point to the v3 compose-file reference, which is still
present.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-01-07 14:21:37 +01:00
Sebastiaan van Stijn 9f4db87055
compose: add WordPress example to TOC
Also removes links to individual examples, instead linking
to the "compose samples" page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-28 14:35:50 +02:00
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
Ivan V 4836139458 Grammar fix
Grammar fix
2018-03-08 16:50:58 -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
Wang Jie fb163a2288 Update env-file.md 2017-10-18 19:14:06 -07:00
Victoria Bialas a922be3d0f Update admonitions CSS for consistency and better writer workflow (#4019) 2017-07-31 21:49:56 -07:00
Emiliano 'AlberT' Gabrielli cd3bd1dccd Clarify on quotation marks (#3503)
Spent a lot trying to issue why Mysql password was not set in the container .. it was caused by having quoted it!
2017-06-13 11:49:41 -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 b62449b3c8 clarified logging options in Compose, fixed glaring note formats (#3272)
* clarified logging options in Compose, fixed glaring note formats

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added link directly to JSON driver in supported drivers docs

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* took off code tags to make link stand out

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed alignment of note text in markdown

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* x-ref to how to set environment variables in containers

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* copyedit in note

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-05-16 12:02:54 -07:00
Misty Stanley-Jones fb7c73908b Update the styleguide (#2332)
* Update the styleguide

Also normalize admonition titles with the colon outside the bold.
2017-03-15 09:46:30 -07:00
Victoria Bialas d784ad5c1f added more detail for Compose env (#2310)
incorporated Joffrey's comment

fixed heading levels

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-14 14:30:35 -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
Victoria Bialas b2eb693d00 Merge remote-tracking branch 'upstream/master' into vnext-compose-1.9.0-merge 2016-11-16 12:03:45 -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
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 1a193d749b Revert "Merge pull request #437 from gdevillele/fix_keywords_format"
This reverts commit 13ddc1350e, reversing
changes made to 7a11f05943.
2016-11-04 13:33:29 -07:00
Gaetan 8bb4d6226a fix more frontmatter keywords values (#439)
* fix format of frontmatter keyword entry in some .md files

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-04 10:48:38 -07:00
Joffrey F 4c3cf8e7fd Update docs to mention new additions in Compose 1.9.0
Signed-off-by: Joffrey F <joffrey@docker.com>
2016-11-03 15:05:24 -07: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