Browse Source

Merge pull request #28262 from mstanleyjones/more_metadata_fixes

Change metadata for plugin ref docs and deprecation doc
Misty Stanley-Jones 8 years ago
parent
commit
6a0ce4924f

+ 12 - 15
docs/deprecated.md

@@ -1,16 +1,10 @@
-<!--[metadata]>
-+++
-aliases = ["/engine/misc/deprecated/"]
-title = "Deprecated Engine Features"
-description = "Deprecated Features."
-keywords = ["docker, documentation, about, technology, deprecate"]
-[menu.main]
-parent = "engine_use"
-weight=80
-+++
-<![end-metadata]-->
-
-# Deprecated Engine Features
+---
+redirect_from:
+- "/engine/misc/deprecated/"
+title: "Deprecated Engine Features"
+description: "Deprecated Features."
+keywords: "docker, documentation, about, technology, deprecate"
+---
 
 The following list of features are deprecated in Engine.
 To learn more about Docker Engine's deprecation policy,
@@ -105,8 +99,11 @@ Log tags are now generated in a standard way across different logging drivers.
 Because of which, the driver specific log tag options `syslog-tag`, `gelf-tag` and
 `fluentd-tag` have been deprecated in favor of the generic `tag` option.
 
-    docker --log-driver=syslog --log-opt tag="{{.ImageName}}/{{.Name}}/{{.ID}}"
-
+```bash
+{% raw %}
+docker --log-driver=syslog --log-opt tag="{{.ImageName}}/{{.Name}}/{{.ID}}"
+{% endraw %}
+```
 ### LXC built-in exec driver
 **Deprecated In Release: [v1.8.0](https://github.com/docker/docker/releases/tag/v1.8.0)**
 

+ 8 - 16
docs/extend/index.md

@@ -1,19 +1,11 @@
-<!--[metadata]>
-+++
-aliases = [
-"/engine/extend/"
-]
-title = "Managed plugin system"
-description = "How develop and use a plugin with the managed plugin system"
-keywords = ["API, Usage, plugins, documentation, developer"]
-advisory = "experimental"
-[menu.main]
-parent = "engine_extend"
-weight=1
-+++
-<![end-metadata]-->
-
-# Docker Engine managed plugin system
+---
+redirect_from:
+- "/engine/extend/"
+title: "Docker Engine managed plugin system"
+description: "How develop and use a plugin with the managed plugin system"
+keywords: "API, Usage, plugins, documentation, developer"
+advisory: "experimental"
+---
 
 This document describes the plugin system available today in the **experimental
 build** of Docker 1.12:

+ 7 - 13
docs/extend/legacy_plugins.md

@@ -1,16 +1,10 @@
-<!--[metadata]>
-+++
-aliases = "/engine/extend/plugins/"
-title = "Use Docker Engine plugins"
-description = "How to add additional functionality to Docker with plugins extensions"
-keywords = ["Examples, Usage, plugins, docker, documentation, user guide"]
-[menu.main]
-parent = "engine_extend"
-weight=3
-+++
-<![end-metadata]-->
-
-# Use Docker Engine plugins
+---
+redirect_from:
+- "/engine/extend/plugins/"
+title: "Use Docker Engine plugins"
+description: "How to add additional functionality to Docker with plugins extensions"
+keywords: ["Examples, Usage, plugins, docker, documentation, user guide"]
+---
 
 This document describes the Docker Engine plugins generally available in Docker
 Engine. To view information on plugins managed by Docker Engine currently in

+ 30 - 40
docs/extend/manifest.md

@@ -1,19 +1,9 @@
-<!--[metadata]>
-+++
-aliases = [
-"/engine/extend/"
-]
-title = "Plugin manifest"
-description = "How develop and use a plugin with the managed plugin system"
-keywords = ["API, Usage, plugins, documentation, developer"]
-advisory = "experimental"
-[menu.main]
-parent = "engine_extend"
-weight=1
-+++
-<![end-metadata]-->
-
-# Plugin Manifest Version 0 of Plugin V2
+---
+title: "Plugin Manifest Version 0 of Plugin V2t"
+description: "How to develop and use a plugin with the managed plugin system"
+keywords: "API, Usage, plugins, documentation, developer"
+advisory: "experimental"
+---
 
 This document outlines the format of the V0 plugin manifest. The plugin
 manifest described herein was introduced in the Docker daemon (experimental version) in the [v1.12.0
@@ -47,7 +37,7 @@ Manifest provides the base accessible fields for working with V0 plugin format
 - **`interface`** *PluginInterface*
 
    interface implemented by the plugins, struct consisting of the following fields
-      
+
     - **`types`** *string array*
 
       types indicate what interface(s) the plugin currently implements.
@@ -55,9 +45,9 @@ Manifest provides the base accessible fields for working with V0 plugin format
       currently supported:
 
       	- **docker.volumedriver/1.0**
-      
+
     - **`socket`** *string*
-      
+
       socket is the name of the socket the engine should use to communicate with the plugins.
       the socket will be created in `/run/docker/plugins`.
 
@@ -73,7 +63,7 @@ Manifest provides the base accessible fields for working with V0 plugin format
 - **`network`** *PluginNetwork*
 
    network of the plugin, struct consisting of the following fields
-      
+
     - **`type`** *string*
 
       network type.
@@ -83,11 +73,11 @@ Manifest provides the base accessible fields for working with V0 plugin format
       	- **bridge**
       	- **host**
       	- **none**
-      
+
 - **`capabilities`** *array*
 
    capabilities of the plugin (*Linux only*), see list [`here`](https://github.com/opencontainers/runc/blob/master/libcontainer/SPEC.md#security)
-    
+
 - **`mounts`** *PluginMount array*
 
    mount of the plugin, struct consisting of the following fields, see [`MOUNTS`](https://github.com/opencontainers/runtime-spec/blob/master/config.md#mounts)
@@ -95,27 +85,27 @@ Manifest provides the base accessible fields for working with V0 plugin format
     - **`name`** *string*
 
 	  name of the mount.
-      
+
     - **`description`** *string*
-	
+
       description of the mount.
-   
+
     - **`source`** *string*
 
 	  source of the mount.
-    
+
     - **`destination`** *string*
 
 	  destination of the mount.
-   
+
     - **`type`** *string*
 
       mount type.
-      
+
     - **`options`** *string array*
 
 	  options of the mount.
-      
+
 - **`devices`** *PluginDevice array*
 
     device of the plugin, (*Linux only*), struct consisting of the following fields, see [`DEVICES`](https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#devices)
@@ -123,11 +113,11 @@ Manifest provides the base accessible fields for working with V0 plugin format
     - **`name`** *string*
 
 	  name of the device.
-      
+
     - **`description`** *string*
 
       description of the device.
-      
+
     - **`path`** *string*
 
 	  path of the device.
@@ -139,15 +129,15 @@ Manifest provides the base accessible fields for working with V0 plugin format
     - **`name`** *string*
 
 	  name of the env.
-      
+
     - **`description`** *string*
-	
+
       description of the env.
-   
+
     - **`value`** *string*
 
 	  value of the env.
-    
+
 - **`args`** *PluginArgs*
 
    args of the plugin, struct consisting of the following fields
@@ -155,16 +145,16 @@ Manifest provides the base accessible fields for working with V0 plugin format
     - **`name`** *string*
 
 	  name of the env.
-      
+
     - **`description`** *string*
-	
+
       description of the env.
-   
+
     - **`value`** *string array*
 
 	  values of the args.
-    
-    
+
+
 ## Example Manifest
 
 *Example showing the 'tiborvass/no-remove' plugin manifest.*

+ 0 - 15
docs/extend/menu.md

@@ -1,15 +0,0 @@
-<!--[metadata]>
-+++
-title = "Implement plugins"
-description = "Develop plugins and use existing plugins for Docker Engine"
-keywords = ["extend, plugins, docker, documentation, developer"]
-type="menu"
-[menu.main]
-identifier = "engine_extend"
-parent="engine_use"
-weight = 0
-+++
-<![end-metadata]-->
-
-
-<!--menu page not rendered-->

+ 5 - 12
docs/extend/plugin_api.md

@@ -1,15 +1,8 @@
-<!--[metadata]>
-+++
-title = "Plugins API"
-description = "How to write Docker plugins extensions "
-keywords = ["API, Usage, plugins, documentation, developer"]
-[menu.main]
-parent = "engine_extend"
-weight=7
-+++
-<![end-metadata]-->
-
-# Docker Plugin API
+---
+title: "Docker Plugin API"
+description: "How to write Docker plugins extensions "
+keywords: ["API, Usage, plugins, documentation, developer"]
+---
 
 Docker plugins are out-of-process extensions which add capabilities to the
 Docker Engine.

+ 7 - 14
docs/extend/plugins_authorization.md

@@ -1,17 +1,10 @@
-<!--[metadata]>
-+++
-title = "Access authorization plugin"
-description = "How to create authorization plugins to manage access control to your Docker daemon."
-keywords = ["security, authorization, authentication, docker, documentation, plugin, extend"]
-aliases = ["/engine/extend/authorization/"]
-[menu.main]
-parent = "engine_extend"
-weight = 4
-+++
-<![end-metadata]-->
-
-
-# Create an authorization plugin
+---
+title: "Create an authorization plugin"
+description: "How to create authorization plugins to manage access control to your Docker daemon."
+keywords: "security, authorization, authentication, docker, documentation, plugin, extend"
+redirect_from:
+- "/engine/extend/authorization/"
+---
 
 This document describes the Docker Engine plugins generally available in Docker
 Engine. To view information on plugins managed by Docker Engine currently in

+ 5 - 12
docs/extend/plugins_network.md

@@ -1,15 +1,8 @@
-<!--[metadata]>
-+++
-title = "Docker network driver plugins"
-description = "Network driver plugins."
-keywords = ["Examples, Usage, plugins, docker, documentation, user guide"]
-[menu.main]
-parent = "engine_extend"
-weight=5
-+++
-<![end-metadata]-->
-
-# Engine network driver plugins
+---
+title: "Docker Engine network driver plugins"
+description: "Network driver plugins."
+keywords: ["Examples, Usage, plugins, docker, documentation, user guide"]
+---
 
 This document describes Docker Engine network driver plugins generally
 available in Docker Engine. To view information on plugins

+ 5 - 12
docs/extend/plugins_volume.md

@@ -1,15 +1,8 @@
-<!--[metadata]>
-+++
-title = "Volume plugins"
-description = "How to manage data with external volume plugins"
-keywords = ["Examples, Usage, volume, docker, data, volumes, plugin, api"]
-[menu.main]
-parent = "engine_extend"
-weight=6
-+++
-<![end-metadata]-->
-
-# Write a volume plugin
+---
+title: "Write a volume driver plugin"
+description: "How to manage data with external volume plugins"
+keywords: ["Examples, Usage, volume, docker, data, volumes, plugin, api"]
+---
 
 Docker Engine volume plugins enable Engine deployments to be integrated with
 external storage systems, such as Amazon EBS, and enable data volumes to persist