Commit Graph

12 Commits

Author SHA1 Message Date
Akim Demaille 14b53b68c3 Jekyll: don't put {% raw %} directives in pre blocks
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>
2018-03-13 10:28:29 -07: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 57757ddcfd Merge pull request #409 from mstanleyjones/fix_liquid_warnings
Fix some Liquid warnings
2016-11-04 16:11:50 -07: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 20a6e1f31b Fix some Liquid warnings 2016-11-01 09:45:00 -07:00
Joao Fernandes 5ea225187a Update code blocks in machine/reference 2016-10-25 13:58:10 -07:00
Benjamin R. Haskell 362e94b2bc Disable Liquid templating for blocks with `{{`
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>
2016-10-07 00:58:08 -04:00
Benjamin R. Haskell 65ec3a3763 Revert pull request #48
Reverts commit b3a620808a in order to
replace it with more-targeted blocks.
2016-10-07 00:56:17 -04:00
Benjamin R. Haskell b3a620808a Fix formatting for Markdown files containing `{{`
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.
2016-10-05 01:58:24 -04: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