Commit Graph

53910 Commits

Author SHA1 Message Date
Sebastiaan van Stijn b7cf4b0888
Merge pull request #10332 from usha-mandya/engine-api-patch
Fix Engine API toc
2020-02-25 13:43:10 +01:00
Usha Mandya 787e383322
Merge pull request #10342 from thaJeztah/improve_compose
Improve building docs with compose
2020-02-25 12:10:35 +00:00
Usha Mandya adda3900e8
Merge pull request #10343 from thaJeztah/engine_api_layout
Engine API: use template for API reference pages
2020-02-25 12:01:59 +00:00
Sebastiaan van Stijn 16d565cae6
API remove section about enterprise API version mismatch
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:27 +01:00
Sebastiaan van Stijn 3a223f799c
SDK: fix some minor issues in go examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:25 +01:00
Sebastiaan van Stijn c7c1a59dab
API docs: recommend using version negotiation
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:23 +01:00
Sebastiaan van Stijn 9774d43d65
SDK: remove reference to obsolete Go version
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:21 +01:00
Sebastiaan van Stijn d021c47d26
Remove duplicated API reference from SDK docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:19 +01:00
Sebastiaan van Stijn c4309a1ef7
Remove duplicated SDK content from API overview
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:17 +01:00
Sebastiaan van Stijn ee407ac0ef
Move SDK examples under "sdk"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:06 +01:00
Sebastiaan van Stijn f757d8a14b
Engine API: use template for API reference pages
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 13:58:30 +01:00
Sebastiaan van Stijn ebc86d840a
compose file: use v3 and no volume
The current target didn't have jekyll installed, so mounting the
source-files didn't do anything.

This patch removes the bind-mount.

