Commit Graph

40 Commits

Author SHA1 Message Date
Sebastiaan van Stijn
4c50937eff Merge pull request #13108 from altimmons/patch-1
Update environment-variables.md to include critical syntax info
2021-08-27 16:42:45 +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
ae3b5b66f9 compose: 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:07 +02:00
Andy Timmons
e2162d8b64 Update environment-variables.md to include critical syntax info
I looked forever to find this information.  The expected section to find this information is this page, not where it ends up at the bottom of overview.

Based on the v3 overview of compose-files, it seems it can be included with this line- as thats how they did it there.

A link would also work, or a copy of the whole section.  Using include has the added benefit however of making a single section with changes updated across the docs if needed.
2021-07-02 11:05:13 -04:00
satotake
0b239bddde compose: make project directory explicit (#12978)
* compose: make `project directory` explicit

See https://github.com/docker/compose/issues/8347 .
Some users assume that `project directory` is the directory which has `docker-compose.yaml`.
But this is not true (at least for now) when you execute `docker-compose` in sub directory.
This PR makes it clear.

* fix a typo and made style updates

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-06-11 11:20:21 +01:00
Kaden Scott
291db7791f Remove trailing dot from filename 2021-05-01 21:53:29 -04:00
Anca Iordache
cc6762ecd3 Update docs on Compose environment files (#12514)
* Reorganize sections for variable substitution and document .env file path change for `1.28`

Signed-off-by: Anca Iordache <anca.iordache@docker.com>

* Minor style edits

* Minor style edits

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-03-23 21:42:08 +00:00
Usha Mandya
5c64b4230a Remove references to v1 from other topics
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-15 19:35:03 +00:00
Usha Mandya
79ef26b640 Minor update 2021-01-20 18:32:44 +00:00
Nicolas De Loof
7c8c667165 clarification on .env file lookup vs project-directory
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-01-20 17:20:14 +01:00
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
2eff941697 compose: move deprecated env-vars section, and fix duplicate redirects
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-07 12:49:30 +02:00
Usha Mandya
7d9d5f3aac Minor style updates 2020-08-26 13:40:21 +01:00
Muma David Bwalya
231b04065e Update environment-variables.md
I'm not sure if these are in the right place, but I think it's really important it's somewhere.

Closes issue https://github.com/docker/docker.github.io/issues/11286
2020-08-24 17:48:26 +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
Daniel Peukert
f2093d4e2a Fixed env_file anchor in environment-variables.md (#8764) 2019-05-09 11:35:31 -07:00
Maria Bermudez
aaca9b83b5 Revert "Revert "Merge branch 'master' of github.com:docker/docs-private into test-branch-2""
This reverts commit 4c95d161ca.
2018-08-29 19:01:03 -07:00
Maria Bermudez
4c95d161ca Revert "Merge branch 'master' of github.com:docker/docs-private into test-branch-2"
This reverts commit af5f2fcc38, reversing
changes made to 338b690d26.
2018-08-29 18:37:44 -07:00
Maria Bermudez
840c167055 Revert "Revert "Merge branch 'master' of github.com:docker/docs-private into test-branch-2""
This reverts commit 14080c18bd.
2018-08-29 18:36:03 -07:00
Maria Bermudez
14080c18bd Revert "Merge branch 'master' of github.com:docker/docs-private into test-branch-2"
This reverts commit af5f2fcc38, reversing
changes made to 338b690d26.
2018-08-29 14:47:31 -07:00
Tammy Fox
27d22a2e8d fix list formatting 2018-08-06 16:07:11 -04:00
Niels Sorensen
1b85085ca9 Insert shell env var into env var priority order
As mentioned in lines 115 through 117, "Values in the shell take precedence over those specified in the `.env` file. If you set `TAG` to a different value in your shell, the substitution in `image` uses that instead:".

This context should also be represented in the order of priority in which variables are processed.
2018-07-25 15:36:01 -04:00
Rajin Gill
04cf355bb8 Typo 2018-03-12 14:18:23 -07:00
Joao Fernandes
f3804e6012 Clarify order for overriding env vars 2018-03-09 13:23:31 -08:00
Joao Fernandes
d670e54ac3 Update compose env to comply with styleguide 2018-03-09 13:23:31 -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
Gwendolynne Barr
484e0de1b0 Update environment-variables.md 2017-10-18 19:14:06 -07:00
Wang Jie
5a06815e6b Update environment-variables.md 2017-10-18 19:14:06 -07:00
Franz Josef Kaiser
f02c1003c2 Explain precedence of environment variables (#3496) 2017-06-13 11:50:48 -07:00
Suraj Narwade
553db19401 Explains order of precedence between env-file and env (#2903)
Resolves #1312
2017-04-20 15:29:00 -05:00
buuren
3275110fb1 Update environment-variables.md
Anchor #env-file does not exist. Correct anchor is #envfile
2016-12-14 12:18:37 +02:00
Jonas Friedmann
4d83c1bb08 Add missing dollar-sign / consistent shell style (#426)
* Add missing dollar-sign

* Remove dollar-sign for single commands without output
2016-11-10 14:54:49 -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
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