Add display name for tags in swagger.yaml #29401
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In moby#29071, we made the tags the correct name for generating types, at the expense of the menu in the documentation looking good. ReDoc now has support for tag display names ( Redocly/redoc#152 ), so we can assign a more human-friendly name to the menu items. Signed-off-by: Ben Firshman <[email protected]>
vdemeester
approved these changes
Dec 14, 2016
bfirsh
added a commit
to bfirsh/docker.github.io
that referenced
this pull request
Dec 15, 2016
To make use of x-displayName added in moby/moby#29401 Signed-off-by: Ben Firshman <[email protected]>
johndmulhausen
pushed a commit
to docker/docs
that referenced
this pull request
Dec 16, 2016
To make use of x-displayName added in moby/moby#29401 Signed-off-by: Ben Firshman <[email protected]>
johndmulhausen
pushed a commit
to docker/docs
that referenced
this pull request
Jan 19, 2017
* Sync vnext-engine branch to docker/docker SHA 2f12d28 This branch will contain forward-looking Engine-specific docs and be the equivalent of docker/docker master for docs * swarm: Document rollback, failure threshold, and monitor flags These are new flags to service create/update being added in a Docker engine PR. Signed-off-by: Aaron Lehmann <[email protected]> * Remove Fedora 22 as it's EOL https://fedoramagazine.org/fedora-22-end-of-life-2016-july/ With the recent release of Fedora 24, Fedora 22 will officially enter End Of Life (EOL) status on July 19th, 2016. After July 19th, all packages in the Fedora 22 repositories will no longer receive security, bugfix, or enhancement updates, and no new packages will be added to the Fedora 22 collection. Upgrading to Fedora 23 or Fedora 24 before July 19th 2016 is highly recommended for all users still running Fedora 22. Signed-off-by: Sebastiaan van Stijn <[email protected]> * update apparmor documentation to reflect changes in 1.13.0 Updates the apparmor docs to reflect recent changes, specifically that we are no longer saving to /etc/apparmor.d/. Also removes the seccomp profile and instead links to the generating template. Signed-off-by: Christopher Jones <[email protected]> * Added details about tag support for AWS log driver Signed-off-by: French Ben <[email protected]> * Changed wording for tag description * Updated docs to show full container ID * Updated wording on log stream default Signed-off-by: French Ben <[email protected]> * Added raw tags Signed-off-by: French Ben <[email protected]> * Update note about custom certs with system certs Fixed incorrect statement about example layout Related to moby/moby#27918 Signed-off-by: Derek McGowan <[email protected]> (github: dmcgowan) * Remove Ubuntu 15.10 Wily Werewolf As of July 28, 2016, Ubuntu 15.10 is officially EOL (https://lists.ubuntu.com/archives/ubuntu-announce/2016-July/000210.html), and will receive no further updates. Support for 15.10 was removed in Docker 1.13 through moby/moby#27042 (moby/moby@e9a8105) Signed-off-by: Sebastiaan van Stijn <[email protected]> * Add Ubuntu 16.10 Yakkety Yak Support for Ubuntu 16.10 was added in moby/moby#27993 (moby/moby@27beb64) Signed-off-by: Sebastiaan van Stijn <[email protected]> * add unix-sockets support in Fluentd logging driver Signed-off-by: Akira Koyasu <[email protected]> * Add engine changes that were lost in syncing When syncing docs from the docker/docker repository (e4bce35) some commits were not included. This includes those changes, by copying the documentation from moby/moby@8658748, which is the last commit before the docs were removed from the docker/docker repository in moby/moby@29f08cf Signed-off-by: Sebastiaan van Stijn <[email protected]> * Create logentries.md (#244) * Create logentries.md Signed-off-by: Carlos Alexandro Becker <[email protected]> * Add NATS client as option for publishing container logs (#369) * Add NATS client as option for publishing container logs Signed-off-by: Waldemar Quevedo <[email protected]> * Document ability to update a service's image Fixes #528 Signed-off-by: Misty Stanley-Jones <[email protected]> * First version of stack deployment tutorial Signed-off-by: Aanand Prasad <[email protected]> * Initial dump of CLI in yaml (#737) Signed-off-by: French Ben <[email protected]> * Document new CPU scheduling flags Signed-off-by: Misty Stanley-Jones <[email protected]> * Update dockerfile vnext (#874) * Merge pull request #731 from mstanleyjones/distribution_docs_from_upstream Pull distribution reference docs from upstream repo * Bump Engine ref docs branch to 1.13.x Signed-off-by: Misty Stanley-Jones <[email protected]> * Rename Remote API to Engine API See moby/moby#28319 Signed-off-by: Ben Firshman <[email protected]> * Move accounts API docs to Docker ID section Makes more sense here instead of the Engine reference. It is only consumed by the Engine. Signed-off-by: Ben Firshman <[email protected]> * Add automatically generated Engine API docs Signed-off-by: Ben Firshman <[email protected]> * Upgrade to ReDoc 1.6.2 (#891) To make use of x-displayName added in moby/moby#29401 Signed-off-by: Ben Firshman <[email protected]> * Add full documentation for APIs and SDKs Signed-off-by: Ben Firshman <[email protected]> * Updated Yaml files (#922) Signed-off-by: French Ben <[email protected]> * Added latest docs from Editions AWS & Azure (#887) * Added Docker for AWS and Azure and moved navigation Signed-off-by: French Ben <[email protected]> * Fixed image links Signed-off-by: French Ben <[email protected]> * Restructure navigation for Editions * Fixing double curly braces * YAML-sourced CLI refdocs * Add 'docker' label to commands * Fix for blank node * Document Docker secrets Fixes #529 Signed-off-by: Misty Stanley-Jones <[email protected]> * Update syntax of the -f flag in the examples * Update the syntax of 'docker secret create' in the examples * Document the ability to publish a port locally on a swarm node * Add info about image resolution with content trust * Add examples to CLI generation templates * remove confusing sentence from "publishing" section the routing mesh should work irregardless of all replicas being up or not, so removing this sentence. Signed-off-by: Sebastiaan van Stijn <[email protected]> * Rewrite and reorganize Linux install instructions Signed-off-by: Misty Stanley-Jones <[email protected]> * Fix typo in Oracle install instructions * Updated docs to remove beta and stable link (#1160) * Updated docs to remove beta and stable link * Addressing feedback from new installation instructions (#1172) * Address feedback for new installation instructions * Updating the repo files for Oracle since does not expand to only the number * Added latest docs from Editions AWS & Azure (#887) * Added Docker for AWS and Azure and moved navigation Signed-off-by: French Ben <[email protected]> * Fixed image links Signed-off-by: French Ben <[email protected]> * Restructure navigation for Editions * Fix a couple of Liquid errors * Merge pull request #1188 from docker/linkfix-john Link fixes and link to app tutorial
johndmulhausen
added a commit
to docker/docs
that referenced
this pull request
Jan 19, 2017
* d4mac, d4win stable 1.12.5 and beta 34 updates Signed-off-by: Victoria Bialas <[email protected]> * fix punctuation typos (#949) Signed-off-by: Jie Luo <[email protected]> * fix the error of handing a and an (#953) * delete error asterisk (#947) Signed-off-by: tim-zju <[email protected]> * fix the grammer in aws.md (#948) * fix the grammer in aws.md * a and an * modify the user name (#946) * Update create-swarm.md (#954) Removes some spaces that were apparently b0rking the code block there. * Add release notes for DTR 2.1.3 * spell errors: misusing a and an Signed-off-by: tim-zju <[email protected]> * duplicated the (#957) Signed-off-by: Jie Luo <[email protected]> * Lossless Image optimization (#959) * re-compress jpg images losslessly using jpegoptim * re-compress png images losslessly using zopflipng * Add release notes for 1.12.5-cs Signed-off-by: Brian Goff <[email protected]> * Fix wrong entry for DTR in robots.txt * Update step_four.md * fix typo * Replace dtr-load-balancer by dtr-external-url Fixes #961 * explained how to pin whale to taskbar Signed-off-by: Victoria Bialas <[email protected]> * updated d4mac release notes re: hotfix Signed-off-by: Victoria Bialas <[email protected]> * Clean up some big, old files * Fix typo on engine/getstarted/step_four.md * Update gcs.md Forgotten </td> caused table explosion * Use armhf/hello-world for Raspbian tutorial Signed-off-by: Stefan Scherer <[email protected]> * added test for absolute links to docs.docker.com Signed-off-by: Adrien Duermael <[email protected]> * made absolute links to docs.docker.com relative Signed-off-by: Adrien Duermael <[email protected]> * fixed absolute link in engin/installation/binaries Signed-off-by: Adrien Duermael <[email protected]> * changes in Jenkinsfile Signed-off-by: Adrien Duermael <[email protected]> * look for href and src attributes in a and img tags Signed-off-by: Adrien Duermael <[email protected]> * look for absolute links to docs.docker.com Signed-off-by: Adrien Duermael <[email protected]> * forgotten absolute links in Dockerfile Signed-off-by: Adrien Duermael <[email protected]> * updated docs.docker.com absolute links test Signed-off-by: Adrien Duermael <[email protected]> * Revert "forgotten absolute links in Dockerfile" This reverts commit ca54f76. We want to fix the root cause, not the symptoms. So let’s make sure original content is fine instead of fixing it at build. Signed-off-by: Adrien Duermael <[email protected]> * exclude archives when testing urls for now Signed-off-by: Adrien Duermael <[email protected]> * CI: don’t build jekyll redirects for now Signed-off-by: Adrien Duermael <[email protected]> * Updated format for comments in Jenkinsfile Signed-off-by: Adrien Duermael <[email protected]> * tests: Go deps are now vendored as submodules Signed-off-by: Adrien Duermael <[email protected]> * Jenkinsfile: init submodules Signed-off-by: Adrien Duermael <[email protected]> * fixed submodules Signed-off-by: Adrien Duermael <[email protected]> * made absolute links to docs.docker.com relative Signed-off-by: Adrien Duermael <[email protected]> * missing “target=_blank” Signed-off-by: Adrien Duermael <[email protected]> * links to md files as requested by @mstanleyjones Signed-off-by: Adrien Duermael <[email protected]> * typo fixed * Update host_integration.md Typically, when you run an image from the command line, you would use "-d" for "detached mode", and when that appears to work, someone might paste the working command line into "ExecStart", which would then mysteriously fail because ExecStart expects a foreground process. * Excess '>' symbol deleted * Sometime the disk can become full and you can't rebalance. Adding this step to the configuration instructions to help prevent users from getting in to a state which their device becomes full. Moved to the performance section. Signed-off-by: charlescva <[email protected]> * added user question in FAQ re: shared drives and Docker Machine nodes copyedit incorporated Misty's review comments Signed-off-by: Victoria Bialas <[email protected]> * Standardize formatting and content, add logging examples Signed-off-by: Misty Stanley-Jones <[email protected]> * Update index.md fix the typo * Update deploy-to-cloud-btn.md Add note about having to be logged into Docker Cloud... * fixed note formatting Signed-off-by: Victoria Bialas <[email protected]> * update d4mac, d4win intros, add better feedback topics copyedits more copyedits Signed-off-by: Victoria Bialas <[email protected]> * Replace bash shell to powershell in docker for windows Signed-off-by: yuexiao-wang <[email protected]> * Update overview.md Update overview.md to reference possible issues regarding windows to unix path convert issues * Update ubuntulinux.md * Improved description for Hello-World Adds more detail for people to be able to understand how to build the Hello World using FROM scratch. * Update services.md Correct typographical error. * Correct wrong default value * fixes #1014 by adding flag Signed-off-by: LRubin <[email protected]> * small clarifications Signed-off-by: LRubin <[email protected]> * update swarm worker node concept description incorporated review comments from Misty re-worded topic titles and added to description of node fixed links for services and tasks incorporated more comments Signed-off-by: Victoria Bialas <[email protected]> * Update to usingdocker.md Link destination changed toa more appropriate (imo) destination. Link originally linked to docker env varibles whereas link description describes other docker commands. * Updating dockervolumes.md for Windows mounting The code snippet for mounting Windows directories won't work: it will produce an "Invalid bind mount spec" error as Docker cannot properly read the path. The core error was addressed in [#12590](moby/moby#12590 (comment)), this is just an update to the tutorial. * using github url for yaml.v2 submodule (#1034) in an attempt to fix Github pages build… Signed-off-by: Adrien Duermael <[email protected]> * clarify docker-cloud install Signed-off-by: Victoria Bialas <[email protected]> * Add flag to ucp 2.0 restore instructions * Add flag to ucp 2.0 restore instructions * update Docker machine install instructions per user feedback added uninstall steps fixed line lengths Signed-off-by: Victoria Bialas <[email protected]> * Typo in ubuntulinux.md (#1041) * version changed to 1.12.3 (#1036) * update the version in the code snnipt (#1037) * docker upgrade command fix (#1044) `apt-get upgrade` doesn't take an argument. To upgrade docker specifically would require `apt-get install docker-engine`. * accross -> across * beta 35 release notes d4mac, d4win Signed-off-by: Victoria Bialas <[email protected]> * Remove duplicate 'for details' Remove duplicate 'for details' in Docker Daemon Attack Surface line. * Update automated-testing.md Updated text to reflect that the `docker-compose.test.yml` file needs to be in the same directory as the Dockerfile used to build the image. * Add prereqs to AUFS configuration steps Fixes #1061 * Add the info about the linux-image-extra packages * Fix typo (are -> area) (#1058) * Fix title (#1056) The title is not rendered correctly because of the missing newline * Fix small typo in step_four.md. (#1053) * Fix DDC broken links reported on #1068 * Update networkingcontainers.md * Change title (#1073) * urls (#1074) Signed-off-by: yupengzte <[email protected]> * fixed links in /apidocs/docker-cloud/includes urls in html files that are included must be absolute, otherwise it only works when the files are included in some specific location. Signed-off-by: Adrien Duermael <[email protected]> * cf6fc37 fix had to be made in /apidocs/cloud-api-source Signed-off-by: Adrien Duermael <[email protected]> * url fixes for #1068 Signed-off-by: LRubin <[email protected]> * Fixes #1086 * more link fixes Signed-off-by: LRubin <[email protected]> * exclude /apidocs/cloud-api-source when building Signed-off-by: Adrien Duermael <[email protected]> * more more link link fixes fixes Signed-off-by: LRubin <[email protected]> * docker is no longer optional in this tutorial Signed-off-by: LRubin <[email protected]> * format fix and light rewording Signed-off-by: LRubin <[email protected]> * Always use sudo on Debian installation * docker-for-mac: add a FAQ about reducing the qcow2 size In Docker for Mac 1.12 the only way to free space on the host is to delete the qcow2 which means all containers and images have to be rebuilt. In Docker for Mac 1.13 there is preliminary support for shrinking the qcow2 file non-destructively using "TRIM" (as also used on SSDs). Unfortunately this isn't (yet) fully automatic -- it runs in the background and requires the app to be occasionally restarted. Related to [docker/for-mac#371] Signed-off-by: David Scott <[email protected]> * Update instructions for systemd drop-ins When creating a `/etc/systemd/system/docker.service` unit file, that file _replaces_ the default (`/lib/systemd/system/docker.service`) unit file. While this may be intended by some, this section describes how to use "partial" unit files ("drop-ins") to override only certain properties of the default unit file. This patch removes the mention of `/etc/systemd/system/docker.service` to prevent users from inadvertently replacing the default unit file. Signed-off-by: Sebastiaan van Stijn <[email protected]> * Add cs-engine 1.12.6-cs6 release notes Signed-off-by: Brian Goff <[email protected]> * Add new redirect for DTR install * Add 1.11.2-cs6 release notes Signed-off-by: Brian Goff <[email protected]> * Updates broken links for #1068 * added links to Toolbox installer downloads via Releases page Signed-off-by: Victoria Bialas <[email protected]> * Update links to DTR * tag images and containers with JOB_BASE_NAME + BUILD_NUMBER Signed-off-by: Adrien Duermael <[email protected]> * Add release notes for 1.10.3-cs4 Signed-off-by: Brian Goff <[email protected]> * added direct installer links, re-worked Toolbox intro pages updated Toolbox install intros Signed-off-by: Victoria Bialas <[email protected]> * Remove reference to legacy container links (#1057) * Removes duplicate canonical urls * Fix root_ca, json structure (#1079) Signed-off-by: Riyaz Faizullabhoy <[email protected]> * Correction of the Install-Module command (#1102) The command line was Import-Module which seems to be wrong. It seemed to work for me with Install-Module. So I make the correction. Please note, I'm only a newbie, so check this twice please ;-) * linked to related GitHub issue, slight re-ordering of topics Signed-off-by: Victoria Bialas <[email protected]> * Update PULL_REQUEST_TEMPLATE.md (#1106) Change 'left' to 'right' (because that's where the referenced information is located. * Add alternative keyservers due to #13555 (#1048) * Update step_six.md (#1105) * Update get-started-macvlan.md fix typo * added beta 36 relnotes, and minor wording updates to Docker.qcow2 question in Mac FAQs Signed-off-by: Victoria Bialas <[email protected]> * clarify Toolbox install per Nathan's comments centered download buttons for overview Toolbox install improved Get Docker intro in Getting Started tutorial Signed-off-by: Victoria Bialas <[email protected]> * Fixed more broken links * fix typo in get-started-macvlan.md (#1121) * added Linux Kernel upgrade to relnotes added new bug fix item toolbox fixes Signed-off-by: Victoria Bialas <[email protected]> * Update get-started-overlay.md (#1082) * Update get-started-overlay.md * Update get-started-overlay.md perhaps renderer can't do multiline markdown links * Update get-started-overlay.md * Remove 'edit this page' button when there's no source file * Adds dynamically-generated redirect_from.csv to root for nginx consumption * Correct typo "For image" changed to "For instance" * Update hyper-v.md * correct some spelling mistake * fix typo in swarm tutorial * Correct Python application port for local browsing * Updates allpagelinks.md to use full paths (#1143) * Fix documentation regarding protocol 50 (ESP) (#1144) The documentation should clarify that its protocol 50 and not port 50 that should be allowed between nodes. * Update mongodb.md (#1122) In older version docker build was failing. * CI - added tests for relative links [DO NOT MERGE] (#1052) * CI - added tests for relative links Signed-off-by: Adrien Duermael <[email protected]> * fixes to check relative links properly Signed-off-by: Adrien Duermael <[email protected]> * /engine/extend/plugins/ -> /engine/extend/legacy_plugins/ Signed-off-by: Adrien Duermael <[email protected]> * do not build /tests folder with Jekyll… Signed-off-by: Adrien Duermael <[email protected]> * list all problematic urls in each file don’t stop at first error encountered Signed-off-by: Adrien Duermael <[email protected]> * removed “stack tasks” from menu (toc.yaml) Signed-off-by: Adrien Duermael <[email protected]> * fixed broken links Signed-off-by: Adrien Duermael <[email protected]> * fixed broken link in docker-for-mac/osxfs.md Signed-off-by: Adrien Duermael <[email protected]> * fixed broken links in /index.html Signed-off-by: Adrien Duermael <[email protected]> * Add release notes for DTR 2.1.4 * Fix offline DDC install * Add offline tarfile for DTR 2.1.4 * Update instructions for IPv6-enabled networks Signed-off-by: Joffrey F <[email protected]> * Fix searches not running on Enter, CS Release notes * Restart the docker daemon after group changes Otherwise the verification step won't work. * Remove quotation marks Remove quotation marks around environment variable export for DOCKERCLOUD_NAMESPACE * optimize selectadriver.md * Permission Levels Full Control Warning (UCP 2.0) * Full Control Users Warning (UCP 1.1) * improve readability of note Signed-off-by: LRubin <[email protected]> * Update release notes for UCP 2.0.2 * Release notes for UCP 1.1.6 * replaces edit from #979 Signed-off-by: LRubin <[email protected]> * Update 2_set_up.md * adds more info about valid docker ID Signed-off-by: LRubin <[email protected]> * fix typo * Update 'usingdocker' tutorial to name the container Do some clean-up while I'm in there * swarm beta docs for limited publish Signed-off-by: LRubin <[email protected]> * Clarify the command only for docker-machine (#1149) * Clarify the command only for docker-machine * minor copyedits (#1148) * minor copyedits Signed-off-by: Victoria Bialas <[email protected]> * Revert "Restart the docker daemon after group changes" * take a stab at fixing a broken link Signed-off-by: LRubin <[email protected]> * Release Engine 1.13 documentation (#1187) * Sync vnext-engine branch to docker/docker SHA 2f12d28 This branch will contain forward-looking Engine-specific docs and be the equivalent of docker/docker master for docs * swarm: Document rollback, failure threshold, and monitor flags These are new flags to service create/update being added in a Docker engine PR. Signed-off-by: Aaron Lehmann <[email protected]> * Remove Fedora 22 as it's EOL https://fedoramagazine.org/fedora-22-end-of-life-2016-july/ With the recent release of Fedora 24, Fedora 22 will officially enter End Of Life (EOL) status on July 19th, 2016. After July 19th, all packages in the Fedora 22 repositories will no longer receive security, bugfix, or enhancement updates, and no new packages will be added to the Fedora 22 collection. Upgrading to Fedora 23 or Fedora 24 before July 19th 2016 is highly recommended for all users still running Fedora 22. Signed-off-by: Sebastiaan van Stijn <[email protected]> * update apparmor documentation to reflect changes in 1.13.0 Updates the apparmor docs to reflect recent changes, specifically that we are no longer saving to /etc/apparmor.d/. Also removes the seccomp profile and instead links to the generating template. Signed-off-by: Christopher Jones <[email protected]> * Added details about tag support for AWS log driver Signed-off-by: French Ben <[email protected]> * Changed wording for tag description * Updated docs to show full container ID * Updated wording on log stream default Signed-off-by: French Ben <[email protected]> * Added raw tags Signed-off-by: French Ben <[email protected]> * Update note about custom certs with system certs Fixed incorrect statement about example layout Related to moby/moby#27918 Signed-off-by: Derek McGowan <[email protected]> (github: dmcgowan) * Remove Ubuntu 15.10 Wily Werewolf As of July 28, 2016, Ubuntu 15.10 is officially EOL (https://lists.ubuntu.com/archives/ubuntu-announce/2016-July/000210.html), and will receive no further updates. Support for 15.10 was removed in Docker 1.13 through moby/moby#27042 (moby/moby@e9a8105) Signed-off-by: Sebastiaan van Stijn <[email protected]> * Add Ubuntu 16.10 Yakkety Yak Support for Ubuntu 16.10 was added in moby/moby#27993 (moby/moby@27beb64) Signed-off-by: Sebastiaan van Stijn <[email protected]> * add unix-sockets support in Fluentd logging driver Signed-off-by: Akira Koyasu <[email protected]> * Add engine changes that were lost in syncing When syncing docs from the docker/docker repository (e4bce35) some commits were not included. This includes those changes, by copying the documentation from moby/moby@8658748, which is the last commit before the docs were removed from the docker/docker repository in moby/moby@29f08cf Signed-off-by: Sebastiaan van Stijn <[email protected]> * Create logentries.md (#244) * Create logentries.md Signed-off-by: Carlos Alexandro Becker <[email protected]> * Add NATS client as option for publishing container logs (#369) * Add NATS client as option for publishing container logs Signed-off-by: Waldemar Quevedo <[email protected]> * Document ability to update a service's image Fixes #528 Signed-off-by: Misty Stanley-Jones <[email protected]> * First version of stack deployment tutorial Signed-off-by: Aanand Prasad <[email protected]> * Initial dump of CLI in yaml (#737) Signed-off-by: French Ben <[email protected]> * Document new CPU scheduling flags Signed-off-by: Misty Stanley-Jones <[email protected]> * Update dockerfile vnext (#874) * Merge pull request #731 from mstanleyjones/distribution_docs_from_upstream Pull distribution reference docs from upstream repo * Bump Engine ref docs branch to 1.13.x Signed-off-by: Misty Stanley-Jones <[email protected]> * Rename Remote API to Engine API See moby/moby#28319 Signed-off-by: Ben Firshman <[email protected]> * Move accounts API docs to Docker ID section Makes more sense here instead of the Engine reference. It is only consumed by the Engine. Signed-off-by: Ben Firshman <[email protected]> * Add automatically generated Engine API docs Signed-off-by: Ben Firshman <[email protected]> * Upgrade to ReDoc 1.6.2 (#891) To make use of x-displayName added in moby/moby#29401 Signed-off-by: Ben Firshman <[email protected]> * Add full documentation for APIs and SDKs Signed-off-by: Ben Firshman <[email protected]> * Updated Yaml files (#922) Signed-off-by: French Ben <[email protected]> * Added latest docs from Editions AWS & Azure (#887) * Added Docker for AWS and Azure and moved navigation Signed-off-by: French Ben <[email protected]> * Fixed image links Signed-off-by: French Ben <[email protected]> * Restructure navigation for Editions * Fixing double curly braces * YAML-sourced CLI refdocs * Add 'docker' label to commands * Fix for blank node * Document Docker secrets Fixes #529 Signed-off-by: Misty Stanley-Jones <[email protected]> * Update syntax of the -f flag in the examples * Update the syntax of 'docker secret create' in the examples * Document the ability to publish a port locally on a swarm node * Add info about image resolution with content trust * Add examples to CLI generation templates * remove confusing sentence from "publishing" section the routing mesh should work irregardless of all replicas being up or not, so removing this sentence. Signed-off-by: Sebastiaan van Stijn <[email protected]> * Rewrite and reorganize Linux install instructions Signed-off-by: Misty Stanley-Jones <[email protected]> * Fix typo in Oracle install instructions * Updated docs to remove beta and stable link (#1160) * Updated docs to remove beta and stable link * Addressing feedback from new installation instructions (#1172) * Address feedback for new installation instructions * Updating the repo files for Oracle since does not expand to only the number * Added latest docs from Editions AWS & Azure (#887) * Added Docker for AWS and Azure and moved navigation Signed-off-by: French Ben <[email protected]> * Fixed image links Signed-off-by: French Ben <[email protected]> * Restructure navigation for Editions * Fix a couple of Liquid errors * Merge pull request #1188 from docker/linkfix-john Link fixes and link to app tutorial
johndmulhausen
pushed a commit
to docker/docs
that referenced
this pull request
Jan 19, 2017
* fix punctuation typos (#949) Signed-off-by: Jie Luo <[email protected]> * fix the error of handing a and an (#953) * delete error asterisk (#947) Signed-off-by: tim-zju <[email protected]> * fix the grammer in aws.md (#948) * fix the grammer in aws.md * a and an * modify the user name (#946) * Update create-swarm.md (#954) Removes some spaces that were apparently b0rking the code block there. * Add release notes for DTR 2.1.3 * spell errors: misusing a and an Signed-off-by: tim-zju <[email protected]> * duplicated the (#957) Signed-off-by: Jie Luo <[email protected]> * Lossless Image optimization (#959) * re-compress jpg images losslessly using jpegoptim * re-compress png images losslessly using zopflipng * Add release notes for 1.12.5-cs Signed-off-by: Brian Goff <[email protected]> * Fix wrong entry for DTR in robots.txt * Update step_four.md * fix typo * Replace dtr-load-balancer by dtr-external-url Fixes #961 * explained how to pin whale to taskbar Signed-off-by: Victoria Bialas <[email protected]> * updated d4mac release notes re: hotfix Signed-off-by: Victoria Bialas <[email protected]> * Clean up some big, old files * Fix typo on engine/getstarted/step_four.md * Update gcs.md Forgotten </td> caused table explosion * Use armhf/hello-world for Raspbian tutorial Signed-off-by: Stefan Scherer <[email protected]> * added test for absolute links to docs.docker.com Signed-off-by: Adrien Duermael <[email protected]> * made absolute links to docs.docker.com relative Signed-off-by: Adrien Duermael <[email protected]> * fixed absolute link in engin/installation/binaries Signed-off-by: Adrien Duermael <[email protected]> * changes in Jenkinsfile Signed-off-by: Adrien Duermael <[email protected]> * look for href and src attributes in a and img tags Signed-off-by: Adrien Duermael <[email protected]> * look for absolute links to docs.docker.com Signed-off-by: Adrien Duermael <[email protected]> * forgotten absolute links in Dockerfile Signed-off-by: Adrien Duermael <[email protected]> * updated docs.docker.com absolute links test Signed-off-by: Adrien Duermael <[email protected]> * Revert "forgotten absolute links in Dockerfile" This reverts commit ca54f76. We want to fix the root cause, not the symptoms. So let’s make sure original content is fine instead of fixing it at build. Signed-off-by: Adrien Duermael <[email protected]> * exclude archives when testing urls for now Signed-off-by: Adrien Duermael <[email protected]> * CI: don’t build jekyll redirects for now Signed-off-by: Adrien Duermael <[email protected]> * Updated format for comments in Jenkinsfile Signed-off-by: Adrien Duermael <[email protected]> * tests: Go deps are now vendored as submodules Signed-off-by: Adrien Duermael <[email protected]> * Jenkinsfile: init submodules Signed-off-by: Adrien Duermael <[email protected]> * fixed submodules Signed-off-by: Adrien Duermael <[email protected]> * made absolute links to docs.docker.com relative Signed-off-by: Adrien Duermael <[email protected]> * missing “target=_blank” Signed-off-by: Adrien Duermael <[email protected]> * links to md files as requested by @mstanleyjones Signed-off-by: Adrien Duermael <[email protected]> * typo fixed * Update host_integration.md Typically, when you run an image from the command line, you would use "-d" for "detached mode", and when that appears to work, someone might paste the working command line into "ExecStart", which would then mysteriously fail because ExecStart expects a foreground process. * Excess '>' symbol deleted * Sometime the disk can become full and you can't rebalance. Adding this step to the configuration instructions to help prevent users from getting in to a state which their device becomes full. Moved to the performance section. Signed-off-by: charlescva <[email protected]> * added user question in FAQ re: shared drives and Docker Machine nodes copyedit incorporated Misty's review comments Signed-off-by: Victoria Bialas <[email protected]> * Standardize formatting and content, add logging examples Signed-off-by: Misty Stanley-Jones <[email protected]> * Update index.md fix the typo * Update deploy-to-cloud-btn.md Add note about having to be logged into Docker Cloud... * fixed note formatting Signed-off-by: Victoria Bialas <[email protected]> * update d4mac, d4win intros, add better feedback topics copyedits more copyedits Signed-off-by: Victoria Bialas <[email protected]> * Replace bash shell to powershell in docker for windows Signed-off-by: yuexiao-wang <[email protected]> * Update overview.md Update overview.md to reference possible issues regarding windows to unix path convert issues * Update ubuntulinux.md * Improved description for Hello-World Adds more detail for people to be able to understand how to build the Hello World using FROM scratch. * Update services.md Correct typographical error. * Correct wrong default value * fixes #1014 by adding flag Signed-off-by: LRubin <[email protected]> * small clarifications Signed-off-by: LRubin <[email protected]> * update swarm worker node concept description incorporated review comments from Misty re-worded topic titles and added to description of node fixed links for services and tasks incorporated more comments Signed-off-by: Victoria Bialas <[email protected]> * Update to usingdocker.md Link destination changed toa more appropriate (imo) destination. Link originally linked to docker env varibles whereas link description describes other docker commands. * Updating dockervolumes.md for Windows mounting The code snippet for mounting Windows directories won't work: it will produce an "Invalid bind mount spec" error as Docker cannot properly read the path. The core error was addressed in [#12590](moby/moby#12590 (comment)), this is just an update to the tutorial. * using github url for yaml.v2 submodule (#1034) in an attempt to fix Github pages build… Signed-off-by: Adrien Duermael <[email protected]> * clarify docker-cloud install Signed-off-by: Victoria Bialas <[email protected]> * Add flag to ucp 2.0 restore instructions * Add flag to ucp 2.0 restore instructions * update Docker machine install instructions per user feedback added uninstall steps fixed line lengths Signed-off-by: Victoria Bialas <[email protected]> * Typo in ubuntulinux.md (#1041) * version changed to 1.12.3 (#1036) * update the version in the code snnipt (#1037) * docker upgrade command fix (#1044) `apt-get upgrade` doesn't take an argument. To upgrade docker specifically would require `apt-get install docker-engine`. * accross -> across * beta 35 release notes d4mac, d4win Signed-off-by: Victoria Bialas <[email protected]> * Remove duplicate 'for details' Remove duplicate 'for details' in Docker Daemon Attack Surface line. * Update automated-testing.md Updated text to reflect that the `docker-compose.test.yml` file needs to be in the same directory as the Dockerfile used to build the image. * Add prereqs to AUFS configuration steps Fixes #1061 * Add the info about the linux-image-extra packages * Fix typo (are -> area) (#1058) * Fix title (#1056) The title is not rendered correctly because of the missing newline * Fix small typo in step_four.md. (#1053) * Fix DDC broken links reported on #1068 * Update networkingcontainers.md * Change title (#1073) * urls (#1074) Signed-off-by: yupengzte <[email protected]> * fixed links in /apidocs/docker-cloud/includes urls in html files that are included must be absolute, otherwise it only works when the files are included in some specific location. Signed-off-by: Adrien Duermael <[email protected]> * cf6fc37 fix had to be made in /apidocs/cloud-api-source Signed-off-by: Adrien Duermael <[email protected]> * url fixes for #1068 Signed-off-by: LRubin <[email protected]> * Fixes #1086 * more link fixes Signed-off-by: LRubin <[email protected]> * exclude /apidocs/cloud-api-source when building Signed-off-by: Adrien Duermael <[email protected]> * more more link link fixes fixes Signed-off-by: LRubin <[email protected]> * docker is no longer optional in this tutorial Signed-off-by: LRubin <[email protected]> * format fix and light rewording Signed-off-by: LRubin <[email protected]> * Always use sudo on Debian installation * docker-for-mac: add a FAQ about reducing the qcow2 size In Docker for Mac 1.12 the only way to free space on the host is to delete the qcow2 which means all containers and images have to be rebuilt. In Docker for Mac 1.13 there is preliminary support for shrinking the qcow2 file non-destructively using "TRIM" (as also used on SSDs). Unfortunately this isn't (yet) fully automatic -- it runs in the background and requires the app to be occasionally restarted. Related to [docker/for-mac#371] Signed-off-by: David Scott <[email protected]> * Update instructions for systemd drop-ins When creating a `/etc/systemd/system/docker.service` unit file, that file _replaces_ the default (`/lib/systemd/system/docker.service`) unit file. While this may be intended by some, this section describes how to use "partial" unit files ("drop-ins") to override only certain properties of the default unit file. This patch removes the mention of `/etc/systemd/system/docker.service` to prevent users from inadvertently replacing the default unit file. Signed-off-by: Sebastiaan van Stijn <[email protected]> * Add cs-engine 1.12.6-cs6 release notes Signed-off-by: Brian Goff <[email protected]> * Add new redirect for DTR install * Add 1.11.2-cs6 release notes Signed-off-by: Brian Goff <[email protected]> * Updates broken links for #1068 * added links to Toolbox installer downloads via Releases page Signed-off-by: Victoria Bialas <[email protected]> * Update links to DTR * tag images and containers with JOB_BASE_NAME + BUILD_NUMBER Signed-off-by: Adrien Duermael <[email protected]> * Add release notes for 1.10.3-cs4 Signed-off-by: Brian Goff <[email protected]> * added direct installer links, re-worked Toolbox intro pages updated Toolbox install intros Signed-off-by: Victoria Bialas <[email protected]> * Remove reference to legacy container links (#1057) * Removes duplicate canonical urls * Fix root_ca, json structure (#1079) Signed-off-by: Riyaz Faizullabhoy <[email protected]> * Correction of the Install-Module command (#1102) The command line was Import-Module which seems to be wrong. It seemed to work for me with Install-Module. So I make the correction. Please note, I'm only a newbie, so check this twice please ;-) * linked to related GitHub issue, slight re-ordering of topics Signed-off-by: Victoria Bialas <[email protected]> * Update PULL_REQUEST_TEMPLATE.md (#1106) Change 'left' to 'right' (because that's where the referenced information is located. * Add alternative keyservers due to #13555 (#1048) * Update step_six.md (#1105) * Update get-started-macvlan.md fix typo * added beta 36 relnotes, and minor wording updates to Docker.qcow2 question in Mac FAQs Signed-off-by: Victoria Bialas <[email protected]> * clarify Toolbox install per Nathan's comments centered download buttons for overview Toolbox install improved Get Docker intro in Getting Started tutorial Signed-off-by: Victoria Bialas <[email protected]> * Fixed more broken links * fix typo in get-started-macvlan.md (#1121) * added Linux Kernel upgrade to relnotes added new bug fix item toolbox fixes Signed-off-by: Victoria Bialas <[email protected]> * Update get-started-overlay.md (#1082) * Update get-started-overlay.md * Update get-started-overlay.md perhaps renderer can't do multiline markdown links * Update get-started-overlay.md * Remove 'edit this page' button when there's no source file * Adds dynamically-generated redirect_from.csv to root for nginx consumption * Correct typo "For image" changed to "For instance" * Update hyper-v.md * correct some spelling mistake * fix typo in swarm tutorial * Correct Python application port for local browsing * Updates allpagelinks.md to use full paths (#1143) * Fix documentation regarding protocol 50 (ESP) (#1144) The documentation should clarify that its protocol 50 and not port 50 that should be allowed between nodes. * Update mongodb.md (#1122) In older version docker build was failing. * CI - added tests for relative links [DO NOT MERGE] (#1052) * CI - added tests for relative links Signed-off-by: Adrien Duermael <[email protected]> * fixes to check relative links properly Signed-off-by: Adrien Duermael <[email protected]> * /engine/extend/plugins/ -> /engine/extend/legacy_plugins/ Signed-off-by: Adrien Duermael <[email protected]> * do not build /tests folder with Jekyll… Signed-off-by: Adrien Duermael <[email protected]> * list all problematic urls in each file don’t stop at first error encountered Signed-off-by: Adrien Duermael <[email protected]> * removed “stack tasks” from menu (toc.yaml) Signed-off-by: Adrien Duermael <[email protected]> * fixed broken links Signed-off-by: Adrien Duermael <[email protected]> * fixed broken link in docker-for-mac/osxfs.md Signed-off-by: Adrien Duermael <[email protected]> * fixed broken links in /index.html Signed-off-by: Adrien Duermael <[email protected]> * Add release notes for DTR 2.1.4 * Fix offline DDC install * Add offline tarfile for DTR 2.1.4 * Update instructions for IPv6-enabled networks Signed-off-by: Joffrey F <[email protected]> * Fix searches not running on Enter, CS Release notes * Restart the docker daemon after group changes Otherwise the verification step won't work. * Remove quotation marks Remove quotation marks around environment variable export for DOCKERCLOUD_NAMESPACE * optimize selectadriver.md * Permission Levels Full Control Warning (UCP 2.0) * Full Control Users Warning (UCP 1.1) * improve readability of note Signed-off-by: LRubin <[email protected]> * Update release notes for UCP 2.0.2 * Release notes for UCP 1.1.6 * replaces edit from #979 Signed-off-by: LRubin <[email protected]> * Update 2_set_up.md * adds more info about valid docker ID Signed-off-by: LRubin <[email protected]> * fix typo * Update 'usingdocker' tutorial to name the container Do some clean-up while I'm in there * swarm beta docs for limited publish Signed-off-by: LRubin <[email protected]> * Clarify the command only for docker-machine (#1149) * Clarify the command only for docker-machine * minor copyedits (#1148) * minor copyedits Signed-off-by: Victoria Bialas <[email protected]> * Revert "Restart the docker daemon after group changes" * take a stab at fixing a broken link Signed-off-by: LRubin <[email protected]> * Release Engine 1.13 documentation (#1187) * Sync vnext-engine branch to docker/docker SHA 2f12d28 This branch will contain forward-looking Engine-specific docs and be the equivalent of docker/docker master for docs * swarm: Document rollback, failure threshold, and monitor flags These are new flags to service create/update being added in a Docker engine PR. Signed-off-by: Aaron Lehmann <[email protected]> * Remove Fedora 22 as it's EOL https://fedoramagazine.org/fedora-22-end-of-life-2016-july/ With the recent release of Fedora 24, Fedora 22 will officially enter End Of Life (EOL) status on July 19th, 2016. After July 19th, all packages in the Fedora 22 repositories will no longer receive security, bugfix, or enhancement updates, and no new packages will be added to the Fedora 22 collection. Upgrading to Fedora 23 or Fedora 24 before July 19th 2016 is highly recommended for all users still running Fedora 22. Signed-off-by: Sebastiaan van Stijn <[email protected]> * update apparmor documentation to reflect changes in 1.13.0 Updates the apparmor docs to reflect recent changes, specifically that we are no longer saving to /etc/apparmor.d/. Also removes the seccomp profile and instead links to the generating template. Signed-off-by: Christopher Jones <[email protected]> * Added details about tag support for AWS log driver Signed-off-by: French Ben <[email protected]> * Changed wording for tag description * Updated docs to show full container ID * Updated wording on log stream default Signed-off-by: French Ben <[email protected]> * Added raw tags Signed-off-by: French Ben <[email protected]> * Update note about custom certs with system certs Fixed incorrect statement about example layout Related to moby/moby#27918 Signed-off-by: Derek McGowan <[email protected]> (github: dmcgowan) * Remove Ubuntu 15.10 Wily Werewolf As of July 28, 2016, Ubuntu 15.10 is officially EOL (https://lists.ubuntu.com/archives/ubuntu-announce/2016-July/000210.html), and will receive no further updates. Support for 15.10 was removed in Docker 1.13 through moby/moby#27042 (moby/moby@e9a8105) Signed-off-by: Sebastiaan van Stijn <[email protected]> * Add Ubuntu 16.10 Yakkety Yak Support for Ubuntu 16.10 was added in moby/moby#27993 (moby/moby@27beb64) Signed-off-by: Sebastiaan van Stijn <[email protected]> * add unix-sockets support in Fluentd logging driver Signed-off-by: Akira Koyasu <[email protected]> * Add engine changes that were lost in syncing When syncing docs from the docker/docker repository (e4bce35) some commits were not included. This includes those changes, by copying the documentation from moby/moby@8658748, which is the last commit before the docs were removed from the docker/docker repository in moby/moby@29f08cf Signed-off-by: Sebastiaan van Stijn <[email protected]> * Create logentries.md (#244) * Create logentries.md Signed-off-by: Carlos Alexandro Becker <[email protected]> * Add NATS client as option for publishing container logs (#369) * Add NATS client as option for publishing container logs Signed-off-by: Waldemar Quevedo <[email protected]> * Document ability to update a service's image Fixes #528 Signed-off-by: Misty Stanley-Jones <[email protected]> * First version of stack deployment tutorial Signed-off-by: Aanand Prasad <[email protected]> * Initial dump of CLI in yaml (#737) Signed-off-by: French Ben <[email protected]> * Document new CPU scheduling flags Signed-off-by: Misty Stanley-Jones <[email protected]> * Update dockerfile vnext (#874) * Merge pull request #731 from mstanleyjones/distribution_docs_from_upstream Pull distribution reference docs from upstream repo * Bump Engine ref docs branch to 1.13.x Signed-off-by: Misty Stanley-Jones <[email protected]> * Rename Remote API to Engine API See moby/moby#28319 Signed-off-by: Ben Firshman <[email protected]> * Move accounts API docs to Docker ID section Makes more sense here instead of the Engine reference. It is only consumed by the Engine. Signed-off-by: Ben Firshman <[email protected]> * Add automatically generated Engine API docs Signed-off-by: Ben Firshman <[email protected]> * Upgrade to ReDoc 1.6.2 (#891) To make use of x-displayName added in moby/moby#29401 Signed-off-by: Ben Firshman <[email protected]> * Add full documentation for APIs and SDKs Signed-off-by: Ben Firshman <[email protected]> * Updated Yaml files (#922) Signed-off-by: French Ben <[email protected]> * Added latest docs from Editions AWS & Azure (#887) * Added Docker for AWS and Azure and moved navigation Signed-off-by: French Ben <[email protected]> * Fixed image links Signed-off-by: French Ben <[email protected]> * Restructure navigation for Editions * Fixing double curly braces * YAML-sourced CLI refdocs * Add 'docker' label to commands * Fix for blank node * Document Docker secrets Fixes #529 Signed-off-by: Misty Stanley-Jones <[email protected]> * Update syntax of the -f flag in the examples * Update the syntax of 'docker secret create' in the examples * Document the ability to publish a port locally on a swarm node * Add info about image resolution with content trust * Add examples to CLI generation templates * remove confusing sentence from "publishing" section the routing mesh should work irregardless of all replicas being up or not, so removing this sentence. Signed-off-by: Sebastiaan van Stijn <[email protected]> * Rewrite and reorganize Linux install instructions Signed-off-by: Misty Stanley-Jones <[email protected]> * Fix typo in Oracle install instructions * Updated docs to remove beta and stable link (#1160) * Updated docs to remove beta and stable link * Addressing feedback from new installation instructions (#1172) * Address feedback for new installation instructions * Updating the repo files for Oracle since does not expand to only the number * Added latest docs from Editions AWS & Azure (#887) * Added Docker for AWS and Azure and moved navigation Signed-off-by: French Ben <[email protected]> * Fixed image links Signed-off-by: French Ben <[email protected]> * Restructure navigation for Editions * Fix a couple of Liquid errors * Merge pull request #1188 from docker/linkfix-john Link fixes and link to app tutorial * Nav fixes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #29071, we made the tags the correct name for generating types, at the expense of the menu in the documentation looking good.
ReDoc now has support for tag display names ( Redocly/redoc#152 ), so we can assign more human-friendly names to the menu items:
Can be previewed with #29078