Skip to content

Commit

Permalink
Rebase vnext-compose (#1190)
Browse files Browse the repository at this point in the history
* d4mac, d4win stable 1.12.5 and beta 34 updates

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

* fix punctuation typos (#949)

Signed-off-by: Jie Luo <luo612@zju.edu.cn>

* fix the error of handing a and an (#953)

* delete error asterisk (#947)

Signed-off-by: tim-zju <21651152@zju.edu.cn>

* 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 <21651152@zju.edu.cn>

* duplicated the (#957)

Signed-off-by: Jie Luo <luo612@zju.edu.cn>

* 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 <cpuguy83@gmail.com>

* 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 <victoria.bialas@docker.com>

* updated d4mac release notes re: hotfix

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

* 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 <scherer_stefan@icloud.com>

* added test for absolute links to docs.docker.com

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* made absolute links to docs.docker.com relative

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* fixed absolute link in engin/installation/binaries

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* changes in Jenkinsfile

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* look for href and src attributes in a and img tags

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* look for absolute links to docs.docker.com

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* forgotten absolute links in Dockerfile

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* updated docs.docker.com absolute links test

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* 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 <adrien@duermael.com>

* exclude archives when testing urls for now

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* CI: don’t build jekyll redirects for now

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* Updated format for comments in Jenkinsfile

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* tests: Go deps are now vendored as submodules

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* Jenkinsfile: init submodules

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* fixed submodules

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* made absolute links to docs.docker.com relative

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* missing “target=_blank”

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* links to md files

as requested by @mstanleyjones

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* 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 <charlieott@gmail.com>

* added user question in FAQ re: shared drives and Docker Machine nodes

copyedit

incorporated Misty's review comments

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

* Standardize formatting and content, add logging examples

Signed-off-by: Misty Stanley-Jones <misty@docker.com>

* 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 <victoria.bialas@docker.com>

* update d4mac, d4win intros, add better feedback topics

copyedits

more copyedits

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

* Replace bash shell to powershell in docker for windows

Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>

* 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 <lrubin@docker.com>

* small clarifications

Signed-off-by: LRubin <lrubin@docker.com>

* 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 <victoria.bialas@docker.com>

* 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 <adrien@duermael.com>

* clarify docker-cloud install

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

* 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 <victoria.bialas@docker.com>

* 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 <victoria.bialas@docker.com>

* 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 <yu.peng36@zte.com.cn>

* 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 <adrien@duermael.com>

* cf6fc37 fix had to be made in /apidocs/cloud-api-source

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* url fixes for #1068

Signed-off-by: LRubin <lrubin@docker.com>

* Fixes #1086

* more link fixes

Signed-off-by: LRubin <lrubin@docker.com>

* exclude /apidocs/cloud-api-source when building

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* more more link link fixes fixes

Signed-off-by: LRubin <lrubin@docker.com>

* docker is no longer optional in this tutorial

Signed-off-by: LRubin <lrubin@docker.com>

* format fix and light rewording

Signed-off-by: LRubin <lrubin@docker.com>

* 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 <dave.scott@docker.com>

* 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 <github@gone.nl>

* Add cs-engine 1.12.6-cs6 release notes

Signed-off-by: Brian Goff <cpuguy83@gmail.com>

* Add new redirect for DTR install

* Add 1.11.2-cs6 release notes

Signed-off-by: Brian Goff <cpuguy83@gmail.com>

* Updates broken links for #1068

* added links to Toolbox installer downloads via Releases page

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

* Update links to DTR

* tag images and containers with JOB_BASE_NAME + BUILD_NUMBER

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* Add release notes for 1.10.3-cs4

Signed-off-by: Brian Goff <cpuguy83@gmail.com>

* added direct installer links, re-worked Toolbox intro pages

updated Toolbox install intros

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

* Remove reference to legacy container links (#1057)

* Removes duplicate canonical urls

* Fix root_ca, json structure (#1079)

Signed-off-by: Riyaz Faizullabhoy <riyaz.faizullabhoy@docker.com>

* 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 <victoria.bialas@docker.com>

* 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 <victoria.bialas@docker.com>

* 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 <victoria.bialas@docker.com>

* 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 <victoria.bialas@docker.com>

* 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 <adrien@duermael.com>

* fixes to check relative links properly

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* /engine/extend/plugins/ -> /engine/extend/legacy_plugins/

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* do not build /tests folder with Jekyll…

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* list all problematic urls in each file

don’t stop at first error encountered

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* removed “stack tasks” from menu (toc.yaml)

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* fixed broken links

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* fixed broken link in docker-for-mac/osxfs.md

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* fixed broken links in /index.html

Signed-off-by: Adrien Duermael <adrien@duermael.com>

* 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 <joffrey@docker.com>

* 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 <lrubin@docker.com>

* Update release notes for UCP 2.0.2

* Release notes for UCP 1.1.6

* replaces edit from #979

Signed-off-by: LRubin <lrubin@docker.com>

* Update 2_set_up.md

* adds more info about valid docker ID

Signed-off-by: LRubin <lrubin@docker.com>

* 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 <lrubin@docker.com>

* 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 <victoria.bialas@docker.com>

* Revert "Restart the docker daemon after group changes"

* take a stab at fixing a broken link

Signed-off-by: LRubin <lrubin@docker.com>

* 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 <aaron.lehmann@docker.com>

* 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 <github@gone.nl>

* 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 <tophj@linux.vnet.ibm.com>

* Added details about tag support for AWS log driver

Signed-off-by: French Ben <frenchben@docker.com>

* Changed wording for tag description

* Updated docs to show full container ID

* Updated wording on log stream default

Signed-off-by: French Ben <frenchben@docker.com>

* Added raw tags

Signed-off-by: French Ben <frenchben@docker.com>

* Update note about custom certs with system certs

Fixed incorrect statement about example layout

Related to moby/moby#27918

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (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 <github@gone.nl>

* 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 <github@gone.nl>

* add unix-sockets support in Fluentd logging driver

Signed-off-by: Akira Koyasu <mail@akirakoyasu.net>

* 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 <github@gone.nl>

* Create logentries.md (#244)

* Create logentries.md

Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>

* Add NATS client as option for publishing container logs (#369)

* Add NATS client as option for publishing container logs

Signed-off-by: Waldemar Quevedo <waldemar.quevedo@gmail.com>

* Document ability to update a service's image

Fixes #528

Signed-off-by: Misty Stanley-Jones <misty@docker.com>

* First version of stack deployment tutorial

Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>

* Initial dump of CLI in yaml (#737)

Signed-off-by: French Ben <frenchben@docker.com>

* Document new CPU scheduling flags

Signed-off-by: Misty Stanley-Jones <misty@docker.com>

* 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 <misty@docker.com>

* Rename Remote API to Engine API

See moby/moby#28319

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

* 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 <ben@firshman.co.uk>

* Add automatically generated Engine API docs

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

* Upgrade to ReDoc 1.6.2 (#891)

To make use of x-displayName added in
moby/moby#29401

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

* Add full documentation for APIs and SDKs

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

* Updated Yaml files (#922)

Signed-off-by: French Ben <frenchben@docker.com>

* Added latest docs from Editions AWS & Azure (#887)

* Added Docker for AWS and Azure and moved navigation

Signed-off-by: French Ben <frenchben@docker.com>

* Fixed image links

Signed-off-by: French Ben <frenchben@docker.com>

* 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 <misty@docker.com>

* 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 <github@gone.nl>

* Rewrite and reorganize Linux install instructions

Signed-off-by: Misty Stanley-Jones <misty@docker.com>

* 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 <frenchben@docker.com>

* Fixed image links

Signed-off-by: French Ben <frenchben@docker.com>

* 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
  • Loading branch information
johndmulhausen authored Jan 19, 2017
1 parent f1c9e8f commit c948e6f
Show file tree
Hide file tree
Showing 1,715 changed files with 50,921 additions and 314,768 deletions.
2 changes: 1 addition & 1 deletion .NOT_EDITED_HERE.yaml
5 changes: 5 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.dockerignore
.git
.gitignore
Dockerfile
docker-compose.yml
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
### Problem description

<!-- Briefly describe the problem that you found. Only documentation issues should be filed here.
For general questions, go to https://forums.docker.com/. -->
<!--Briefly describe the problem that you found.
Only DOCUMENTATION issues should be filed here.
For general questions, go to https://forums.docker.com/. -->

### Problem location

Expand Down
36 changes: 16 additions & 20 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@
<!--Thanks for your contribution. See [CONTRIBUTING](CONTRIBUTING.md)
for this project's contribution guidelines. -->
for this project's contribution guidelines. Remove these comments
as you go.
<!--DO NOT edit files and directories listed in .NOT_EDITED_HERE.yaml.
These are maintained in upstream repos and changes here will be lost.-->
DO NOT edit files and directories listed in _data/not_edited_here.yaml.
These are maintained in upstream repos and changes here will be lost.
### Describe the proposed changes
Help us merge your changes more quickly by adding details and setting metadata
(such as labels, milestones, and reviewers) over at the right-hand side.-->

<!-- Tell us what you did and why.-->
### Proposed changes

### Unreleased project version
<!--Tell us what you did and why-->

<!-- If this change only applies to an unreleased version of a project, note
that here and base your work on the `vnext-` branch for your project. -->
### Unreleased project version (optional)

### Related issue
<!--If this change only applies to an unreleased version of a project, note
that here and base your work on the `vnext-` branch for your project. If
this doesn't apply to this PR, you can remove this whole section.
Set a milestone if appropriate. -->

<!-- Refer to related PRs or issues: #1234, or 'Fixes #1234' or 'Closes #1234'. -->
### Related issues (optional)

### Related issue or PR in another project

<!-- Full URLs to issues or pull requests in other Github projects -->

### Please take a look

<!-- At-mention specific individuals or groups, like @exampleuser123 -->


<!-- To improve this template, edit .github/PULL_REQUEST_TEMPLATE.md. -->
<!--Refer to related PRs or issues: #1234, or 'Fixes #1234' or 'Closes #1234'.
Or link to full URLs to issues or pull requests in other Github projects -->
13 changes: 13 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[submodule "tests/src/github.com/gdevillele/frontparser"]
path = tests/src/github.com/gdevillele/frontparser
url = https://github.com/gdevillele/frontparser.git
branch = f28e87c7b9dae139855b574e96f22822986249a8
[submodule "tests/src/golang.org/x/net"]
path = tests/src/golang.org/x/net
url = https://go.googlesource.com/net
branch = 45e771701b814666a7eb299e6c7a57d0b1799e91
[submodule "tests/src/gopkg.in/yaml.v2"]
path = tests/src/gopkg.in/yaml.v2
url = https://github.com/go-yaml/yaml.git
branch = a5b47d31c556af34a302ce5d659e6fea44d90de0

97 changes: 37 additions & 60 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,62 +1,39 @@
FROM starefossen/github-pages

RUN git clone https://www.github.com/docker/docker.github.io allv
RUN jekyll build -s allv -d allvbuild

RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.4
RUN mkdir allvbuild/v1.4
RUN jekyll build -s allv -d allvbuild/v1.4
RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.4/#g'
RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.4/#g'
RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.4/#g'

RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.5
RUN mkdir allvbuild/v1.5
RUN jekyll build -s allv -d allvbuild/v1.5
RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.5/#g'
RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.5/#g'
RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.5/#g'

RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.6
RUN mkdir allvbuild/v1.6
RUN jekyll build -s allv -d allvbuild/v1.6
RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.6/#g'
RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.6/#g'
RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.6/#g'

RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.7
RUN mkdir allvbuild/v1.7
RUN jekyll build -s allv -d allvbuild/v1.7
RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.7/#g'
RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.7/#g'
RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.7/#g'

RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.8
RUN mkdir allvbuild/v1.8
RUN jekyll build -s allv -d allvbuild/v1.8
RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.8/#g'
RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.8/#g'
RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.8/#g'

RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.9
RUN mkdir allvbuild/v1.9
RUN jekyll build -s allv -d allvbuild/v1.9
RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.9/#g'
RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.9/#g'
RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.9/#g'

RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.10
RUN mkdir allvbuild/v1.10
RUN jekyll build -s allv -d allvbuild/v1.10
RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.10/#g'
RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.10/#g'
RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.10/#g'

RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.11
RUN mkdir allvbuild/v1.11
RUN jekyll build -s allv -d allvbuild/v1.11
RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.11/#g'
RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.11/#g'
RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.11/#g'

CMD jekyll serve -s /usr/src/app/allvbuild -d /_site --no-watch -H 0.0.0.0 -P 4000
ENV VERSIONS="v1.4 v1.5 v1.6 v1.7 v1.8 v1.9 v1.10 v1.11"

# Create archive; check out each version, create HTML, tweak links
RUN git clone https://www.github.com/docker/docker.github.io temp; \
for VER in $VERSIONS; do \
git --git-dir=./temp/.git --work-tree=./temp checkout ${VER} \
&& mkdir -p allvbuild/${VER} \
&& jekyll build -s temp -d allvbuild/${VER} \
&& find allvbuild/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/'"$VER"'/#g' \
&& find allvbuild/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/'"$VER"'/#g' \
&& find allvbuild/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/'"$VER"'/#g'; \
done; \
rm -rf temp

COPY . allv

## Branch to pull from, per ref doc
ENV ENGINE_BRANCH="1.13.x"
ENV DISTRIBUTION_BRANCH="release/2.5"

# The statements below pull reference docs from upstream locations,
# then build the whole site to static HTML using Jekyll

RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/extend allv/engine/extend \
&& wget -O allv/engine/deprecated.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/deprecated.md \
&& svn co https://github.com/docker/distribution/branches/$DISTRIBUTION_BRANCH/docs/spec allv/registry/spec \
&& wget -O allv/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/$DISTRIBUTION_BRANCH/docs/configuration.md \
&& rm -rf allv/apidocs/cloud-api-source \
&& rm -rf allv/tests \
&& wget -O allv/engine/api/v1.25/swagger.yaml https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/api/swagger.yaml \
&& jekyll build -s allv -d allvbuild \
&& find allvbuild/engine/reference -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
&& find allvbuild/engine/extend -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
&& rm -rf allv

# Serve the site, which is now all static HTML
CMD jekyll serve -s /usr/src/app/allvbuild --no-watch -H 0.0.0.0 -P 4000
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
source "https://rubygems.org"

gem "github-pages", "104" #Update me once in a while: https://github.com/github/pages-gem/releases
gem "github-pages", "105" #Update me once in a while: https://github.com/github/pages-gem/releases
22 changes: 22 additions & 0 deletions Jenkinsfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
wrappedNode(label: 'linux && x86_64') {
deleteDir()
stage "checkout"
checkout scm
sh "git submodule update --init --recursive"
stage "test"

/* Jekyll creates html files to implement client side redirects.
There are absolute links to docs.docker.com in these htmls
we don't want them to be parsed by the tests for now.
Removing jekyll-redirect-from option will make sure these pages
are not generated when building with Jekyll. */
sh "awk '/jekyll-redirect-from/{n=1}; n {n--; next}; 1' < _config.yml > _config.yml.tmp"
sh "mv _config.yml.tmp _config.yml"

sh "docker build -t docs:${JOB_BASE_NAME}-${BUILD_NUMBER} `pwd`"
sh "docker build -t tests:${JOB_BASE_NAME}-${BUILD_NUMBER} `pwd`/tests"
sh "docker run -v /usr/src/app/allvbuild --name docs-${JOB_BASE_NAME}-${BUILD_NUMBER} docs:${JOB_BASE_NAME}-${BUILD_NUMBER} /bin/true"
sh "docker run --rm --volumes-from docs-${JOB_BASE_NAME}-${BUILD_NUMBER} -v `pwd`:/docs tests:${JOB_BASE_NAME}-${BUILD_NUMBER}"
sh "docker rm -fv docs-${JOB_BASE_NAME}-${BUILD_NUMBER}"
sh "docker rmi docs:${JOB_BASE_NAME}-${BUILD_NUMBER} tests:${JOB_BASE_NAME}-${BUILD_NUMBER}"
}
53 changes: 42 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Docs @ Docker

Welcome to the repo for our documentation. This is the source for the URL
served at https://docs.docker.com/.
served at [https://docs.docker.com/](https://docs.docker.com/).

Feel free to send us pull requests and file issues. Our docs are completely
open source and we deeply appreciate contributions from our community!

## Providing feedback

We really want your feedback, and we've made it easy. You can edit, rate, or
file an issue at the bottom of every page on docs.docker.com.
file an issue at the bottom of every page on [https://docs.docker.com/](https://docs.docker.com/).

**Please only file issues about the documentation in this repository.** One way
to think about this is that you should file a bug here if your issue is that you
don't see something that should be in the docs, or you see something incorrect
or confusing in the docs.

- If your problem is a general question about how to configure or use Docker,
consider asking a question on https://forums.docker.com instead.
consider asking a question on [https://forums.docker.com](https://forums.docker.com) instead.

- If you have an idea for a new feature or behavior change in a specific aspect
of Docker, or have found a bug in part of Docker, please file that issue in
Expand Down Expand Up @@ -69,7 +69,7 @@ your work on that project's `vnext` branch.** These branches were created by
cloning `master` and then importing a project's `master` branch's docs into it
(at the time of the migration), in a way that preserved the commit history. When
a project has a release, its `vnext` branch will be merged into `master` and your
work will be visible on docs.docker.com.
work will be visible on [https://docs.docker.com/](https://docs.docker.com/).

The following `vnext` branches currently exist:

Expand Down Expand Up @@ -101,15 +101,15 @@ The following `vnext` branches currently exist:
docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
project

## Per-PR staging on Github
## Per-PR staging on GitHub

For every PR against `master` and all the long-lived branches, a staged version
of the site is built using Netlify. If the site builds, you will see
**deploy/netlify — Deploy preview ready**. Otherwise, you will see an error.
Click **Details** to review the staged site or the errors that prevented it from
building. Review the staged site and amend your commit if necessary. Reviewers
will also check the staged site before merging the PR, to protect the integrity
of [docs.docker.com](http://docs.docker.com/).
of [https://docs.docker.com/](https://docs.docker.com/).

## Staging locally

Expand All @@ -136,10 +136,41 @@ You have three options:
docker-compose down
```
2. Use Jekyll directly. Clone this repo, [install Ruby 2.3 or higher
(required)](https://www.ruby-lang.org/en/documentation/installation/),
[install the GitHub Pages Ruby gem](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/),
then run `jekyll serve` from within the directory.
2. Use Jekyll directly.
a. Clone this repo by running:
```bash
git clone https://github.com/docker/docker.github.io.git
```
b. Install Ruby 2.3 or later as described in [Installing Ruby]
(https://www.ruby-lang.org/en/documentation/installation/).
c. Install Bundler:
```bash
gem install bundler
```
d. If you use Ubuntu, install packages required for the Nokogiri HTML
parser:
```bash
sudo apt-get install ruby-dev zlib1g-dev liblzma-dev
```
e. Install Jekyll and other required dependencies:
```bash
bundle install
```
>**Note**: You may have to install some packages manually.
f. Change the directory to `docker.github.io`.
g. Use the `jekyll serve` command to continuously build the HTML output.
The `jekyll serve` process runs in the foreground, and starts a web server
running on http://localhost:4000/ by default. To stop it, use `CTRL+C`.
Expand All @@ -162,7 +193,7 @@ You have three options:

Feel free to link to `../foo.md` so that the docs are readable in GitHub, but keep in mind that Jekyll templating notation
`{% such as this %}` will render in raw text and not be processed. In general it's best to assume the docs are being read
directly on docs.docker.com.
directly on [https://docs.docker.com/](https://docs.docker.com/).
## Style guide
Expand Down
21 changes: 17 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ permalink: pretty
safe: false
lsi: false
url: https://docs.docker.com
keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11"]

gems:
- jekyll-redirect-from
Expand Down Expand Up @@ -87,20 +88,32 @@ defaults:
path: "toolbox"
values:
assignee: "londoncalling"
-
scope:
path: "datacenter/dtr/2.1"
values:
ucp_version: "2.0"
dtr_version: "2.1"
-
scope:
path: "datacenter/dtr/2.0"
values:
hide_from_sitemap: true
this_version: "2.0"
latest_version: "2.1"
ucp_version: "1.1"
dtr_version: "2.0"
-
scope:
path: "datacenter/ucp/2.0"
values:
ucp_version: "2.0"
dtr_version: "2.1"
-
scope:
path: "datacenter/ucp/1.1"
values:
hide_from_sitemap: true
this_version: "1.1"
latest_version: "2.0"
ucp_version: "1.1"
dtr_version: "2.0"
-
scope:
path: "apidocs/v1.3.3"
Expand Down
3 changes: 3 additions & 0 deletions _data/advisories.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ texts:
rc: "The Swarm mode feature included in Docker Engine 1.12 is a release candidate feature and might be subject to non backward-compatible changes. Some functionality may change before the feature becomes generally available."
docker4mac-beta: "Docker for Mac is currently in public beta. Some functionality may change before the product becomes generally available."
docker4win-beta: "Docker for Windows is currently in public beta. Some functionality may change before the product becomes generally available."
toolbox: "**Legacy desktop solution.** Docker Toolbox is for older Mac and Windows systems that do not meet the requirements of [Docker for Mac](/docker-for-mac/) and [Docker for Windows](/docker-for-windows/). We recommend updating to the newer applications, if possible."
kitematic: "**Legacy desktop solution.** Kitematic is a legacy solution, bundled with [Docker Toolbox](/toolbox/overview/). We recommend updating to [Docker for Mac](/docker-for-mac/) or [Docker for Windows](/docker-for-windows/) if your system meets the requirements for one of those applications."
swarm: "See [Swarm mode overview](/engine/swarm/) for the orchestration features introduced in Docker Engine 1.12. Only refer to the Docker Swarm documents below for information on the standalone Swarm product."
swarm-standalone: "**You are viewing docs for legacy standalone Swarm.** These topics describe standalone Docker Swarm. If you use Docker 1.12 or higher, [Swarm mode](/engine/swarm/) is integrated with Docker Engine. Most users should use integrated Swarm mode &#8212; a good place to start is [Getting started with swarm mode](/engine/swarm/swarm-tutorial/) and [Swarm mode CLI commands](/engine/swarm/index.md#swarm-mode-cli-commands). Standalone Docker Swarm is not integrated into the Docker Engine API and CLI commands."
engine: "This site contains documentation for the v1.12 release candidate version of Docker Engine. For the Docker Engine v1.11 docs, see [https://docs.docker.com/v1.11/](https://docs.docker.com/v1.11/). Docker for Mac and Docker for Windows are currently in Beta."


Expand Down
Loading

0 comments on commit c948e6f

Please sign in to comment.