Skip to content

Commit c948e6f

Browse files
Rebase vnext-compose (#1190)
* 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
1 parent f1c9e8f commit c948e6f

File tree

1,715 files changed

+50921
-314768
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,715 files changed

+50921
-314768
lines changed

.NOT_EDITED_HERE.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
_data/.NOT_EDITED_HERE.yaml
1+
_data/not_edited_here.yaml

.dockerignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.dockerignore
2+
.git
3+
.gitignore
4+
Dockerfile
5+
docker-compose.yml

.github/ISSUE_TEMPLATE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
### Problem description
22

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

67
### Problem location
78

.github/PULL_REQUEST_TEMPLATE.md

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

9-
<!-- Tell us what you did and why.-->
11+
### Proposed changes
1012

11-
### Unreleased project version
13+
<!--Tell us what you did and why-->
1214

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

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

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

20-
### Related issue or PR in another project
21-
22-
<!-- Full URLs to issues or pull requests in other Github projects -->
23-
24-
### Please take a look
25-
26-
<!-- At-mention specific individuals or groups, like @exampleuser123 -->
27-
28-
29-
<!-- To improve this template, edit .github/PULL_REQUEST_TEMPLATE.md. -->
24+
<!--Refer to related PRs or issues: #1234, or 'Fixes #1234' or 'Closes #1234'.
25+
Or link to full URLs to issues or pull requests in other Github projects -->

.gitmodules

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[submodule "tests/src/github.com/gdevillele/frontparser"]
2+
path = tests/src/github.com/gdevillele/frontparser
3+
url = https://github.com/gdevillele/frontparser.git
4+
branch = f28e87c7b9dae139855b574e96f22822986249a8
5+
[submodule "tests/src/golang.org/x/net"]
6+
path = tests/src/golang.org/x/net
7+
url = https://go.googlesource.com/net
8+
branch = 45e771701b814666a7eb299e6c7a57d0b1799e91
9+
[submodule "tests/src/gopkg.in/yaml.v2"]
10+
path = tests/src/gopkg.in/yaml.v2
11+
url = https://github.com/go-yaml/yaml.git
12+
branch = a5b47d31c556af34a302ce5d659e6fea44d90de0
13+

Dockerfile

Lines changed: 37 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,39 @@
11
FROM starefossen/github-pages
22

3-
RUN git clone https://www.github.com/docker/docker.github.io allv
4-
RUN jekyll build -s allv -d allvbuild
5-
6-
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.4
7-
RUN mkdir allvbuild/v1.4
8-
RUN jekyll build -s allv -d allvbuild/v1.4
9-
RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.4/#g'
10-
RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.4/#g'
11-
RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.4/#g'
12-
13-
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.5
14-
RUN mkdir allvbuild/v1.5
15-
RUN jekyll build -s allv -d allvbuild/v1.5
16-
RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.5/#g'
17-
RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.5/#g'
18-
RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.5/#g'
19-
20-
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.6
21-
RUN mkdir allvbuild/v1.6
22-
RUN jekyll build -s allv -d allvbuild/v1.6
23-
RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.6/#g'
24-
RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.6/#g'
25-
RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.6/#g'
26-
27-
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.7
28-
RUN mkdir allvbuild/v1.7
29-
RUN jekyll build -s allv -d allvbuild/v1.7
30-
RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.7/#g'
31-
RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.7/#g'
32-
RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.7/#g'
33-
34-
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.8
35-
RUN mkdir allvbuild/v1.8
36-
RUN jekyll build -s allv -d allvbuild/v1.8
37-
RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.8/#g'
38-
RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.8/#g'
39-
RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.8/#g'
40-
41-
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.9
42-
RUN mkdir allvbuild/v1.9
43-
RUN jekyll build -s allv -d allvbuild/v1.9
44-
RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.9/#g'
45-
RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.9/#g'
46-
RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.9/#g'
47-
48-
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.10
49-
RUN mkdir allvbuild/v1.10
50-
RUN jekyll build -s allv -d allvbuild/v1.10
51-
RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.10/#g'
52-
RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.10/#g'
53-
RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.10/#g'
54-
55-
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.11
56-
RUN mkdir allvbuild/v1.11
57-
RUN jekyll build -s allv -d allvbuild/v1.11
58-
RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.11/#g'
59-
RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.11/#g'
60-
RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.11/#g'
61-
62-
CMD jekyll serve -s /usr/src/app/allvbuild -d /_site --no-watch -H 0.0.0.0 -P 4000
3+
ENV VERSIONS="v1.4 v1.5 v1.6 v1.7 v1.8 v1.9 v1.10 v1.11"
4+
5+
# Create archive; check out each version, create HTML, tweak links
6+
RUN git clone https://www.github.com/docker/docker.github.io temp; \
7+
for VER in $VERSIONS; do \
8+
git --git-dir=./temp/.git --work-tree=./temp checkout ${VER} \
9+
&& mkdir -p allvbuild/${VER} \
10+
&& jekyll build -s temp -d allvbuild/${VER} \
11+
&& find allvbuild/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/'"$VER"'/#g' \
12+
&& find allvbuild/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/'"$VER"'/#g' \
13+
&& find allvbuild/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/'"$VER"'/#g'; \
14+
done; \
15+
rm -rf temp
16+
17+
COPY . allv
18+
19+
## Branch to pull from, per ref doc
20+
ENV ENGINE_BRANCH="1.13.x"
21+
ENV DISTRIBUTION_BRANCH="release/2.5"
22+
23+
# The statements below pull reference docs from upstream locations,
24+
# then build the whole site to static HTML using Jekyll
25+
26+
RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/extend allv/engine/extend \
27+
&& wget -O allv/engine/deprecated.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/deprecated.md \
28+
&& svn co https://github.com/docker/distribution/branches/$DISTRIBUTION_BRANCH/docs/spec allv/registry/spec \
29+
&& wget -O allv/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/$DISTRIBUTION_BRANCH/docs/configuration.md \
30+
&& rm -rf allv/apidocs/cloud-api-source \
31+
&& rm -rf allv/tests \
32+
&& wget -O allv/engine/api/v1.25/swagger.yaml https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/api/swagger.yaml \
33+
&& jekyll build -s allv -d allvbuild \
34+
&& find allvbuild/engine/reference -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
35+
&& find allvbuild/engine/extend -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
36+
&& rm -rf allv
37+
38+
# Serve the site, which is now all static HTML
39+
CMD jekyll serve -s /usr/src/app/allvbuild --no-watch -H 0.0.0.0 -P 4000

Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
source "https://rubygems.org"
22

3-
gem "github-pages", "104" #Update me once in a while: https://github.com/github/pages-gem/releases
3+
gem "github-pages", "105" #Update me once in a while: https://github.com/github/pages-gem/releases

Jenkinsfile

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
wrappedNode(label: 'linux && x86_64') {
2+
deleteDir()
3+
stage "checkout"
4+
checkout scm
5+
sh "git submodule update --init --recursive"
6+
stage "test"
7+
8+
/* Jekyll creates html files to implement client side redirects.
9+
There are absolute links to docs.docker.com in these htmls
10+
we don't want them to be parsed by the tests for now.
11+
Removing jekyll-redirect-from option will make sure these pages
12+
are not generated when building with Jekyll. */
13+
sh "awk '/jekyll-redirect-from/{n=1}; n {n--; next}; 1' < _config.yml > _config.yml.tmp"
14+
sh "mv _config.yml.tmp _config.yml"
15+
16+
sh "docker build -t docs:${JOB_BASE_NAME}-${BUILD_NUMBER} `pwd`"
17+
sh "docker build -t tests:${JOB_BASE_NAME}-${BUILD_NUMBER} `pwd`/tests"
18+
sh "docker run -v /usr/src/app/allvbuild --name docs-${JOB_BASE_NAME}-${BUILD_NUMBER} docs:${JOB_BASE_NAME}-${BUILD_NUMBER} /bin/true"
19+
sh "docker run --rm --volumes-from docs-${JOB_BASE_NAME}-${BUILD_NUMBER} -v `pwd`:/docs tests:${JOB_BASE_NAME}-${BUILD_NUMBER}"
20+
sh "docker rm -fv docs-${JOB_BASE_NAME}-${BUILD_NUMBER}"
21+
sh "docker rmi docs:${JOB_BASE_NAME}-${BUILD_NUMBER} tests:${JOB_BASE_NAME}-${BUILD_NUMBER}"
22+
}

README.md

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# Docs @ Docker
22

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

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

99
## Providing feedback
1010

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

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

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

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

7474
The following `vnext` branches currently exist:
7575

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

104-
## Per-PR staging on Github
104+
## Per-PR staging on GitHub
105105

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

114114
## Staging locally
115115

@@ -136,10 +136,41 @@ You have three options:
136136
docker-compose down
137137
```
138138
139-
2. Use Jekyll directly. Clone this repo, [install Ruby 2.3 or higher
140-
(required)](https://www.ruby-lang.org/en/documentation/installation/),
141-
[install the GitHub Pages Ruby gem](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/),
142-
then run `jekyll serve` from within the directory.
139+
2. Use Jekyll directly.
140+
141+
a. Clone this repo by running:
142+
143+
```bash
144+
git clone https://github.com/docker/docker.github.io.git
145+
```
146+
147+
b. Install Ruby 2.3 or later as described in [Installing Ruby]
148+
(https://www.ruby-lang.org/en/documentation/installation/).
149+
150+
c. Install Bundler:
151+
152+
```bash
153+
gem install bundler
154+
```
155+
156+
d. If you use Ubuntu, install packages required for the Nokogiri HTML
157+
parser:
158+
159+
```bash
160+
sudo apt-get install ruby-dev zlib1g-dev liblzma-dev
161+
```
162+
163+
e. Install Jekyll and other required dependencies:
164+
165+
```bash
166+
bundle install
167+
```
168+
169+
>**Note**: You may have to install some packages manually.
170+
171+
f. Change the directory to `docker.github.io`.
172+
173+
g. Use the `jekyll serve` command to continuously build the HTML output.
143174
144175
The `jekyll serve` process runs in the foreground, and starts a web server
145176
running on http://localhost:4000/ by default. To stop it, use `CTRL+C`.
@@ -162,7 +193,7 @@ You have three options:
162193

163194
Feel free to link to `../foo.md` so that the docs are readable in GitHub, but keep in mind that Jekyll templating notation
164195
`{% such as this %}` will render in raw text and not be processed. In general it's best to assume the docs are being read
165-
directly on docs.docker.com.
196+
directly on [https://docs.docker.com/](https://docs.docker.com/).
166197
167198
## Style guide
168199

_config.yml

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ permalink: pretty
1010
safe: false
1111
lsi: false
1212
url: https://docs.docker.com
13+
keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11"]
1314

1415
gems:
1516
- jekyll-redirect-from
@@ -87,20 +88,32 @@ defaults:
8788
path: "toolbox"
8889
values:
8990
assignee: "londoncalling"
91+
-
92+
scope:
93+
path: "datacenter/dtr/2.1"
94+
values:
95+
ucp_version: "2.0"
96+
dtr_version: "2.1"
9097
-
9198
scope:
9299
path: "datacenter/dtr/2.0"
93100
values:
94101
hide_from_sitemap: true
95-
this_version: "2.0"
96-
latest_version: "2.1"
102+
ucp_version: "1.1"
103+
dtr_version: "2.0"
104+
-
105+
scope:
106+
path: "datacenter/ucp/2.0"
107+
values:
108+
ucp_version: "2.0"
109+
dtr_version: "2.1"
97110
-
98111
scope:
99112
path: "datacenter/ucp/1.1"
100113
values:
101114
hide_from_sitemap: true
102-
this_version: "1.1"
103-
latest_version: "2.0"
115+
ucp_version: "1.1"
116+
dtr_version: "2.0"
104117
-
105118
scope:
106119
path: "apidocs/v1.3.3"

0 commit comments

Comments
 (0)