diff --git a/docs/sources/api/docker_remote_api.rst b/docs/sources/api/docker_remote_api.rst index 5d62963b4..4c8ebe847 100644 --- a/docs/sources/api/docker_remote_api.rst +++ b/docs/sources/api/docker_remote_api.rst @@ -1,3 +1,7 @@ +:title: Remote API +:description: API Documentation for Docker +:keywords: API, Docker, rcli, REST, documentation + ================= Docker Remote API ================= diff --git a/docs/sources/api/index.rst b/docs/sources/api/index.rst index 8c118bcbc..4d8ff3fe6 100644 --- a/docs/sources/api/index.rst +++ b/docs/sources/api/index.rst @@ -1,6 +1,6 @@ -:title: docker documentation +:title: API Documentation :description: docker documentation -:keywords: +:keywords: docker, ipa, documentation API's ============= diff --git a/docs/sources/api/registry_api.rst b/docs/sources/api/registry_api.rst index e299584e1..f33ca187b 100644 --- a/docs/sources/api/registry_api.rst +++ b/docs/sources/api/registry_api.rst @@ -1,4 +1,4 @@ -:title: docker Registry documentation +:title: Registry Documentation :description: Documentation for docker Registry and Registry API :keywords: docker, registry, api, index diff --git a/docs/sources/commandline/command/attach.rst b/docs/sources/commandline/command/attach.rst index ac9a84c0c..4c4c189d8 100644 --- a/docs/sources/commandline/command/attach.rst +++ b/docs/sources/commandline/command/attach.rst @@ -1,3 +1,7 @@ +:title: Attach Command +:description: Attach to a running container +:keywords: attach, container, docker, documentation + =========================================== ``attach`` -- Attach to a running container =========================================== diff --git a/docs/sources/commandline/command/build.rst b/docs/sources/commandline/command/build.rst index 8d07c725c..a8d2093a5 100644 --- a/docs/sources/commandline/command/build.rst +++ b/docs/sources/commandline/command/build.rst @@ -1,3 +1,7 @@ +:title: Build Command +:description: Build a new image from the Dockerfile passed via stdin +:keywords: build, docker, container, documentation + ======================================================== ``build`` -- Build a container from Dockerfile via stdin ======================================================== diff --git a/docs/sources/commandline/command/commit.rst b/docs/sources/commandline/command/commit.rst index 1d5c50341..92f320566 100644 --- a/docs/sources/commandline/command/commit.rst +++ b/docs/sources/commandline/command/commit.rst @@ -1,3 +1,7 @@ +:title: Commit Command +:description: Create a new image from a container's changes +:keywords: commit, docker, container, documentation + =========================================================== ``commit`` -- Create a new image from a container's changes =========================================================== diff --git a/docs/sources/commandline/command/diff.rst b/docs/sources/commandline/command/diff.rst index 301da6c49..2901a7f21 100644 --- a/docs/sources/commandline/command/diff.rst +++ b/docs/sources/commandline/command/diff.rst @@ -1,3 +1,7 @@ +:title: Diff Command +:description: Inspect changes on a container's filesystem +:keywords: diff, docker, container, documentation + ======================================================= ``diff`` -- Inspect changes on a container's filesystem ======================================================= diff --git a/docs/sources/commandline/command/export.rst b/docs/sources/commandline/command/export.rst index 88ecd2fd5..9d7e6b369 100644 --- a/docs/sources/commandline/command/export.rst +++ b/docs/sources/commandline/command/export.rst @@ -1,3 +1,7 @@ +:title: Export Command +:description: Export the contents of a filesystem as a tar archive +:keywords: export, docker, container, documentation + ================================================================= ``export`` -- Stream the contents of a container as a tar archive ================================================================= diff --git a/docs/sources/commandline/command/history.rst b/docs/sources/commandline/command/history.rst index 92fad3b48..2f9d3f281 100644 --- a/docs/sources/commandline/command/history.rst +++ b/docs/sources/commandline/command/history.rst @@ -1,3 +1,7 @@ +:title: History Command +:description: Show the history of an image +:keywords: history, docker, container, documentation + =========================================== ``history`` -- Show the history of an image =========================================== diff --git a/docs/sources/commandline/command/images.rst b/docs/sources/commandline/command/images.rst index 5bcfe817f..497bda6e1 100644 --- a/docs/sources/commandline/command/images.rst +++ b/docs/sources/commandline/command/images.rst @@ -1,3 +1,7 @@ +:title: Images Command +:description: List images +:keywords: images, docker, container, documentation + ========================= ``images`` -- List images ========================= diff --git a/docs/sources/commandline/command/import.rst b/docs/sources/commandline/command/import.rst index 5fe90764b..34a7138e0 100644 --- a/docs/sources/commandline/command/import.rst +++ b/docs/sources/commandline/command/import.rst @@ -1,3 +1,7 @@ +:title: Import Command +:description: Create a new filesystem image from the contents of a tarball +:keywords: import, tarball, docker, url, documentation + ========================================================================== ``import`` -- Create a new filesystem image from the contents of a tarball ========================================================================== diff --git a/docs/sources/commandline/command/info.rst b/docs/sources/commandline/command/info.rst index 10697dba1..6df3486c5 100644 --- a/docs/sources/commandline/command/info.rst +++ b/docs/sources/commandline/command/info.rst @@ -1,3 +1,7 @@ +:title: Info Command +:description: Display system-wide information. +:keywords: info, docker, information, documentation + =========================================== ``info`` -- Display system-wide information =========================================== diff --git a/docs/sources/commandline/command/inspect.rst b/docs/sources/commandline/command/inspect.rst index 34365d1f2..90dbe959e 100644 --- a/docs/sources/commandline/command/inspect.rst +++ b/docs/sources/commandline/command/inspect.rst @@ -1,3 +1,7 @@ +:title: Inspect Command +:description: Return low-level information on a container +:keywords: inspect, container, docker, documentation + ========================================================== ``inspect`` -- Return low-level information on a container ========================================================== diff --git a/docs/sources/commandline/command/kill.rst b/docs/sources/commandline/command/kill.rst index cbd019e1a..f53d3883b 100644 --- a/docs/sources/commandline/command/kill.rst +++ b/docs/sources/commandline/command/kill.rst @@ -1,3 +1,7 @@ +:title: Kill Command +:description: Kill a running container +:keywords: kill, container, docker, documentation + ==================================== ``kill`` -- Kill a running container ==================================== diff --git a/docs/sources/commandline/command/login.rst b/docs/sources/commandline/command/login.rst index b064b4014..bab4fa34e 100644 --- a/docs/sources/commandline/command/login.rst +++ b/docs/sources/commandline/command/login.rst @@ -1,3 +1,7 @@ +:title: Login Command +:description: Register or Login to the docker registry server +:keywords: login, docker, documentation + ============================================================ ``login`` -- Register or Login to the docker registry server ============================================================ diff --git a/docs/sources/commandline/command/logs.rst b/docs/sources/commandline/command/logs.rst index 87f3f95b6..a3423f6e0 100644 --- a/docs/sources/commandline/command/logs.rst +++ b/docs/sources/commandline/command/logs.rst @@ -1,3 +1,7 @@ +:title: Logs Command +:description: Fetch the logs of a container +:keywords: logs, container, docker, documentation + ========================================= ``logs`` -- Fetch the logs of a container ========================================= diff --git a/docs/sources/commandline/command/port.rst b/docs/sources/commandline/command/port.rst index 4fb6d7f81..8d59fedab 100644 --- a/docs/sources/commandline/command/port.rst +++ b/docs/sources/commandline/command/port.rst @@ -1,3 +1,7 @@ +:title: Port Command +:description: Lookup the public-facing port which is NAT-ed to PRIVATE_PORT +:keywords: port, docker, container, documentation + ========================================================================= ``port`` -- Lookup the public-facing port which is NAT-ed to PRIVATE_PORT ========================================================================= diff --git a/docs/sources/commandline/command/ps.rst b/docs/sources/commandline/command/ps.rst index f73177918..597dbd9ae 100644 --- a/docs/sources/commandline/command/ps.rst +++ b/docs/sources/commandline/command/ps.rst @@ -1,3 +1,7 @@ +:title: Ps Command +:description: List containers +:keywords: ps, docker, documentation, container + ========================= ``ps`` -- List containers ========================= diff --git a/docs/sources/commandline/command/pull.rst b/docs/sources/commandline/command/pull.rst index 1c417ddcd..4348f28d0 100644 --- a/docs/sources/commandline/command/pull.rst +++ b/docs/sources/commandline/command/pull.rst @@ -1,3 +1,7 @@ +:title: Pull Command +:description: Pull an image or a repository from the registry +:keywords: pull, image, repo, repository, documentation, docker + ========================================================================= ``pull`` -- Pull an image or a repository from the docker registry server ========================================================================= diff --git a/docs/sources/commandline/command/push.rst b/docs/sources/commandline/command/push.rst index a42296c71..9304f9acc 100644 --- a/docs/sources/commandline/command/push.rst +++ b/docs/sources/commandline/command/push.rst @@ -1,3 +1,7 @@ +:title: Push Command +:description: Push an image or a repository to the registry +:keywords: push, docker, image, repository, documentation, repo + ======================================================================= ``push`` -- Push an image or a repository to the docker registry server ======================================================================= diff --git a/docs/sources/commandline/command/restart.rst b/docs/sources/commandline/command/restart.rst index 24bba5a5a..dfc0dfea6 100644 --- a/docs/sources/commandline/command/restart.rst +++ b/docs/sources/commandline/command/restart.rst @@ -1,3 +1,7 @@ +:title: Restart Command +:description: Restart a running container +:keywords: restart, container, docker, documentation + ========================================== ``restart`` -- Restart a running container ========================================== diff --git a/docs/sources/commandline/command/rm.rst b/docs/sources/commandline/command/rm.rst index f6d6893bf..dc6d91632 100644 --- a/docs/sources/commandline/command/rm.rst +++ b/docs/sources/commandline/command/rm.rst @@ -1,3 +1,7 @@ +:title: Rm Command +:description: Remove a container +:keywords: remove, container, docker, documentation, rm + ============================ ``rm`` -- Remove a container ============================ diff --git a/docs/sources/commandline/command/rmi.rst b/docs/sources/commandline/command/rmi.rst index 3761196f2..a0131886d 100644 --- a/docs/sources/commandline/command/rmi.rst +++ b/docs/sources/commandline/command/rmi.rst @@ -1,3 +1,7 @@ +:title: Rmi Command +:description: Remove an image +:keywords: rmi, remove, image, docker, documentation + ========================== ``rmi`` -- Remove an image ========================== diff --git a/docs/sources/commandline/command/run.rst b/docs/sources/commandline/command/run.rst index 95fb208dd..f9bd568b6 100644 --- a/docs/sources/commandline/command/run.rst +++ b/docs/sources/commandline/command/run.rst @@ -1,3 +1,7 @@ +:title: Run Command +:description: Run a command in a new container +:keywords: run, container, docker, documentation + =========================================== ``run`` -- Run a command in a new container =========================================== diff --git a/docs/sources/commandline/command/search.rst b/docs/sources/commandline/command/search.rst index 0af24dfaf..2f07e20c3 100644 --- a/docs/sources/commandline/command/search.rst +++ b/docs/sources/commandline/command/search.rst @@ -1,3 +1,7 @@ +:title: Search Command +:description: Searches for the TERM parameter on the Docker index and prints out a list of repositories that match. +:keywords: search, docker, image, documentation + =================================================================== ``search`` -- Search for an image in the docker index =================================================================== diff --git a/docs/sources/commandline/command/start.rst b/docs/sources/commandline/command/start.rst index df415ca3d..b70ad21cf 100644 --- a/docs/sources/commandline/command/start.rst +++ b/docs/sources/commandline/command/start.rst @@ -1,3 +1,7 @@ +:title: Start Command +:description: Start a stopped container +:keywords: start, docker, container, documentation + ====================================== ``start`` -- Start a stopped container ====================================== diff --git a/docs/sources/commandline/command/stop.rst b/docs/sources/commandline/command/stop.rst index df6d66ccf..3d571563e 100644 --- a/docs/sources/commandline/command/stop.rst +++ b/docs/sources/commandline/command/stop.rst @@ -1,3 +1,7 @@ +:title: Stop Command +:description: Stop a running container +:keywords: stop, container, docker, documentation + ==================================== ``stop`` -- Stop a running container ==================================== diff --git a/docs/sources/commandline/command/tag.rst b/docs/sources/commandline/command/tag.rst index 59647355e..a9e831aae 100644 --- a/docs/sources/commandline/command/tag.rst +++ b/docs/sources/commandline/command/tag.rst @@ -1,3 +1,7 @@ +:title: Tag Command +:description: Tag an image into a repository +:keywords: tag, docker, image, repository, documentation, repo + ========================================= ``tag`` -- Tag an image into a repository ========================================= diff --git a/docs/sources/commandline/command/version.rst b/docs/sources/commandline/command/version.rst index eedf02f2d..fb3d3b450 100644 --- a/docs/sources/commandline/command/version.rst +++ b/docs/sources/commandline/command/version.rst @@ -1,3 +1,7 @@ +:title: Version Command +:description: +:keywords: version, docker, documentation + ================================================== ``version`` -- Show the docker version information ================================================== diff --git a/docs/sources/commandline/command/wait.rst b/docs/sources/commandline/command/wait.rst index 2959bf880..23bd54513 100644 --- a/docs/sources/commandline/command/wait.rst +++ b/docs/sources/commandline/command/wait.rst @@ -1,3 +1,7 @@ +:title: Wait Command +:description: Block until a container stops, then print its exit code. +:keywords: wait, docker, container, documentation + =================================================================== ``wait`` -- Block until a container stops, then print its exit code =================================================================== diff --git a/docs/sources/commandline/index.rst b/docs/sources/commandline/index.rst index fecf8e488..f1a3e2da4 100644 --- a/docs/sources/commandline/index.rst +++ b/docs/sources/commandline/index.rst @@ -1,6 +1,6 @@ -:title: docker documentation +:title: Commands :description: -- todo: change me -:keywords: todo: change me +:keywords: todo, commands, command line, help, docker, documentation Commands diff --git a/docs/sources/concepts/buildingblocks.rst b/docs/sources/concepts/buildingblocks.rst index 154ef00f4..5f752ea47 100644 --- a/docs/sources/concepts/buildingblocks.rst +++ b/docs/sources/concepts/buildingblocks.rst @@ -1,4 +1,4 @@ -:title: Building blocks +:title: Building Blocks :description: An introduction to docker and standard containers? :keywords: containers, lxc, concepts, explanation diff --git a/docs/sources/concepts/containers.rst b/docs/sources/concepts/containers.rst index 8378a7e29..e08c3654c 100644 --- a/docs/sources/concepts/containers.rst +++ b/docs/sources/concepts/containers.rst @@ -1,6 +1,6 @@ :title: Introduction :description: An introduction to docker and standard containers? -:keywords: containers, lxc, concepts, explanation +:keywords: containers, lxc, concepts, explanation, docker, documentation :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 diff --git a/docs/sources/concepts/index.rst b/docs/sources/concepts/index.rst index d8e1af577..ba1f9f471 100644 --- a/docs/sources/concepts/index.rst +++ b/docs/sources/concepts/index.rst @@ -1,6 +1,6 @@ -:title: docker documentation +:title: Concepts :description: -- todo: change me -:keywords: todo: change me +:keywords: concepts, documentation, docker, containers diff --git a/docs/sources/contributing/contributing.rst b/docs/sources/contributing/contributing.rst index 7b2b4da2d..c2bd7c80f 100644 --- a/docs/sources/contributing/contributing.rst +++ b/docs/sources/contributing/contributing.rst @@ -1,3 +1,7 @@ +:title: Contribution Guidelines +:description: Contribution guidelines: create issues, convetions, pull requests +:keywords: contributing, docker, documentation, help, guideline + Contributing to Docker ====================== diff --git a/docs/sources/faq.rst b/docs/sources/faq.rst index b96ed0643..901e51ddb 100644 --- a/docs/sources/faq.rst +++ b/docs/sources/faq.rst @@ -1,3 +1,7 @@ +:title: FAQ +:description: Most frequently asked questions. +:keywords: faq, questions, documentation, docker + FAQ === diff --git a/docs/sources/index/variable.rst b/docs/sources/index/variable.rst index efbcfae80..90eac3af8 100644 --- a/docs/sources/index/variable.rst +++ b/docs/sources/index/variable.rst @@ -1,3 +1,7 @@ +:title: Index Environment Variable +:description: Setting this environment variable on the docker server will change the URL docker index. +:keywords: docker, index environment variable, documentation + ================================= Docker Index Environment Variable ================================= diff --git a/docs/sources/installation/amazon.rst b/docs/sources/installation/amazon.rst index 64ff20f8b..59896bb63 100644 --- a/docs/sources/installation/amazon.rst +++ b/docs/sources/installation/amazon.rst @@ -1,3 +1,7 @@ +:title: Installation on Amazon EC2 +:description: Docker installation on Amazon EC2 with a single vagrant command. Vagrant 1.1 or higher is required. +:keywords: amazon ec2, virtualization, cloud, docker, documentation, installation + Amazon EC2 ========== diff --git a/docs/sources/installation/archlinux.rst b/docs/sources/installation/archlinux.rst index db013c6cb..9e3766eb2 100644 --- a/docs/sources/installation/archlinux.rst +++ b/docs/sources/installation/archlinux.rst @@ -1,3 +1,7 @@ +:title: Installation on Arch Linux +:description: Docker installation on Arch Linux. +:keywords: arch linux, virtualization, docker, documentation, installation + .. _arch_linux: Arch Linux diff --git a/docs/sources/installation/binaries.rst b/docs/sources/installation/binaries.rst index 25d13ab68..8bab5695c 100644 --- a/docs/sources/installation/binaries.rst +++ b/docs/sources/installation/binaries.rst @@ -1,3 +1,7 @@ +:title: Installation from Binaries +:description: This instruction set is meant for hackers who want to try out Docker on a variety of environments. +:keywords: binaries, installation, docker, documentation, linux + .. _binaries: Binaries diff --git a/docs/sources/installation/index.rst b/docs/sources/installation/index.rst index 1976f30ba..9f831091c 100644 --- a/docs/sources/installation/index.rst +++ b/docs/sources/installation/index.rst @@ -1,6 +1,6 @@ -:title: docker documentation +:title: Documentation :description: -- todo: change me -:keywords: todo: change me +:keywords: todo, docker, documentation, installation, OS support diff --git a/docs/sources/installation/kernel.rst b/docs/sources/installation/kernel.rst index 2ec5940a7..61a7bb385 100644 --- a/docs/sources/installation/kernel.rst +++ b/docs/sources/installation/kernel.rst @@ -1,3 +1,7 @@ +:title: Kernel Requirements +:description: Kernel supports +:keywords: kernel requirements, kernel support, docker, installation, cgroups, namespaces + .. _kernel: Kernel Requirements diff --git a/docs/sources/installation/rackspace.rst b/docs/sources/installation/rackspace.rst index dfb88aee8..748240468 100644 --- a/docs/sources/installation/rackspace.rst +++ b/docs/sources/installation/rackspace.rst @@ -1,3 +1,7 @@ +:title: Rackspace Cloud Installation +:description: Installing Docker on Ubuntu proviced by Rackspace +:keywords: Rackspace Cloud, installation, docker, linux, ubuntu + =============== Rackspace Cloud =============== diff --git a/docs/sources/installation/ubuntulinux.rst b/docs/sources/installation/ubuntulinux.rst index de4a2bb9c..6d2d3e671 100644 --- a/docs/sources/installation/ubuntulinux.rst +++ b/docs/sources/installation/ubuntulinux.rst @@ -1,3 +1,7 @@ +:title: Requirements and Installation on Ubuntu Linux +:description: Please note this project is currently under heavy development. It should not be used in production. +:keywords: Docker, Docker documentation, requirements, virtualbox, vagrant, git, ssh, putty, cygwin, linux + .. _ubuntu_linux: Ubuntu Linux diff --git a/docs/sources/installation/upgrading.rst b/docs/sources/installation/upgrading.rst index 8dfde7389..9fa47904b 100644 --- a/docs/sources/installation/upgrading.rst +++ b/docs/sources/installation/upgrading.rst @@ -1,3 +1,7 @@ +:title: Upgrading +:description: These instructions are for upgrading Docker +:keywords: Docker, Docker documentation, upgrading docker, upgrade + .. _upgrading: Upgrading diff --git a/docs/sources/installation/vagrant.rst b/docs/sources/installation/vagrant.rst index d1a76b5a2..24a1e9135 100644 --- a/docs/sources/installation/vagrant.rst +++ b/docs/sources/installation/vagrant.rst @@ -1,3 +1,6 @@ +:title: Using Vagrant (Mac, Linux) +:description: This guide will setup a new virtualbox virtual machine with docker installed on your computer. +:keywords: Docker, Docker documentation, virtualbox, vagrant, git, ssh, putty, cygwin .. _install_using_vagrant: diff --git a/docs/sources/toctree.rst b/docs/sources/toctree.rst index 09f2a7af5..ae6d5f010 100644 --- a/docs/sources/toctree.rst +++ b/docs/sources/toctree.rst @@ -1,6 +1,6 @@ -:title: docker documentation -:description: docker documentation -:keywords: +:title: Documentation +:description: -- todo: change me +:keywords: todo, docker, documentation, installation, usage, examples, contributing, faq, command line, concepts Documentation ============= diff --git a/docs/sources/use/basics.rst b/docs/sources/use/basics.rst index ffd2a7b96..6ae0711f1 100644 --- a/docs/sources/use/basics.rst +++ b/docs/sources/use/basics.rst @@ -1,6 +1,6 @@ -:title: Base commands +:title: Basic Commands :description: Common usage and commands -:keywords: Examples, Usage +:keywords: Examples, Usage, basic commands, docker, documentation, examples The basics diff --git a/docs/sources/use/builder.rst b/docs/sources/use/builder.rst index 84d275782..4e53ed4a7 100644 --- a/docs/sources/use/builder.rst +++ b/docs/sources/use/builder.rst @@ -1,3 +1,7 @@ +:title: Docker Builder +:description: Docker Builder specifes a simple DSL which allows you to automate the steps you would normally manually take to create an image. +:keywords: builder, docker, Docker Builder, automation, image creation + ============== Docker Builder ============== diff --git a/docs/sources/use/index.rst b/docs/sources/use/index.rst index 9939dc7ea..a1086c1fd 100644 --- a/docs/sources/use/index.rst +++ b/docs/sources/use/index.rst @@ -1,6 +1,6 @@ -:title: docker documentation +:title: Documentation :description: -- todo: change me -:keywords: todo: change me +:keywords: todo, docker, documentation, basic, builder diff --git a/docs/sources/use/puppet.rst b/docs/sources/use/puppet.rst index af2d5c8d5..1c48aec8e 100644 --- a/docs/sources/use/puppet.rst +++ b/docs/sources/use/puppet.rst @@ -1,3 +1,6 @@ +:title: Puppet Usage +:description: Installating and using Puppet +:keywords: puppet, installation, usage, docker, documentation .. _install_using_puppet: diff --git a/docs/sources/use/workingwithrepository.rst b/docs/sources/use/workingwithrepository.rst index c1ce7f455..9a2f96cf0 100644 --- a/docs/sources/use/workingwithrepository.rst +++ b/docs/sources/use/workingwithrepository.rst @@ -1,3 +1,7 @@ +:title: Working With Repositories +:description: Generally, there are two types of repositories: Top-level repositories which are controlled by the people behind Docker, and user repositories. +:keywords: repo, repositiores, usage, pull image, push image, image, documentation + .. _working_with_the_repository: Working with the repository diff --git a/docs/theme/docker/layout.html b/docs/theme/docker/layout.html index aa5a24d49..d212c9ca8 100755 --- a/docs/theme/docker/layout.html +++ b/docs/theme/docker/layout.html @@ -8,7 +8,7 @@ - Docker - {{ meta['title'] if meta and meta['title'] else title }} + {{ meta['title'] if meta and meta['title'] else title }} - Docker Documentation