Commit Graph

19 Commits

Author SHA1 Message Date
Sebastiaan van Stijn
20bbd99d44 machine: 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:19:22 +02:00
Sebastiaan van Stijn
26926972ea machine: handle indexing through config
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-21 15:32:17 +02:00
Sebastiaan van Stijn
03d60f916a Replace "hide_from_sitemap" with "sitemap: false"
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>
2020-10-21 15:09:11 +02:00
Sebastiaan van Stijn
eb948508c1 various: use relative markdown links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:53 +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
Sebastiaan van Stijn
19c6cb8f1c Markdown: fix some code-hints
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 14:50:31 +01:00
Usha Mandya
a247c105f7 Update the metadata and keywords for SEO (#10030)
Updated the metadata and keywords for seo
2019-12-13 15:27:59 +00: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
098da6fe21 Update env.md (#4485)
Change "a HTTP xxx" to "an HTTP xxx".
2017-09-01 12:59:44 -07:00
Wang Jie
4c2f2c1d12 Update env.md (#3892) 2017-07-18 13:47:24 -07:00
Wang Jie
21c4dcc420 Update env.md (#3317)
* Update env.md

* Update env.md
2017-06-02 11:53:06 -07:00
Victoria Bialas
ab47785dc7 Machine unset env var, Cloud updates (#3146)
* added unset env instructions

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

* machine env details, cloud swarm updates, copyedits

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

* fix per review, add Azure to note

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-05-03 12:01:33 -07:00
Gaetan
75fe044313 fix type of keywords entry in frontmatter (in /machine/) (#556)
keywords should be a string, not an array containing one string

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-11 14:51:12 -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
Tino Breddin
69283150a5 FreeBSD: add build support
Signed-off-by: Tino Breddin <t@tolbrino.com>
2016-11-02 09:54:44 -07:00
Misty Stanley-Jones
d6ef6d5bb9 added info about d4mac, d4win in preparation for v1.12 publish set
copy-edit to remove extra/repeated info not needed in both sections

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2016-11-02 09:16:45 -07:00
Joao Fernandes
5ea225187a Update code blocks in machine/reference 2016-10-25 13:58:10 -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
17f54b8475 Move machine docs to machine subdirectory 2016-09-28 20:45:49 -07:00