Commit Graph

40 Commits

Author SHA1 Message Date
bagratte f24fc7970e Proofread Swarm
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-05-09 07:51:51 +04:00
Justin Chadwell fd9fe19061 lint: tidy up ordered list prefixes 2022-07-28 11:27:10 +01:00
Sebastiaan van Stijn 3b71231970
engine/swarm: 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:56 +02:00
Sebastiaan van Stijn 2ce808edc0
Remove references to obsolete engine versions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-26 15:45:07 +01:00
Sebastiaan van Stijn 2b4833a355
Remove some references to enterprise products
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-07-02 23:36:48 +02:00
Sebastiaan van Stijn 777c5d23da
engine: use relative markdown links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:32 +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
Traci Morrison 6716217cb3 Add note on swarm mode restore process 2019-10-02 11:03:19 -04:00
Olly P 1328ae728b
Fix deadlink issue-9214 (#9243) 2019-08-12 15:51:13 +01:00
Constantin Galbenu c5c80569a0 Updated a broken link (#6650) 2018-05-10 09:01:30 -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
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
John Mulhausen add2f680e8 Default highlight.js off, dockerfile > conf highlighting, pygments (#2757)
* Default highlight.js off, dockerfile > conf highlighting, pygments

* Address feedback, style changes, markdownify reductions

* Getting rid of more markdownify

* Fix for right-hand nav spacing
2017-04-13 17:10:29 -07:00
Jim Galasyn d8a53c0677 Fix typo (#2504)
Added "try" per #2204
2017-03-27 16:11:24 -07:00
scjane a1f580fb11 Update admin_guide.md (#1967) 2017-02-24 13:51:18 -08:00
scjane ad5ddc3f76 Update admin_guide.md (#1968)
* Update admin_guide.md

Fixed an invalid link.

* Update admin_guide.md
2017-02-24 13:50:20 -08:00
Misty Stanley-Jones 551b30f319 Add info about backing up swarms
A little reorganization and clean-up along the way
2017-02-13 17:19:45 -08:00
Misty Stanley-Jones 9e29d0e03d Fix more broken links and images 2017-01-26 11:36:27 -08:00
Misty Stanley-Jones ef95a915eb Fixing broken links
Formatting improvements along the way
2017-01-25 11:51:14 -08:00
Misty Stanley-Jones 46e044ec59 Fixing double curly braces 2017-01-19 11:09:49 -08:00
Misty Stanley-Jones e3a3145cd9 Sync vnext-engine branch to docker/docker SHA 2f12d2808464dcfdf45e0920fd508ce0ff12bd29
This branch will contain forward-looking Engine-specific docs
and be the equivalent of docker/docker master for docs
2017-01-19 10:10:15 -08:00
Nathan Guse 49dafa36f2 Fix Recovering from losing the quorum link (#860) 2016-12-13 12:51:52 -08:00
Misty Stanley-Jones 67b2ea0565 Merge pull request #297 from mstanleyjones/swarm_service_create_no_suitable_node
Add to swarm admin docs
2016-12-12 11:12:45 -08:00
Matt Bentley d915deff95 Move rebalcing to be a top level item (#753)
Signed-off-by: Matt Bentley <matt.bentley@docker.com>
2016-11-30 14:53:42 -08:00
Misty Stanley-Jones c4c047f5f2 Add to swarm admin docs
- Add details about maintaining quorum
- Add details about pending tasks

Relates to #26017
Relates to #25069

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-11-28 15:59:18 -08:00
Gaetan a5e01e1844 fix type of keywords entry in frontmatter (in /engine/) (#552)
keywords should be a string, not an array containing one string

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-11 14:45:24 -08:00
Misty Stanley-Jones eb5c8670bc Change instances of alias: to redirect_from:
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-11-04 17:07:02 -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 1a193d749b Revert "Merge pull request #437 from gdevillele/fix_keywords_format"
This reverts commit 13ddc1350e, reversing
changes made to 7a11f05943.
2016-11-04 13:33:29 -07:00
Gaetan 8bb4d6226a fix more frontmatter keywords values (#439)
* fix format of frontmatter keyword entry in some .md files

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-04 10:48:38 -07:00
Misty Stanley-Jones 717d64348b Additional information about scaling a service
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-20 11:03:36 -07:00
Misty Stanley-Jones 62f4a04e39 Clarify what happens when a failed swarm node recovers
Fixes #105
2016-10-11 16:13:04 -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
John Mulhausen 0133cb646d Merge pull request #21 from pborreli/typos
Fixed typos
2016-09-30 11:51:42 -07:00
John Mulhausen 066b78bf86 Content rendering fixes 2016-09-30 01:51:56 -07:00
Pascal Borreli 6cd3fe8bd2 Fixed typos 2016-09-30 01:52:12 +01: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 9d5e59d503 Moved engine imported docs to the engine subdirectory 2016-09-29 11:19:31 -07:00