diff --git a/.NOT_EDITED_HERE.txt b/.NOT_EDITED_HERE.txt new file mode 100644 index 00000000000..12164aede57 --- /dev/null +++ b/.NOT_EDITED_HERE.txt @@ -0,0 +1,31 @@ +# Files and directories here are not edited in the docker.github.io repo. +# Instead, they are edited in the appropriate upstream repo and pulled +# into this repo periodically. The intent is that if you submit a PR +# with changes to these files or directories, a CI job will fail in the +# PR, indicating that it should not be merged. + +# If you need to edit these files or directories, submit a PR in one of the +# following repos. The file will probably be located within the docs/ subdirectory. + +# docker-trusted-registry: n/a, file an issue +# engine: https://github.com/docker/docker +# compose: https://github.com/docker/compose +# notary: https://github.com/docker/notary +# registry: https://github.com/docker/distribution +# swarm: https://github.com/docker/swarm +# ucp: n/a, file an issue + +# Make sure directories have the trailing slash, keep the list alphabetical + +apidocs/ +compose/reference/ +docker-trusted-registry/reference/ +engine/deprecated.md +engine/extend/ +engine/reference/ +machine/reference/ +notary/reference/ +registry/configuration.md +registry/spec/ +swarm/reference/ +ucp/reference/ diff --git a/.arcconfig b/.arcconfig deleted file mode 100644 index 238fabe3ff3..00000000000 --- a/.arcconfig +++ /dev/null @@ -1,3 +0,0 @@ -{ - "phabricator.uri" : "https://docker-saas.phacility.com/" -} diff --git a/.babelrc b/.babelrc deleted file mode 100755 index ec32f9bff68..00000000000 --- a/.babelrc +++ /dev/null @@ -1,6 +0,0 @@ -{ - "presets": ["es2015", "react", "stage-0"], - "plugins": [ - ["transform-decorators-legacy"], - ] -} diff --git a/.bumpversion.cfg b/.bumpversion.cfg deleted file mode 100644 index 712b62a821a..00000000000 --- a/.bumpversion.cfg +++ /dev/null @@ -1,5 +0,0 @@ -[bumpversion] -current_version = 1.1.0 -commit = True -tag = True - diff --git a/.dockercfg.template b/.dockercfg.template deleted file mode 100644 index 2ca7abf853c..00000000000 --- a/.dockercfg.template +++ /dev/null @@ -1 +0,0 @@ -{"https://index.docker.io/v1/":{"auth":"","email":""}} \ No newline at end of file diff --git a/.drone.yml b/.drone.yml deleted file mode 100644 index 79858ce04c1..00000000000 --- a/.drone.yml +++ /dev/null @@ -1,21 +0,0 @@ -image: go1.3 -env: - - RETHINKDB_TEST_PORT_28015_TCP_ADDR=127.0.0.1 - - RETHINKDB_TEST_PORT_28015_TCP_PORT=28015 - - RETHINKDB_TEST_DATABASE=shipyard_test - - DOCKER_TEST_ADDR=http://10.0.1.32:2375 -script: - - echo "Using env vars:" - - echo $RETHINKDB_TEST_PORT_28015_TCP_ADDR - - echo $RETHINKDB_TEST_PORT_28015_TCP_PORT - - echo $RETHINKDB_TEST_DATABASE - - echo $DOCKER_TEST_ADDR - - go get github.com/tools/godep - - pushd controller - - make test-drone - - popd - - pushd cli - - make test-drone - - popd -services: - - shipyard/rethinkdb diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 561df815840..00000000000 --- a/.editorconfig +++ /dev/null @@ -1,29 +0,0 @@ -# EditorConfig helps developers define and maintain consistent -# coding styles between different editors and IDEs -# editorconfig.org - -root = true - - -[*] - -# Change these settings to your own preference -indent_style = space -indent_size = 4 - -# We recommend you to keep these unchanged -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -[*.md] -trim_trailing_whitespace = false - -[package.json] -indent_style = space -indent_size = 2 - -[bower.json] -indent_style = space -indent_size = 2 diff --git a/.flowconfig b/.flowconfig deleted file mode 100644 index d8c97510c36..00000000000 --- a/.flowconfig +++ /dev/null @@ -1,14 +0,0 @@ -[ignore] -.*/app/scripts/build.* -.*/.tmp/.* -.*/node_modules/webpack.* -.*/node_modules/gulp-sass/.* - -[include] -app/scripts -node_modules/hub-js-sdk - -[libs] -./flow-libs - -[options] diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000000..ff1073d9e95 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,88 @@ +## Contributing + +We value your documentation contributions, and we want to make it as easy +as possible to work in this repository. One of the first things to decide is +which branch to base your work on. If you get confused, just ask and we will +help. If a reviewer realizes you have based your work on the wrong branch, we'll +let you know so that you can rebase it. + +>**Note**: To contribute code to Docker projects, see the +[Contribution guidelines](opensource/project/who-written-for). + +### Quickstart + +If you spot a problem while reading the documentation and want to try to fix it +yourself, click the **Edit this page** link at the bottom of that page. The +page will open in the Github editor, which means you don't need to know a lot +about Git, or even about Markdown. + +When you save, you will be prompted to create a fork if you don't already have +one, and to create a branch in your fork and submit the pull request. We hope +you give it a try! + +### Overall doc improvements + +Most commits will be made against the `master` branch. This include: + +- Conceptual and task-based information not specific to new features +- Restructuring / rewriting +- Doc bug fixing +- Typos and grammar errors + +One quirk of this project is that the `master` branch is where the live docs are +published from, so upcoming features can't be documented there. See +[Specific new features for a project](#specific-new-features-for-a-project) +for how to document upcoming features. These feature branches will be periodically +merged with `master`, so don't worry about fixing typos and documentation bugs +there. + +>Do you enjoy creating graphics? Good graphics are key to great documentation, +and we especially value contributions in this area. + +### Specific new features for a project + +Our docs cover many projects which release at different times. **If, and only if, +your pull request relates to a currently unreleased feature of a project, base +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. + +The following `vnext` branches currently exist: + +- **[vnext-engine](https://github.com/docker/docker.github.io/tree/vnext-engine):** + docs for upcoming features in the [docker/docker](https://github.com/docker/docker/) + project + +- **[vnext-compose](https://github.com/docker/docker.github.io/tree/vnext-compose):** + docs for upcoming features in the [docker/compose](https://github.com/docker/compose/) + project + +- **[vnext-distribution](https://github.com/docker/docker.github.io/tree/vnext-distribution):** + docs for upcoming features in the [docker/distribution](https://github.com/docker/distribution/) + project + +- **[vnext-opensource](https://github.com/docker/docker.github.io/tree/vnext-opensource):** + docs for upcoming features in the [docker/opensource](https://github.com/docker/opensource/) + project + +- **[vnext-swarm](https://github.com/docker/docker.github.io/tree/vnext-swarm):** + docs for upcoming features in the [docker/swarm](https://github.com/docker/swarm/) + project + +- **[vnext-toolbox](https://github.com/docker/docker.github.io/tree/vnext-toolbox):** + docs for upcoming features in the [docker/toolbox](https://github.com/docker/toolbox/) + project + +- **[vnext-kitematic](https://github.com/docker/docker.github.io/tree/vnext-kitematic):** + docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/) + project + +## Style guide + +If you have questions about how to write for Docker's documentation, please see +the [style guide](https://docs.docker.com/opensource/doc-style/). The style guide provides +guidance about grammar, syntax, formatting, styling, language, or tone. If +something isn't clear in the guide, please submit an issue to let us know or +submit a pull request to help us improve it. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000000..e643696f57a --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,26 @@ +### Problem description + + + +### Problem location + + + +- I saw a problem on the following URL: + +- I couldn't find the information I wanted. I expected to find it near the following URL: + +- Other:
+ +### Project version(s) affected + + + +### Suggestions for a fix + + + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..403812517b0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,33 @@ + + + + +### Describe the proposed changes + + + +### Project version + + + +### Related issue + + + +### Related issue or PR in another project + + + +### Please take a look + + + + + diff --git a/.htmllintrc b/.htmllintrc deleted file mode 100644 index b00de14f394..00000000000 --- a/.htmllintrc +++ /dev/null @@ -1,8 +0,0 @@ -{ - // names of npm modules to load into htmllint - "plugins": [], - "indent-style": "spaces", - "indent-width": 2, - "attr-name-style": "dash", - "html-req-lang": true -} diff --git a/.lfsconfig b/.lfsconfig deleted file mode 100644 index b246691ccf8..00000000000 --- a/.lfsconfig +++ /dev/null @@ -1,3 +0,0 @@ -[lfs] - url = git@github.com:docker/pinata - concurrenttransfers = 8 diff --git a/.mailmap b/.mailmap deleted file mode 100644 index 0527b6d84d6..00000000000 --- a/.mailmap +++ /dev/null @@ -1,254 +0,0 @@ -# Generate AUTHORS: hack/generate-authors.sh - -# Tip for finding duplicates (besides scanning the output of AUTHORS for name -# duplicates that aren't also email duplicates): scan the output of: -# git log --format='%aE - %aN' | sort -uf -# -# For explanation on this file format: man git-shortlog - -Patrick Stapleton -Shishir Mahajan -Erwin van der Koogh -Ahmed Kamal -Tejesh Mehta -Cristian Staretu -Cristian Staretu -Cristian Staretu -Marcus Linke -Aleksandrs Fadins -Christopher Latham -Hu Keping -Wayne Chang -Chen Chao -Daehyeok Mun - - - - - - -Guillaume J. Charmes - - - - - -Thatcher Peskens -Thatcher Peskens -Thatcher Peskens dhrp -Jérôme Petazzoni jpetazzo -Jérôme Petazzoni -Joffrey F -Joffrey F -Joffrey F -Tim Terhorst -Andy Smith - - - - - - - - - -Walter Stanish - -Roberto Hashioka -Konstantin Pelykh -David Sissitka -Nolan Darilek - -Benoit Chesneau -Jordan Arentsen -Daniel Garcia -Miguel Angel Fernández -Bhiraj Butala -Faiz Khan -Victor Lyuboslavsky -Jean-Baptiste Barth -Matthew Mueller - -Shih-Yuan Lee -Daniel Mizyrycki root -Jean-Baptiste Dalido - - - - - - - - - - - - - - -Sven Dowideit -Sven Dowideit -Sven Dowideit -Sven Dowideit <¨SvenDowideit@home.org.au¨> -Sven Dowideit -Sven Dowideit -Sven Dowideit - -Alexander Morozov -Alexander Morozov - -O.S. Tezer - -Roberto G. Hashioka - - - - - -Sridhar Ratnakumar -Sridhar Ratnakumar -Liang-Chi Hsieh -Aleksa Sarai -Aleksa Sarai -Aleksa Sarai -Will Weaver -Timothy Hobbs -Nathan LeClaire -Nathan LeClaire - - - - -Matthew Heon - - - - -Francisco Carriedo - - - - -Brian Goff - - - -Hollie Teal - - - -Jessica Frazelle -Jessica Frazelle -Jessica Frazelle -Jessica Frazelle -Jessica Frazelle - - - - -Thomas LEVEIL Thomas LÉVEIL - - -Antonio Murdaca -Antonio Murdaca -Antonio Murdaca -Antonio Murdaca -Antonio Murdaca -Darren Shepherd -Deshi Xiao -Deshi Xiao -Doug Davis -Jacob Atzen -Jeff Nickoloff -John Howard (VM) -John Howard (VM) -John Howard (VM) -John Howard (VM) -Madhu Venugopal -Mary Anthony -Mary Anthony moxiegirl -Mary Anthony -mattyw -resouer -AJ Bowen soulshake -AJ Bowen soulshake -Tibor Vass -Tibor Vass -Vincent Bernat -Yestin Sun -bin liu -John Howard (VM) jhowardmsft -Ankush Agarwal -Tangi COLIN tangicolin -Allen Sun -Adrien Gallouët - -Anuj Bahuguna -Anusha Ragunathan -Avi Miller -Brent Salisbury -Chander G -Chun Chen -Ying Li -Daehyeok Mun - -Daniel, Dao Quang Minh -Daniel Nephin -Dave Tucker -Doug Tangren -Frederick F. Kautz IV -Ben Golub -Harold Cooper -hsinko <21551195@zju.edu.cn> -Josh Hawn -Justin Cormack - - -Kamil Domański -Lei Jitang - -Linus Heckemann - -Lynda O'Leary - -Marianna Tessel -Michael Huettermann -Moysés Borges - -Nigel Poulton -Qiang Huang - -Boaz Shuster -Shuwei Hao - -Soshi Katsuta - -Stefan Berger - -Stephen Day - -Toli Kuznets -Tristan Carel - -Vincent Demeester - -Vishnu Kannan -xlgao-zju xlgao -yuchangchun y00277921 - - - - -Hao Shu Wei - - - - - - - -Shengbo Song mYmNeo -Shengbo Song - -Sylvain Bellemare - diff --git a/.npmrc b/.npmrc deleted file mode 100644 index dc4c80cdd00..00000000000 --- a/.npmrc +++ /dev/null @@ -1,2 +0,0 @@ -save = true -save-exact = true diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index 0e7b9d5f3bb..00000000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,25 +0,0 @@ -- repo: git://github.com/pre-commit/pre-commit-hooks - sha: 'v0.4.2' - hooks: - - id: check-added-large-files - - id: check-docstring-first - - id: check-merge-conflict - - id: check-yaml - - id: check-json - - id: debug-statements - - id: end-of-file-fixer - - id: flake8 - - id: name-tests-test - exclude: 'tests/(integration/testcases\.py|helpers\.py)' - - id: requirements-txt-fixer - - id: trailing-whitespace -- repo: git://github.com/asottile/reorder_python_imports - sha: v0.1.0 - hooks: - - id: reorder-python-imports - language_version: 'python2.7' - args: - - --add-import - - from __future__ import absolute_import - - --add-import - - from __future__ import unicode_literals diff --git a/.stylelintrc b/.stylelintrc deleted file mode 100644 index 8f369f1834f..00000000000 --- a/.stylelintrc +++ /dev/null @@ -1,11 +0,0 @@ -{ - "extends": "stylelint-config-standard", - "rules": { - "color-hex-length": "long" - }, - "ignoreFiles": [ - "node_modules/**/**.css", - "coverage/**/**.css", - "dist/**/**.css" - ] -} diff --git a/404.md b/404.md index c820ac4e30c..53e1ccdfd35 100644 --- a/404.md +++ b/404.md @@ -5,21 +5,35 @@ permalink: /404.html --- diff --git a/Dockerfile b/Dockerfile index ae3276413f2..239d0ed7ab2 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,9 +1,62 @@ -FROM starefossen/github-pages:onbuild +FROM starefossen/github-pages -ONBUILD RUN git clone https://www.github.com/docker/docker.github.io docs +RUN git clone https://www.github.com/docker/docker.github.io allv +RUN jekyll build -s allv -d allvbuild -ONBUILD WORKDIR docs +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' -ONBUILD COPY . /usr/src/app +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' -CMD jekyll serve -d /_site --watch -H 0.0.0.0 -P 4000 +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 diff --git a/README.md b/README.md index df1d316d294..c61b8ab3eb0 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,104 @@ # Docs @ Docker Welcome to the repo for our documentation. This is the source for the URL -served at docs.docker.com. +served at 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. + +**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. + +- 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 + the project's code repository. + +## Contributing + +We value your documentation contributions, and we want to make it as easy +as possible to work in this repository. One of the first things to decide is +which branch to base your work on. If you get confused, just ask and we will +help. If a reviewer realizes you have based your work on the wrong branch, we'll +let you know so that you can rebase it. + +>**Note**: To contribute code to Docker projects, see the +[Contribution guidelines](opensource/project/who-written-for). + +### Overall doc improvements + +Most commits will be made against the `master` branch. This include: + +- Conceptual and task-based information not specific to new features +- Restructuring / rewriting +- Doc bug fixing +- Typos and grammar errors + +One quirk of this project is that the `master` branch is where the live docs are +published from, so upcoming features can't be documented there. See +[Specific new features for a project](#specific-new-features-for-a-project) +for how to document upcoming features. These feature branches will be periodically +merged with `master`, so don't worry about fixing typos and documentation bugs +there. + +>Do you enjoy creating graphics? Good graphics are key to great documentation, +and we especially value contributions in this area. + +### Specific new features for a project + +Our docs cover many projects which release at different times. **If, and only if, +your pull request relates to a currently unreleased feature of a project, base +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. + +The following `vnext` branches currently exist: + +- **[vnext-engine](https://github.com/docker/docker.github.io/tree/vnext-engine):** + docs for upcoming features in the [docker/docker](https://github.com/docker/docker/) + project + +- **[vnext-compose](https://github.com/docker/docker.github.io/tree/vnext-compose):** + docs for upcoming features in the [docker/compose](https://github.com/docker/compose/) + project + +- **[vnext-distribution](https://github.com/docker/docker.github.io/tree/vnext-distribution):** + docs for upcoming features in the [docker/distribution](https://github.com/docker/distribution/) + project + +- **[vnext-opensource](https://github.com/docker/docker.github.io/tree/vnext-opensource):** + docs for upcoming features in the [docker/opensource](https://github.com/docker/opensource/) + project + +- **[vnext-swarm](https://github.com/docker/docker.github.io/tree/vnext-swarm):** + docs for upcoming features in the [docker/swarm](https://github.com/docker/swarm/) + project + +- **[vnext-toolbox](https://github.com/docker/docker.github.io/tree/vnext-toolbox):** + docs for upcoming features in the [docker/toolbox](https://github.com/docker/toolbox/) + project + +- **[vnext-kitematic](https://github.com/docker/docker.github.io/tree/vnext-kitematic):** + docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/) + project + + ## Staging You have three options: -1. (Most performant, slowest setup) 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. (Slow performance on Mac/Windows, fast setup) Clone this repo and run our - staging container: +1. Clone this repo and run our staging container: ```bash git clone https://github.com/docker/docker.github.io.git @@ -20,12 +106,33 @@ You have three options: docker-compose up ``` - If you haven't got Docker Compose installed, [follow these installation instructions](https://docs.docker.com/compose/install/). -3. (Edit entirely in the browser, no local clone) Fork this repo in GitHub, change your fork's repository name to `YOUR_GITHUB_USERNAME.github.io`, and make any changes. + If you haven't got Docker Compose installed, + [follow these installation instructions](/compose/install/). + + The container runs in the background and incrementally rebuilds the site each + time a file changes. You can keep your browser open to http://localhost:4000/ + and refresh to see your changes. The container runs in the foreground, but + you can use `CTRL+C` to get the command prompt back. To stop the container, + issue the following command: + + ```bash + 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. -In the first two options, the site will be staged at `http://localhost:4000` (unless Jekyll is behaving in some non-default way). + 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`. + You can continue working in a second terminal and Jekyll will rebuild the + website incrementally. Refresh the browser to preview your changes. -In the third option, the site will be viewable at `http://YOUR_GITHUB_USERNAME.github.io`, about a minute after your first change is merged into your fork. +3. Use Github Pages, with or without a local clone. Fork this repo in GitHub, + change your fork's repository name to `YOUR_GITHUB_USERNAME.github.io`, and + make changes to the Markdown files in your `master` branch. Browse to + https://.github.io/ to preview the changes. ## Important files @@ -43,7 +150,7 @@ directly on docs.docker.com. ## Style guide If you have questions about how to write for Docker's documentation, please see -the [style guide](https://docs.docker.com/opensource/doc-style/). The style guide provides +the [style guide](/opensource/doc-style/). The style guide provides guidance about grammar, syntax, formatting, styling, language, or tone. If something isn't clear in the guide, please submit an issue to let us know or submit a pull request to help us improve it. diff --git a/_config.yml b/_config.yml index 1886a5b5ac0..87023235029 100644 --- a/_config.yml +++ b/_config.yml @@ -9,13 +9,13 @@ incremental: true permalink: pretty safe: false lsi: false -exclude: - - vendor - - bin +url: https://docs.docker.com gems: - jekyll-redirect-from - jekyll-gist + - jekyll-seo-tag + defaults: - diff --git a/_data/toc.yaml b/_data/toc.yaml index dd3fd854c4a..555ee55dc3f 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -6,7 +6,7 @@ toc: - sectiontitle: Install section: - path: /engine/installation/mac/ - title: Installation on Mac OS X + title: Installation on macOS - path: /engine/installation/windows/ title: Installation on Windows - sectiontitle: On Linux distributions @@ -25,8 +25,6 @@ toc: title: Installation on Arch Linux - path: /engine/installation/linux/cruxlinux/ title: Installation on CRUX Linux - - path: /engine/installation/linux/frugalware/ - title: Installation on FrugalWare - path: /engine/installation/linux/gentoolinux/ title: Installation on Gentoo - path: /engine/installation/linux/oracle/ @@ -111,6 +109,8 @@ toc: title: Work with network commands - path: /engine/userguide/networking/get-started-overlay/ title: Get started with multi-host networking + - path: /engine/userguide/networking/get-started-macvlan/ + title: Get started with macvlan network driver - path: /engine/userguide/networking/overlay-security-model/ title: Swarm mode overlay network security model - path: /engine/userguide/networking/configure-dns/ @@ -167,6 +167,8 @@ toc: title: Splunk logging driver - path: /engine/admin/dsc/ title: PowerShell DSC Usage + - path: /engine/admin/ansible/ + title: Using Ansible - path: /engine/admin/chef/ title: Using Chef - path: /engine/admin/puppet/ @@ -253,6 +255,8 @@ toc: title: Seccomp security profiles for Docker - sectiontitle: Extend Engine section: + - path: /engine/extend/ + title: Managed plugin system - path: /engine/extend/plugins_authorization/ title: Access authorization plugin - path: /engine/extend/plugins/ @@ -630,7 +634,9 @@ toc: - path: /ucp/overview/ title: Universal Control Plane overview - path: /ucp/install-sandbox/ - title: Evaluate UCP in a sandbox + title: Install DDC in a sandbox for evaluation + - path: /ucp/install-sandbox-2/ + title: Evaluate DDC in a sandbox deployment - path: /ucp/architecture/ title: Architecture - sectiontitle: Installation @@ -769,6 +775,8 @@ toc: title: backup - path: /docker-trusted-registry/reference/dumpcerts/ title: dumpcerts + - path: /docker-trusted-registry/reference/images/ + title: images - path: /docker-trusted-registry/reference/install/ title: install - path: /docker-trusted-registry/reference/join/ @@ -781,6 +789,8 @@ toc: title: remove - path: /docker-trusted-registry/reference/restore/ title: restore + - path: /docker-trusted-registry/reference/upgrade/ + title: upgrade - sectiontitle: Configuration section: - path: /docker-trusted-registry/configure/configuration/ @@ -1095,6 +1105,8 @@ toc: section: - path: /docker-store/ title: Docker Store Overview + - path: /docker-store/ + title: Submit a product to Docker Store - path: /docker-store/faq/ title: Docker Store FAQs - sectiontitle: Docker Toolbox @@ -1206,7 +1218,7 @@ toc: - path: /registry/recipes/mirror/ title: Mirroring Docker Hub - path: /registry/recipes/osx-setup-guide/ - title: Running on OS X + title: Running on macOS - sectiontitle: Reference section: - path: /registry/spec/ diff --git a/_layouts/docs.html b/_layouts/docs.html index dc5ff90711d..48bf88c8a2e 100644 --- a/_layouts/docs.html +++ b/_layouts/docs.html @@ -3,7 +3,6 @@ {% else %} {% assign crumbs = page.url | split: '/' %} {% assign stoppingpoint = crumbs | size | minus: 1 %} -{% assign output = "" %} {% for crumb in crumbs %} {% if forloop.index == stoppingpoint %} {% capture basehref %}{{basehref}}{{ crumb }}/{% endcapture %} @@ -30,23 +29,17 @@ - - - - + - + - - + -Docker Docs{% if page.title %}: {{ page.title }}{% endif %} - - + @@ -81,6 +74,7 @@ +{% seo %}
@@ -214,10 +208,19 @@