Commit Graph

16 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
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
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
Tom Vincent
1d5d5cb29c Fix rm removes typo 2018-08-12 10:37:34 +01: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
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
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