Alternatively, we could switch back to using a jekyll stage (with
automatic rebuilding).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 13:56:22 +01:00
Sebastiaan van Stijn 24c0299e4e
compose file: disable archives by default
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 13:56:20 +01:00
Sebastiaan van Stijn 40b1b403e8
compose file: enable buildkit for building
This adds a `.env` file to enable buildkit when using
docker-compose to build the docs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 13:56:16 +01:00
Usha Mandya f56f1476ac
Merge pull request #10331 from thaJeztah/archives_and_source_only
Dockerfile: allow building without archives, and exporting HTML source
2020-02-24 12:24:02 +00:00
LORIS INTERGALACTIQUE 711567c5af
Fixed typos on the rootless mode page (#10330)
* Fixed typos

* Minor wording update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2020-02-21 17:52:37 +00:00
Usha Mandya 1566e01673 Moved topics under engine/api/ 2020-02-21 16:44:41 +00:00
Usha Mandya 797daef4cc fix Engine API toc 2020-02-21 12:10:09 +00:00
Sebastiaan van Stijn c8b335c3b8
Dockerfile: add target to output the generated HTML
This patch adds a stage that only contains the generated files. It can
be used to export the generated HTML for hosting the documentation on a
non-containerised service (e.g. to deploy to an s3 bucket).

When using BuildKit, use the `--output` option to build the files and to
copy them to your local filesystem.

For example, to build current docs, including archives:

    DOCKER_BUILDKIT=1 docker build --target=deploy-source --output=./_site .

And to build without archives:

    DOCKER_BUILDKIT=1 docker build --target=deploy-source --build-arg ENABLE_ARCHIVES=false --output=./_site .

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-21 10:51:14 +01:00
Sebastiaan van Stijn 136a8d3f96
Dockerfile: allow building docs without archives
This adds a `ENABLE_ARCHIVES` build-arg, which allows building
the documentation without archives.

Note that currently, the archives drop-down is still added
unconditionally (so also included if archives are disabled).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-21 10:51:11 +01:00
Sebastiaan van Stijn a6a470e4e9
Dockerfile: use "from scratch" image to collect archives
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-21 10:51:09 +01:00
Usha Mandya a4ae7f1b7c
Updated Desktop URLs and removed CSP and EE URLs (#10322)
* Updated Desktop URLs and removed CSP and EE URLs

* Added Get started and removed Get docker URLs
2020-02-20 14:37:40 +00:00
Ulysses Souza aa5e9db1c6
Update docker-compose release notes and version to 1.25.4 (#10328)
* Update docker-compose release notes and version

Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>

* Minor edits

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2020-02-20 12:17:55 +00:00
Sebastiaan van Stijn 6de87b1476
Move classic overlay networking topic to swarm standalone section (#10326)
* Move classic overlay networking topic to swarm standalone section

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Redirect old "getting started with overlay networks" to current page

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-20 12:16:04 +00:00
Jeremy 3613831c93
Fix broken link in mac FAQs (#10324)
* Fix broken link in mac FAQs

The title of the linked section has changed to "Add TLS Certificates". The current link goes to the top of the Getting Started page and is confusing because you have to scroll past the Kubernetes section to get to the section you actually need.

* Fix broken link to mac FAQs

I missed removing `/index` in the first commit. This is the correct link. Thanks to thaJeztah for the correction.

Co-Authored-By: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>

Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2020-02-20 01:15:12 +01:00
Sebastiaan van Stijn 8bf2bbb44e
Merge pull request #10323 from Dawn-Wood/fix-redirect
redirect for /enterprise replaced to fix a ton of 404 errors
2020-02-19 23:52:49 +01:00
Dawn W Docker 07f4fffc1e redirect for /enterprise replaced to fix a ton of 404 errors 2020-02-19 12:23:38 -08:00
Usha Mandya 2598e0987d
Removed the sign in req from mac install (#10319) 2020-02-19 11:27:47 +00:00
Stefan Scherer 200f25db82
Update links to get Docker Desktop from Docker Hub (#10318)
Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>
2020-02-19 11:08:18 +00:00
Michael Ziegler a9b5a33dd0
improve description of iptables design, add notes about securing Docker hosts (#10263)
* improve description of iptables design, add notes about securing Docker hosts

* fix typo

* simplify a sentence

* fix chain name

* more minor changes

* add notes about the FORWARD chain policy

* shorten section on --ip

* rephrase section title
2020-02-18 17:19:45 +00:00
Usha Mandya 7b7af317c4
Merge pull request #10310 from usha-mandya/get-started-patch
Get started updates: fix hyperlinks and review comments
2020-02-18 14:14:27 +00:00
Usha Mandya 942fcb15cf fix hyperlinks and review comments 2020-02-18 12:18:07 +00:00
Usha Mandya b1900aa5d2
Merge pull request #10289 from usha-mandya/mac-sys-req-patch
Update macOS system requirements
2020-02-18 10:30:30 +00:00
Usha Mandya 7aa6a90dee
Merge pull request #10305 from usha-mandya/yaml-format-patch
Add markdown lint json file
2020-02-18 10:17:44 +00:00
Usha Mandya 658092ce1f update ordered lists to fix yaml formatting issues 2020-02-17 15:49:52 +00:00
Usha Mandya 8a93a1ccff add mdlint json file to fix yaml copy/paste issues 2020-02-17 15:36:32 +00:00
Sebastiaan van Stijn 7a7483570c
Merge pull request #10304 from usha-mandya/yaml-format-patch
fix yaml formatting
2020-02-17 16:29:33 +01:00
Usha Mandya 72fd8b33c9 fix yaml formatting 2020-02-17 13:11:34 +00:00
Usha Mandya 1c21115688
Merge pull request #10302 from iwpnd/master
fixed formatting in swarm-deploy.md
2020-02-17 11:33:17 +00:00
Usha Mandya 1069a317ad
Merge pull request #10301 from shunwen/patch-1
Fix mismatch port number describing `EXPOSE 8080`
2020-02-17 11:19:14 +00:00
Ben 0f9158f540
fixed formatting in swarm-deploy.md
- fixed formatting in section "Describe apps using stack files" to properly show code section and quote
2020-02-16 14:22:06 +01:00
shunwen 292a8bc04a
Fix mismatch port number describing `EXPOSE 8080` 2020-02-16 20:12:11 +08:00
Usha Mandya 36aba6a7c6
Get started docs updates (#10218)
* Update Get started docs

* update part-1, add redirects

* draft updates to part 2 and 3

* tidy up the orchestration topics

* update examples, and other minor edits

* address Stefan's review comments

* moved orchestration to a new node

* fix Ben's review comments

* add email verification step

* Emphasize the CTA in part 3
2020-02-14 17:24:50 +00:00
Usha Mandya 4e2143de9e
Merge pull request #10228 from terryburton/patch-1
Update overlay.md
2020-02-13 16:28:20 +00:00
Usha Mandya f1a3d77402 update macOS sys reqs 2020-02-13 14:58:17 +00:00
Usha Mandya 9a555769d5
Merge pull request #10280 from omegamormegil/patch-23
removed space in DTR image backup command
2020-02-13 14:34:29 +00:00
Usha Mandya 580bcb41a8
Merge pull request #10168 from mnimm/patch-2
Update content_trust.md
2020-02-13 14:27:12 +00:00
Usha Mandya bbee70403d
Merge pull request #10287 from thaJeztah/add_back_anchorlinks
Re-enable "anchorlink" script
2020-02-13 13:10:57 +00:00
Sebastiaan van Stijn 5276ea1d9f
Re-enable "anchorlink" script
This allows for easier sharing of links to specific sections
on a page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-13 12:48:12 +01:00
Sebastiaan van Stijn b633d3c21c
Merge pull request #10286 from usha-mandya/notary-patch
update notary toc
2020-02-13 11:41:35 +01:00