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>
Replace all occurrences of
```foo
{% raw %}
bar
{% endraw %}
```
(which generates spurious empty lines in the rendered pre block) with
{% raw %}
```foo
bar
```
{% endraw %}
Also, fix some occurrences where the raw section is too large and
prevented interpretation of Jekyll directives.
This is the syntax used in the documentation of Jekyll itself:
https://raw.githubusercontent.com/jekyll/jekyll/master/docs/_docs/templates.md
FTR, done with two perl substitutions:
'^([\t ]*```[^\n]*
)([ \t]*\{% raw %\}[^\n]*
)' '$2$1'
and
'^([ \t]*\{% endraw %\}[^\n]*
)([\t ]*```[^\n]*
)' '$2$1'
and manually tweaks. A mechanical check would be most useful.
Signed-off-by: Akim Demaille <akim.demaille@docker.com>
* 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
Instead of disabling templating for entire files, fix instances
individually by wrapping blocks in:
```{% raw %}
... content ...
{% endraw %}```
Signed-off-by: Benjamin R. Haskell <docker@benizi.com>
They're usually examples of Go-style text templates. But, Liquid templating is treating them as variable substitutions. E.g., in `engine/reference/commandline/ps.md`:
```bash
$ docker ps --filter volume=remote-volume --format "table {{.ID}}\t{{.Mounts}}"
```
is rendered as:
```bash
$ docker ps --filter volume=remote-volume --format "table \t"
```
Solution is to wrap entire files in `{% raw %} ... {% endraw %}` blocks.
Sebastiaan van Stijn