From 1ba1a0550ff3fa98397cd93195cc33b8c2f6473a Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Fri, 22 May 2015 09:18:19 -0700 Subject: [PATCH] Fixes title, line wrap, and Adds install area Tibor's comment Updating with the new plugins Entering comments from Seb Signed-off-by: Mary Anthony --- docs/mkdocs.yml | 3 ++ docs/sources/experimental/experimental.md | 53 +++++++++++++++------ docs/sources/experimental/plugin_api.md | 4 +- docs/sources/experimental/plugins.md | 6 ++- docs/sources/experimental/plugins_volume.md | 4 +- 5 files changed, 51 insertions(+), 19 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index dc9bd484a5..73018a5b73 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -29,6 +29,9 @@ pages: - ['release-notes.md', 'About', 'Release notes'] # Experimental - ['experimental/experimental.md', 'About', 'Experimental Features'] +- ['experimental/plugin_api.md', '**HIDDEN**'] +- ['experimental/plugins_volume.md', '**HIDDEN**'] +- ['experimental/plugins.md', '**HIDDEN**'] - ['reference/glossary.md', 'About', 'Glossary'] - ['introduction/index.md', '**HIDDEN**'] diff --git a/docs/sources/experimental/experimental.md b/docs/sources/experimental/experimental.md index 58d14bec1b..b0d72b90b0 100644 --- a/docs/sources/experimental/experimental.md +++ b/docs/sources/experimental/experimental.md @@ -1,28 +1,51 @@ page_title: Overview of Experimental Features page_keywords: experimental, Docker, feature -# Overview +# Experimental Features in this Release -This page contains a list of features in the Docker engine which are experimental as of the current release. Experimental features are **not** ready for production. They are provided to for test and evaluation in your sandbox environments. +This page contains a list of features in the Docker engine which are +experimental as of the current release. Experimental features are **not** ready +for production. They are provided for test and evaluation in your sandbox +environments. -The information below describes each feature and the Github pull requests and issues associated with it. If necessary, links are provided to additional documentation on an issue. As an active Docker user and community member, please feel free to provide any feedback on these features you wish. +The information below describes each feature and the Github pull requests and +issues associated with it. If necessary, links are provided to additional +documentation on an issue. As an active Docker user and community member, +please feel free to provide any feedback on these features you wish. -## XXXXX +## Install Docker experimental -Short two sentence description of the feature. Why someone would use it. +1. Verify that you have `wget` installed. -### How to use XXXXX + $ which wget -No more than two paragraphs. If longer, link to a page with the documentation. + If `wget` isn't installed, install it after updating your manager: -### Known issues, limitations, and risks + $ sudo apt-get update + $ sudo apt-get install wget -* one -* two -* three +2. Get the latest Docker package. -### Related GitHub PRs and issues + $ wget -qO- https://experimental.docker.com/ | sh + + The system prompts you for your `sudo` password. Then, it downloads and + installs Docker and its dependencies. + + >**Note**: If your company is behind a filtering proxy, you may find that the + >`apt-key` + >command fails for the Docker repo during installation. To work around this, + >add the key directly using the following: + > + > $ wget -qO- https://experimental.docker.com/gpg | sudo apt-key add - + +3. Verify `docker` is installed correctly. + + $ sudo docker run hello-world + + This command downloads a test image and runs it in a container. + +## Experimental features in this Release + +* [Support for Docker plugins](plugins.md) +* [Volume plugins](plugins_volume.md) -* one -* two -* three diff --git a/docs/sources/experimental/plugin_api.md b/docs/sources/experimental/plugin_api.md index 770f606b4c..6454fc2a97 100644 --- a/docs/sources/experimental/plugin_api.md +++ b/docs/sources/experimental/plugin_api.md @@ -2,7 +2,7 @@ page_title: Plugin API documentation page_description: Documentation for writing a Docker plugin. page_keywords: docker, plugins, api, extensions -# Docker Plugin API +# Experimental: Docker Plugin API Docker plugins are out-of-process extensions which add capabilities to the Docker Engine. @@ -11,6 +11,8 @@ This page is intended for people who want to develop their own Docker plugin. If you just want to learn about or use Docker plugins, look [here](/userguide/plugins). +This is an experimental feature. For information on installing and using experimental features, see [the experimental feature overview](experimental.md). + ## What plugins are A plugin is a process running on the same docker host as the docker daemon, diff --git a/docs/sources/experimental/plugins.md b/docs/sources/experimental/plugins.md index d113e50a53..dbcb70ce67 100644 --- a/docs/sources/experimental/plugins.md +++ b/docs/sources/experimental/plugins.md @@ -1,10 +1,12 @@ page_title: Experimental feature - Plugins page_keywords: experimental, Docker, plugins -# Overview +# Experimental: Extend Docker with a plugin You can extend the capabilities of the Docker Engine by loading third-party -plugins. +plugins. + +This is an experimental feature. For information on installing and using experimental features, see [the experimental feature overview](experimental.md). ## Types of plugins diff --git a/docs/sources/experimental/plugins_volume.md b/docs/sources/experimental/plugins_volume.md index 81112e18ae..399dda71e3 100644 --- a/docs/sources/experimental/plugins_volume.md +++ b/docs/sources/experimental/plugins_volume.md @@ -1,13 +1,15 @@ page_title: Experimental feature - Volume plugins page_keywords: experimental, Docker, plugins, volume -# Overview +# Experimental: Docker volume plugins Docker volume plugins enable Docker deployments to be integrated with external storage systems, such as Amazon EBS, and enable data volumes to persist beyond the lifetime of a single Docker host. See the [plugin documentation](/experimental/plugins) for more information. +This is an experimental feature. For information on installing and using experimental features, see [the experimental feature overview](experimental.md). + # Command-line changes This experimental features introduces two changes to the `docker run` command: