added/modifed tittle, description and keywords

changed the title prefix to sufix + Documentation Upstream-commit: 18cb5c9314dbc9a0aa857211b124a3feb85c5274 Component: engine
2013-05-22 17:52:48 -07:00
parent 4582eb4daf
commit 7040df6614
53 changed files with 185 additions and 19 deletions
@@ -1,3 +1,7 @@
+:title: Remote API
+:description: API Documentation for Docker
+:keywords: API, Docker, rcli, REST, documentation
+
 =================
 Docker Remote API
 =================
@@ -1,6 +1,6 @@
-:title: docker documentation
+:title: API Documentation
 :description: docker documentation
-:keywords:
+:keywords: docker, ipa, documentation

 API's
 =============
@@ -1,4 +1,4 @@
-:title: docker Registry documentation
+:title: Registry Documentation
 :description: Documentation for docker Registry and Registry API
 :keywords: docker, registry, api, index

@@ -1,3 +1,7 @@
+:title: Attach Command
+:description: Attach to a running container
+:keywords: attach, container, docker, documentation
+
 ===========================================
 ``attach`` -- Attach to a running container
 ===========================================
@@ -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
 ========================================================
@@ -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
 ===========================================================
@@ -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
 =======================================================
@@ -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
 =================================================================
@@ -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
 ===========================================
@@ -1,3 +1,7 @@
+:title: Images Command
+:description: List images
+:keywords: images, docker, container, documentation
+
 =========================
 ``images`` -- List images
 =========================
@@ -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
 ==========================================================================
@@ -1,3 +1,7 @@
+:title: Info Command
+:description: Display system-wide information.
+:keywords: info, docker, information, documentation
+
 ===========================================
 ``info`` -- Display system-wide information
 ===========================================
@@ -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
 ==========================================================
@@ -1,3 +1,7 @@
+:title: Kill Command
+:description: Kill a running container
+:keywords: kill, container, docker, documentation
+
 ====================================
 ``kill`` -- Kill a running container
 ====================================
@@ -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
 ============================================================
@@ -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
 =========================================
@@ -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
 =========================================================================
@@ -1,3 +1,7 @@
+:title: Ps Command
+:description: List containers
+:keywords: ps, docker, documentation, container
+
 =========================
 ``ps`` -- List containers
 =========================
@@ -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
 =========================================================================
@@ -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
 =======================================================================
@@ -1,3 +1,7 @@
+:title: Restart Command
+:description: Restart a running container
+:keywords: restart, container, docker, documentation
+
 ==========================================
 ``restart`` -- Restart a running container
 ==========================================
@@ -1,3 +1,7 @@
+:title: Rm Command
+:description: Remove a container
+:keywords: remove, container, docker, documentation, rm
+
 ============================
 ``rm`` -- Remove a container
 ============================
@@ -1,3 +1,7 @@
+:title: Rmi Command
+:description: Remove an image
+:keywords: rmi, remove, image, docker, documentation
+
 ==========================
 ``rmi`` -- Remove an image
 ==========================
@@ -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
 ===========================================
@@ -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
 ===================================================================
@@ -1,3 +1,7 @@
+:title: Start Command
+:description: Start a stopped container
+:keywords: start, docker, container, documentation
+
 ======================================
 ``start`` -- Start a stopped container
 ======================================
@@ -1,3 +1,7 @@
+:title: Stop Command
+:description: Stop a running container
+:keywords: stop, container, docker, documentation
+
 ====================================
 ``stop`` -- Stop a running container
 ====================================
@@ -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
 =========================================
@@ -1,3 +1,7 @@
+:title: Version Command
+:description: 
+:keywords: version, docker, documentation
+
 ==================================================
 ``version`` -- Show the docker version information
 ==================================================
@@ -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
 ===================================================================
@@ -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
@@ -1,4 +1,4 @@
-:title: Building blocks
+:title: Building Blocks
 :description: An introduction to docker and standard containers?
 :keywords: containers, lxc, concepts, explanation

@@ -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
@@ -1,6 +1,6 @@
-:title: docker documentation
+:title: Concepts
 :description: -- todo: change me
-:keywords: todo: change me
+:keywords: concepts, documentation, docker, containers



@@ -1,3 +1,7 @@
+:title: Contribution Guidelines
+:description: Contribution guidelines: create issues, convetions, pull requests
+:keywords: contributing, docker, documentation, help, guideline
+
 Contributing to Docker
 ======================

@@ -1,3 +1,7 @@
+:title: FAQ
+:description: Most frequently asked questions.
+:keywords: faq, questions, documentation, docker
+
 FAQ
 ===

@@ -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
 =================================
@@ -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
 ==========

@@ -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
@@ -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
@@ -1,6 +1,6 @@
-:title: docker documentation
+:title: Documentation
 :description: -- todo: change me
-:keywords: todo: change me
+:keywords: todo, docker, documentation, installation, OS support



@@ -1,3 +1,7 @@
+:title: Kernel Requirements
+:description: Kernel supports
+:keywords: kernel requirements, kernel support, docker, installation, cgroups, namespaces
+
 .. _kernel:

 Kernel Requirements
@@ -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
 ===============
@@ -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
@@ -1,3 +1,7 @@
+:title: Upgrading
+:description: These instructions are for upgrading Docker
+:keywords: Docker, Docker documentation, upgrading docker, upgrade
+
 .. _upgrading:

 Upgrading
@@ -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:

@@ -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
 =============
@@ -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
@@ -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
 ==============
@@ -1,6 +1,6 @@
-:title: docker documentation
+:title: Documentation
 :description: -- todo: change me
-:keywords: todo: change me
+:keywords: todo, docker, documentation, basic, builder



@@ -1,3 +1,6 @@
+:title: Puppet Usage
+:description: Installating and using Puppet
+:keywords: puppet, installation, usage, docker, documentation

 .. _install_using_puppet:

@@ -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
@@ -8,7 +8,7 @@
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <meta name="google-site-verification" content="UxV66EKuPe87dgnH1sbrldrx6VsoWMrx5NjwkgUFxXI" />

-    <title>Docker - {{ meta['title'] if meta and meta['title'] else title }}</title>
+    <title>{{ meta['title'] if meta and meta['title'] else title }} - Docker Documentation</title>

    <meta name="description" content="{{ meta['description'] if meta }}" />
    <meta name="keywords" content="{{ meta['keywords'] if meta }}" />