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>
The `hide_from_sitemap` metadata variable was a custom thing we implemented
to add a "noindex" meta-header to pages and to exclude a page from the
search auto-complete.
However, pages with that option set would still be included in sitemap.xml,
resulting in search engines to visit those pages (only to discover they
should not index them).
This patch replaces the custom `hide_from_sitemap` value for `sitemap: false`,
which is a metadata variable that's defined by the "jekyll-sitemap" plugin
we use to generate the sitemap.xml;
https://github.com/jekyll/jekyll-sitemap/blob/v1.4.0/README.md#exclusions
Setting this variable will now:
- add a "noindex" metadata header to the page
- exclude the page from the sitemap.xml.
- exclude the page from /js/metadata.json (used for search autocomplete)
Also fixed an issue in the metadata.json where the `notoc` metadata was
used to exclude pages, however that variable is meant to disable the
in-page TOC (right-hand side navigation with anchor links).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
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>
* 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>
* 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
* for all links to , changed to full path
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed link in Swarm Tutorial per review comments
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* clarified ordering of env files
* added env_file order of precedence to v1, v2 Compose
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* formatting
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added links to Compose release versions, improved matrix description
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* review comments, used include for matrix in all file references
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* incorporated review comments
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added Anaconda Python 3.5.2 install/run to known issues
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added notes re: Python 3.x not supported in setup and install
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed heading levels in Cloud known errors
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed links (moby --> docker), formatting
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed on-page link list alignments for toc max/min topics
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* 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>
Compose file v1 and v2 docs had relative links to some non-existing pages (especially about extending services). It was probably introduced when `compose-file.md` was detached into directory with single file per compose file version.
pruning Compose file v2 reference
updated Compose v1, v2, v3 files, still WIP
added includes for compatibility matrix, fixed TOC menu
new topic organziation Compose reference, split two 3 files plus versioning
Daniel's comments, fixed links, added more to versioning details
fixed volumes_from example per Daniel's comments for v1
simplified links to version references
copyedits and improved/surfaced links to versioning/upgrade docs
removed for version specific content re: volume_drivers from various files
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Sebastiaan van Stijn
Sebastiaan van Stijn
Sergey Bon
Oscar Caballero
Misty Stanley-Jones
Wenxuan Zhao
Victoria Bialas
Mateusz Kurek
Joe Meissler
Joffrey F
Victoria Bialas