Commit Graph

43 Commits

Author SHA1 Message Date
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
Usha Mandya
c6b99e2a53 Revert "Adding advisory warnings about docker-machine" 2019-11-19 13:52:59 +00:00
Hamilton Turner
e99406c2cd Adding advisory to additional pages 2019-08-11 15:39:51 -04:00
paigehargrave
776f8e037d 404 fix (header information update) 2019-01-08 14:30:15 -05:00
JoeWrightss
186dc9dc2b Fix some typos
Signed-off-by: JoeWrightss <zhoulin.xie@daocloud.io>
2018-12-11 22:34:42 +08: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
Gwendolynne Barr
a55d0c9dfc Cleanup (#6864) 2018-06-11 12:48:24 -07:00
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
Yonghwan SO
3e10a321f3 added missing 'end block mark' which made broken block 2018-03-08 16:51:54 -08:00
Joffrey F
6d40a578ba Document new additions in Machine 0.14.0
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-03-06 13:14:33 -08: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
Harald Albers
265e547fd4 Fix docker-machine mount reference page (#5142)
* Fix reference page for `docker-machine mount`

Signed-off-by: Harald Albers <github@albersweb.de>

* Add reference page for `docker-machine mount` to navigation

Signed-off-by: Harald Albers <github@albersweb.de>
2017-10-30 09:56:26 -07:00
Anders Björklund
9ce2b2e893 Add documentation for new mount command (#4796)
The currently implementation uses sshfs (and FUSE) to mount.
It would be possible to make a Windows version, using Dokan.

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
2017-10-18 19:04:43 -07:00
Anders Björklund
df45999813 Add documentation for new scp --delta option (#2262)
* Add documentation for new scp --delta option

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
2017-10-18 19:04:43 -07:00
Victoria Bialas
1f99dfa207 Add more info re: Hyper-V driver for Docker Machine on Windows, cleanup, link topics together (#4609)
* add more links and info re: Hyper-V driver for Docker Machine on Windows

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

* added info on where Machine data lives

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

* added information about the Hyper-V Manager

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

* linked between docker-machine create command and other relevant topics

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

* copyedits

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

* copyedits, added Examples heading to create driver

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

* clarifed docker-machine create example

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-09-13 12:30:15 -07: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
3a7abe1394 Update restart.md (#3318) 2017-06-02 11:54:13 -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
Steven Hanna
b43c302c46 Spelling mistakes (#2970)
* Spelling mistakes

* Delete last_page.md
2017-04-20 17:26:18 -05:00
Victoria Bialas
4b9493d276 fleshed out Machine scp command description, fixed Compose file notes (#2265)
copyedit to fix typo

wrapped text properly

replaced original example with Nathan's

added a better sub-title

specifically mentioned not using relative paths

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-10 16:30:26 -08:00
Victoria Bialas
fd49e78fb0 clarify syntax on swarm heartbeat for create machine command
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2016-11-21 11:40:28 -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
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
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
Zahim Anas
e0decc85ca [docker-machine ] Adding machine provision reference link 2016-10-17 12:48:29 +01: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