Browse code
Merge pull request #683 from rogaha/doc_meta_info_update
- docs/sources/api/docker_remote_api.rst
- docs/sources/api/index.rst
- docs/sources/api/registry_api.rst
- docs/sources/commandline/command/attach.rst
- docs/sources/commandline/command/build.rst
- docs/sources/commandline/command/commit.rst
- docs/sources/commandline/command/diff.rst
- docs/sources/commandline/command/export.rst
- docs/sources/commandline/command/history.rst
- docs/sources/commandline/command/images.rst
- docs/sources/commandline/command/import.rst
- docs/sources/commandline/command/info.rst
- docs/sources/commandline/command/inspect.rst
- docs/sources/commandline/command/kill.rst
- docs/sources/commandline/command/login.rst
- docs/sources/commandline/command/logs.rst
- docs/sources/commandline/command/port.rst
- docs/sources/commandline/command/ps.rst
- docs/sources/commandline/command/pull.rst
- docs/sources/commandline/command/push.rst
- docs/sources/commandline/command/restart.rst
- docs/sources/commandline/command/rm.rst
- docs/sources/commandline/command/rmi.rst
- docs/sources/commandline/command/run.rst
- docs/sources/commandline/command/search.rst
- docs/sources/commandline/command/start.rst
- docs/sources/commandline/command/stop.rst
- docs/sources/commandline/command/tag.rst
- docs/sources/commandline/command/version.rst
- docs/sources/commandline/command/wait.rst
- docs/sources/commandline/index.rst
- docs/sources/concepts/buildingblocks.rst
- docs/sources/concepts/containers.rst
- docs/sources/concepts/index.rst
- docs/sources/contributing/contributing.rst
- docs/sources/faq.rst
- docs/sources/index/variable.rst
- docs/sources/installation/amazon.rst
- docs/sources/installation/archlinux.rst
- docs/sources/installation/binaries.rst
- docs/sources/installation/index.rst
- docs/sources/installation/kernel.rst
- docs/sources/installation/rackspace.rst
- docs/sources/installation/ubuntulinux.rst
- docs/sources/installation/upgrading.rst
- docs/sources/installation/vagrant.rst
- docs/sources/toctree.rst
- docs/sources/use/basics.rst
- docs/sources/use/builder.rst
- docs/sources/use/index.rst
- docs/sources/use/puppet.rst
- docs/sources/use/workingwithrepository.rst
- docs/theme/docker/layout.html
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Build Command |
|
| 2 |
+:description: Build a new image from the Dockerfile passed via stdin |
|
| 3 |
+:keywords: build, docker, container, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
======================================================== |
| 2 | 6 |
``build`` -- Build a container from Dockerfile via stdin |
| 3 | 7 |
======================================================== |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Commit Command |
|
| 2 |
+:description: Create a new image from a container's changes |
|
| 3 |
+:keywords: commit, docker, container, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
=========================================================== |
| 2 | 6 |
``commit`` -- Create a new image from a container's changes |
| 3 | 7 |
=========================================================== |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Diff Command |
|
| 2 |
+:description: Inspect changes on a container's filesystem |
|
| 3 |
+:keywords: diff, docker, container, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
======================================================= |
| 2 | 6 |
``diff`` -- Inspect changes on a container's filesystem |
| 3 | 7 |
======================================================= |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Export Command |
|
| 2 |
+:description: Export the contents of a filesystem as a tar archive |
|
| 3 |
+:keywords: export, docker, container, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
================================================================= |
| 2 | 6 |
``export`` -- Stream the contents of a container as a tar archive |
| 3 | 7 |
================================================================= |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: History Command |
|
| 2 |
+:description: Show the history of an image |
|
| 3 |
+:keywords: history, docker, container, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
=========================================== |
| 2 | 6 |
``history`` -- Show the history of an image |
| 3 | 7 |
=========================================== |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Import Command |
|
| 2 |
+:description: Create a new filesystem image from the contents of a tarball |
|
| 3 |
+:keywords: import, tarball, docker, url, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
========================================================================== |
| 2 | 6 |
``import`` -- Create a new filesystem image from the contents of a tarball |
| 3 | 7 |
========================================================================== |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Info Command |
|
| 2 |
+:description: Display system-wide information. |
|
| 3 |
+:keywords: info, docker, information, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
=========================================== |
| 2 | 6 |
``info`` -- Display system-wide information |
| 3 | 7 |
=========================================== |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Inspect Command |
|
| 2 |
+:description: Return low-level information on a container |
|
| 3 |
+:keywords: inspect, container, docker, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
========================================================== |
| 2 | 6 |
``inspect`` -- Return low-level information on a container |
| 3 | 7 |
========================================================== |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Login Command |
|
| 2 |
+:description: Register or Login to the docker registry server |
|
| 3 |
+:keywords: login, docker, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
============================================================ |
| 2 | 6 |
``login`` -- Register or Login to the docker registry server |
| 3 | 7 |
============================================================ |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Port Command |
|
| 2 |
+:description: Lookup the public-facing port which is NAT-ed to PRIVATE_PORT |
|
| 3 |
+:keywords: port, docker, container, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
========================================================================= |
| 2 | 6 |
``port`` -- Lookup the public-facing port which is NAT-ed to PRIVATE_PORT |
| 3 | 7 |
========================================================================= |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Pull Command |
|
| 2 |
+:description: Pull an image or a repository from the registry |
|
| 3 |
+:keywords: pull, image, repo, repository, documentation, docker |
|
| 4 |
+ |
|
| 1 | 5 |
========================================================================= |
| 2 | 6 |
``pull`` -- Pull an image or a repository from the docker registry server |
| 3 | 7 |
========================================================================= |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Push Command |
|
| 2 |
+:description: Push an image or a repository to the registry |
|
| 3 |
+:keywords: push, docker, image, repository, documentation, repo |
|
| 4 |
+ |
|
| 1 | 5 |
======================================================================= |
| 2 | 6 |
``push`` -- Push an image or a repository to the docker registry server |
| 3 | 7 |
======================================================================= |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Search Command |
|
| 2 |
+:description: Searches for the TERM parameter on the Docker index and prints out a list of repositories that match. |
|
| 3 |
+:keywords: search, docker, image, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
=================================================================== |
| 2 | 6 |
``search`` -- Search for an image in the docker index |
| 3 | 7 |
=================================================================== |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Tag Command |
|
| 2 |
+:description: Tag an image into a repository |
|
| 3 |
+:keywords: tag, docker, image, repository, documentation, repo |
|
| 4 |
+ |
|
| 1 | 5 |
========================================= |
| 2 | 6 |
``tag`` -- Tag an image into a repository |
| 3 | 7 |
========================================= |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Wait Command |
|
| 2 |
+:description: Block until a container stops, then print its exit code. |
|
| 3 |
+:keywords: wait, docker, container, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
=================================================================== |
| 2 | 6 |
``wait`` -- Block until a container stops, then print its exit code |
| 3 | 7 |
=================================================================== |
| ... | ... |
@@ -1,6 +1,6 @@ |
| 1 | 1 |
:title: Introduction |
| 2 | 2 |
:description: An introduction to docker and standard containers? |
| 3 |
-:keywords: containers, lxc, concepts, explanation |
|
| 3 |
+:keywords: containers, lxc, concepts, explanation, docker, documentation |
|
| 4 | 4 |
|
| 5 | 5 |
|
| 6 | 6 |
:note: This version of the introduction is temporary, just to make sure we don't break the links from the website when the documentation is updated |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Index Environment Variable |
|
| 2 |
+:description: Setting this environment variable on the docker server will change the URL docker index. |
|
| 3 |
+:keywords: docker, index environment variable, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
================================= |
| 2 | 6 |
Docker Index Environment Variable |
| 3 | 7 |
================================= |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Installation on Amazon EC2 |
|
| 2 |
+:description: Docker installation on Amazon EC2 with a single vagrant command. Vagrant 1.1 or higher is required. |
|
| 3 |
+:keywords: amazon ec2, virtualization, cloud, docker, documentation, installation |
|
| 4 |
+ |
|
| 1 | 5 |
Amazon EC2 |
| 2 | 6 |
========== |
| 3 | 7 |
|
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Requirements and Installation on Ubuntu Linux |
|
| 2 |
+:description: Please note this project is currently under heavy development. It should not be used in production. |
|
| 3 |
+:keywords: Docker, Docker documentation, requirements, virtualbox, vagrant, git, ssh, putty, cygwin, linux |
|
| 4 |
+ |
|
| 1 | 5 |
.. _ubuntu_linux: |
| 2 | 6 |
|
| 3 | 7 |
Ubuntu Linux |
| ... | ... |
@@ -1,3 +1,6 @@ |
| 1 |
+:title: Using Vagrant (Mac, Linux) |
|
| 2 |
+:description: This guide will setup a new virtualbox virtual machine with docker installed on your computer. |
|
| 3 |
+:keywords: Docker, Docker documentation, virtualbox, vagrant, git, ssh, putty, cygwin |
|
| 1 | 4 |
|
| 2 | 5 |
.. _install_using_vagrant: |
| 3 | 6 |
|
| ... | ... |
@@ -1,6 +1,6 @@ |
| 1 |
-:title: docker documentation |
|
| 2 |
-:description: docker documentation |
|
| 3 |
-:keywords: |
|
| 1 |
+:title: Documentation |
|
| 2 |
+:description: -- todo: change me |
|
| 3 |
+:keywords: todo, docker, documentation, installation, usage, examples, contributing, faq, command line, concepts |
|
| 4 | 4 |
|
| 5 | 5 |
Documentation |
| 6 | 6 |
============= |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Docker Builder |
|
| 2 |
+:description: Docker Builder specifes a simple DSL which allows you to automate the steps you would normally manually take to create an image. |
|
| 3 |
+:keywords: builder, docker, Docker Builder, automation, image creation |
|
| 4 |
+ |
|
| 1 | 5 |
============== |
| 2 | 6 |
Docker Builder |
| 3 | 7 |
============== |
| ... | ... |
@@ -1,3 +1,7 @@ |
| 1 |
+:title: Working With Repositories |
|
| 2 |
+:description: Generally, there are two types of repositories: Top-level repositories which are controlled by the people behind Docker, and user repositories. |
|
| 3 |
+:keywords: repo, repositiores, usage, pull image, push image, image, documentation |
|
| 4 |
+ |
|
| 1 | 5 |
.. _working_with_the_repository: |
| 2 | 6 |
|
| 3 | 7 |
Working with the repository |
| ... | ... |
@@ -8,7 +8,7 @@ |
| 8 | 8 |
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| 9 | 9 |
<meta name="google-site-verification" content="UxV66EKuPe87dgnH1sbrldrx6VsoWMrx5NjwkgUFxXI" /> |
| 10 | 10 |
|
| 11 |
- <title>Docker - {{ meta['title'] if meta and meta['title'] else title }}</title>
|
|
| 11 |
+ <title>{{ meta['title'] if meta and meta['title'] else title }} - Docker Documentation</title>
|
|
| 12 | 12 |
|
| 13 | 13 |
<meta name="description" content="{{ meta['description'] if meta }}" />
|
| 14 | 14 |
<meta name="keywords" content="{{ meta['keywords'] if meta }}" />
|