Welcome to the repo for our documentation. This is the source for 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
• Contributing
  • Files not edited here
  • Overall doc improvements
• Per-PR staging on GitHub
• Build and preview the docs locally
  • Build the docs with deployment features enabled
• Important files
• Relative linking for GitHub viewing
  • Testing changes and practical guidance
  • Per-page front-matter
  • Creating tabs
  • Running in-page Javascript
  • Images
• Copyright and license

We really want your feedback, and we've made it easy. You can edit a page or request changes in the right column of every page on docs.docker.com. You can also rate each page by clicking a link at the footer.

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, ask in 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, file that issue in the project's code repository.

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.

Files and directories listed in the path: keys in .NOT_EDITED_HERE.yaml are maintained in other repositories and should not be edited in this one. Pull requests against these files will be rejected. Make your edits to the files in the repository and path in the source: key in the YAML file.

Pull requests should be opened against the master branch, this includes:

• Conceptual and task-based information not specific to new features
• Restructuring / rewriting
• Doc bug fixing
• Typos and grammar errors

Do you enjoy creating graphics? Good graphics are key to great documentation, and we especially value contributions in this area.

For every PR against master, 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 https://docs.docker.com/.

On your local machine, clone this repo:

git clone --recursive https://github.com/docker/docker.github.io.git
cd docker.github.io

Then build and run the documentation with Docker Compose

docker-compose up -d --build

Docker Compose is included with Docker Desktop. If you don't have Docker Compose installed, follow these installation instructions.

Once the container is built and running, visit http://localhost:4000 in your web browser to view the docs.

To rebuild the docs after you made changes, run the docker-compose up command again. This rebuilds the documentation, and updates the container with your changes:

docker-compose up -d --build

Once the container is built and running, visit http://localhost:4000 in your web browser to view the docs.

To stop the staging container, use the docker-compose down command:

docker-compose down

The default configuration for local builds of the documentation disables some features to allow for a shorter build-time. The following options differ between local builds, and builds that are deployed to docs.docker.com:

• search auto-completion, and generation of js/metadata.json
• google analytics
• page ratings
• sitemap.xml generation
• minification of stylesheets (css/style.css)
• adjusting "edit this page" links for content in other repositories

If you want to contribute in these areas, you can perform a "production" build locally.

To preview the documentation with deployment features enabled, you need to set the JEKYLL_ENV environment variable when building the documentation;

JEKYLL_ENV=production docker-compose up --build

Once the container is built and running, visit http://localhost:4000 in your web browser to view the docs.

To rebuild the docs after you make changes, repeat the steps above.

• /_data/toc.yaml defines the left-hand navigation for the docs
• /js/docs.js defines most of the docs-specific JS such as TOC generation and menu syncing
• /css/style.scss defines the docs-specific style rules
• /_layouts/docs.html is the HTML template file, which defines the header and footer, and includes all the JS/CSS that serves the docs content

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 https://docs.docker.com/.

If you want to test a style change, or if you want to see how to achieve a particular outcome with Markdown, Bootstrap, JQuery, or something else, have a look at test.md (which renders in the site at /test/).

The front-matter of a given page is in a section at the top of the Markdown file that starts and ends with three hyphens. It includes YAML content. The following keys are supported. The title, description, and keywords are required.

The following is an example of valid (but contrived) page metadata. The order of the metadata elements in the front-matter is not important.

---
description: Instructions for installing Docker on Ubuntu
keywords: requirements, apt, installation, ubuntu, install, uninstall, upgrade, update
redirect_from:
- /engine/installation/ubuntulinux/
- /installation/ubuntulinux/
- /engine/installation/linux/ubuntulinux/
title: Get Docker for Ubuntu
toc_min: 1
toc_max: 6
skip_read_time: true
no_ratings: true
---

The use of tabs, as on pages like https://docs.docker.com/engine/api/, requires the use of HTML. The tabs use Bootstrap CSS/JS, so refer to those docs for more advanced usage. For a basic horizontal tab set, copy/paste starting from this code and implement from there. Keep an eye on those href="#id" and id="id" references as you rename, add, and remove tabs.

<ul class="nav nav-tabs">
  <li class="active"><a data-toggle="tab" data-target="#tab1">TAB 1 HEADER</a></li>
  <li><a data-toggle="tab" data-target="#tab2">TAB 2 HEADER</a></li>
</ul>
<div class="tab-content">
  <div id="tab1" class="tab-pane fade in active">TAB 1 CONTENT</div>
  <div id="tab2" class="tab-pane fade">TAB 2 CONTENT</div>
</div>

For more info and a few more permutations, see test.md.

If you need to run custom Javascript within a page, and it depends upon JQuery or Bootstrap, make sure the <script> tags are at the very end of the page, after all the content. Otherwise the script may try to run before JQuery and Bootstrap JS are loaded.

Note: In general, this is a bad idea.

Don't forget to remove images that are no longer used. Keep the images sorted in the local images/ directory, with names that naturally group related images together in alphabetical order. For instance prefer settings-file-share.png and settings-proxies.png to file-share-settings.png and proxies-settings.png. You may also use numbers, especially in the case of a sequence, e.g., run-only-the-images-you-trust-1.svg run-only-the-images-you-trust-2.png run-only-the-images-you-trust-3.png.

When applicable, capture windows rather than rectangular regions. This eliminates unpleasant background and saves the editors the need to crop.

On Mac, capture windows without shadows. To this end, once you pressed Command-Shift-4, press Option while clicking on the window. To disable shadows once for all, run:

$ defaults write com.apple.screencapture disable-shadow -bool TRUE
$ killall SystemUIServer  # restart it.

You can restore shadows later with -bool FALSE.

In order to keep the Git repository light, please compress the images (losslessly). On Mac you may use ImageOptim for instance. Be sure to compress the images before adding them to the repository, doing it afterwards actually worsens the impact on the Git repo (but still optimizes the bandwidth during browsing).

Copyright 2013-2021 Docker, inc, released under the Apache 2.0 license.