From 3d41e00e9aa2bc06f45e46a37685c56ab598ecc2 Mon Sep 17 00:00:00 2001
From: Travis Truman <travis_truman@cable.comcast.com>
Date: Tue, 7 Jun 2016 10:44:42 -0400
Subject: [PATCH] DOC - Adopting the common role documentation pattern

As discussed during the Newton design summit, we
agreed to adopt the role documentation pattern laid
out in the os_keystone role

Change-Id: Ifbf6c90481a6b40781341dce2b1992a6baebe633
---
 README.rst           | 95 ++++++++++++--------------------------------
 doc/source/index.rst | 16 +-------
 2 files changed, 27 insertions(+), 84 deletions(-)

diff --git a/README.rst b/README.rst
index 9e2fc52..9de970d 100644
--- a/README.rst
+++ b/README.rst
@@ -1,75 +1,32 @@
-OpenStack LXC container create
-##############################
-:tags: openstack, lxc, container, cloud, ansible
-:category: \*nix
+OpenStack-Ansible LXC container create
+######################################
 
-Role for creating LXC containers. This role has been setup for use in OpenStack. This role will
-create several directories on the LXC host for use in bind mounted storage within the container.
+Ansible role for creating LXC containers. This role will create several
+directories on the LXC host for use in bind mounted storage within the
+container.
 
-Example Play:
-    .. code-block:: yaml
+Default Variables
+=================
 
-        - name: Create container(s)
-          hosts: all_containers
-          gather_facts: false
-          user: root
-          roles:
-            - { role: "lxc_container_create", tags: [ "lxc-container-create" ] }
+.. literalinclude:: ../../defaults/main.yml
+   :language: yaml
+   :start-after: under the License.
+
+Required Variables
+==================
+
+None
 
 
-Example Inventory:
-    .. code-block:: json
+Example Playbook
+================
+
+.. code-block:: yaml
+
+    - name: Create container(s)
+      hosts: all_containers
+      gather_facts: false
+      user: root
+      roles:
+        - { role: "lxc_container_create" }
 
-        {
-            "all_containers": {
-                "children": [
-                    "group_of_containers"
-                ],
-                "hosts": []
-            },
-            "lxc_hosts": {
-                "children": [],
-                "hosts": [
-                    "infra1"
-                ]
-            },
-            "group_of_containers": {
-                "children": [],
-                "hosts": [
-                    "container1"
-                ]
-            },
-            "_meta": {
-                "hostvars": {
-                    "infra1": {
-                        "ansible_ssh_host": "192.168.0.1",
-                        "container_address": "192.168.0.1",
-                        "container_name": "infra1",
-                        "container_networks": {
-                            "management_address": {
-                                "bridge": "br-mgmt",
-                                "interface": "eth1",
-                                "netmask": "255.255.252.0",
-                                "type": "veth"
-                            }
-                        }
-                    },
-                    "container1": {
-                        "ansible_ssh_host": "10.0.0.1",
-                        "container_address": "10.0.0.1",
-                        "container_name": "container1",
-                        "container_networks": {
-                            "management_address": {
-                                "address": "10.0.0.1",
-                                "bridge": "br-mgmt",
-                                "interface": "eth1",
-                                "netmask": "255.255.252.0",
-                                "type": "veth"
-                            }
-                        },
-                        "physical_host": "infra1",
-                        "physical_host_group": "lxc_hosts"
-                    }
-                }
-            }
-        }
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 31d4555..38ba804 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,15 +1 @@
-Example Index for role  docs
-============================
-
-Role to create LXC containers. This role can be used to configure
-multiple networks within a container and do specific container
-tuning.
-
-
-Basic Role Example
-^^^^^^^^^^^^^^^^^^
-
-.. code-block:: yaml
-
-    - role: "lxc_container_create"
-      lxc_container_backing_store: dir
+.. include:: ../../README.rst
\ No newline at end of file