Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.81 KB

README.md

File metadata and controls

59 lines (40 loc) · 2.81 KB
Raw

Docs @ Docker

Welcome to the repo for our documentation. This is the source for the URL served at 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!

Staging

You have three options:

  1. (Most performant, slowest setup) Clone this repo, install Ruby 2.3 or higher (required), install the GitHub Pages Ruby gem, then run jekyll serve from within the directory.

  2. (Slow performance on Mac/Windows, fast setup) Clone this repo and run our staging container:

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

    If you haven't got Docker Compose installed, follow these installation instructions.

  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.

In the first two options, the site will be staged at http://localhost:4000 (unless Jekyll is behaving in some non-default way).

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.

Important files

  • /_data/toc.yaml defines the left-hand navigation for the docs
  • /js/menu.js defines most of the docs-specific JS such as TOC generation and menu syncing
  • /css/documentation.css 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

Relative linking for GitHub viewing

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.

Style guide

If you have questions about how to write for Docker's documentation, please see the style guide. 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.

Generate the man pages

For information on generating man pages (short for manual page), see the README.md document in the man page directory in this project.

Copyright and license

Code and documentation copyright 2016 Docker, inc, released under the Apache 2.0 license.