Adds documentation structure and stubs for new VMWare guide (ansible#…

…39246) * Adding initial skeleton of VMWare docs * Updated product name capitaliztion; ready for initial PR. * Add few files and updated some links Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> * Fixed duplicate anchor tag
ilicmilan · Aug 15, 2018 · 4adebbc · 4adebbc
1 parent 4865de2
commit 4adebbc
Show file tree

Hide file tree

Showing 12 changed files with 177 additions and 0 deletions.
diff --git a/docs/docsite/rst/index.rst b/docs/docsite/rst/index.rst
@@ -61,6 +61,12 @@ Ansible releases a new major release of Ansible approximately every two months.
    scenario_guides/guide_vagrant
    scenario_guides/guide_vmware
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Ansible for VMWare
+
+   vmware/index
+
 .. toctree::
    :maxdepth: 2
    :caption: Ansible for Network Automation

diff --git a/docs/docsite/rst/vmware/faq.rst b/docs/docsite/rst/vmware/faq.rst
@@ -0,0 +1,8 @@
+.. _vmware_faq:
+
+******************
+Ansible VMware FAQ
+******************
+
+How can I improve this ...?
+===========================
diff --git a/docs/docsite/rst/vmware/index.rst b/docs/docsite/rst/vmware/index.rst
@@ -0,0 +1,25 @@
+.. _vmware_ansible:
+
+******************
+Ansible for VMware
+******************
+
+Welcome to the Ansible for VMware Guide! This is a set of placeholder docs to be filled in.
+
+The purpose of this guide is to teach you everything you need to know about using Ansible with VMware.
+
+To get started, please select one of the following topics.
+
+
+.. toctree::
+   :maxdepth: 2
+
+   vmware_intro
+   vmware_concepts
+   vmware_requirements
+   vmware_getting_started
+   vmware_scenarios
+   vmware_module_reference
+   vmware_troubleshooting
+   vmware_external_doc_links
+   faq
diff --git a/docs/docsite/rst/vmware/vmware_concepts.rst b/docs/docsite/rst/vmware/vmware_concepts.rst
@@ -0,0 +1,17 @@
+.. _vmware_concepts:
+
+***************************
+Ansible for VMware Concepts
+***************************
+
+Introduction...blah blah
+
+Concept 1
+=========
+
+Explanation goes here.
+
+Concept 2
+=========
+
+Explanation goes here.
diff --git a/docs/docsite/rst/vmware/vmware_external_doc_links.rst b/docs/docsite/rst/vmware/vmware_external_doc_links.rst
@@ -0,0 +1,14 @@
+.. _vmware_external_doc_links:
+
+******************************
+List of useful links to VMware
+******************************
+
+Following is the list of various external documentation and guides which can helpful in further readings.
+
+* `PyVmomi Documentation <https://github.com/vmware/pyvmomi/tree/master/docs>`_
+* `VMware API and SDK Documentation <https://www.vmware.com/support/pubs/sdk_pubs.html>`_
+* `VCSIM test container image <https://quay.io/repository/ansible/vcenter-test-container>`_
+* `Ansible VMware community wiki page <https://github.com/ansible/community/wiki/VMware>`_
+* `VMware's official Guest Operating system customization matrix <http://partnerweb.vmware.com/programs/guestOS/guest-os-customization-matrix.pdf>`_
+* `VMware Compatibility Guide <http://partnerweb.vmware.com/comp_guide2/search.php>`_
diff --git a/docs/docsite/rst/vmware/vmware_getting_started.rst b/docs/docsite/rst/vmware/vmware_getting_started.rst
@@ -0,0 +1,7 @@
+.. _vmware_ansible_getting_started:
+
+***************************************
+Getting Started with Ansible for VMware
+***************************************
+
+This will have a basic "hello world" scenario/walkthrough that gets the user introduced to the basics.
diff --git a/docs/docsite/rst/vmware/vmware_intro.rst b/docs/docsite/rst/vmware/vmware_intro.rst
@@ -0,0 +1,12 @@
+.. _vmware_ansible_intro:
+
+**********************************
+Introduction to Ansible for VMware
+**********************************
+
+Make the case. What does it do?
+
+* Cool thing 1
+* Cool thing 2
+* Cool thing 3
+
diff --git a/docs/docsite/rst/vmware/vmware_module_reference.rst b/docs/docsite/rst/vmware/vmware_module_reference.rst
@@ -0,0 +1,7 @@
+.. _vmware_ansible_module_index:
+
+***************************
+Ansible VMware Module Guide
+***************************
+
+This will be a listing similar to the module index in our core docs.
diff --git a/docs/docsite/rst/vmware/vmware_requirements.rst b/docs/docsite/rst/vmware/vmware_requirements.rst
@@ -0,0 +1,7 @@
+.. _vmware_requirements:
+
+********************
+VMware Prerequisites
+********************
+
+This is what you'll need to get started...
diff --git a/docs/docsite/rst/vmware/vmware_scenario_1.rst b/docs/docsite/rst/vmware/vmware_scenario_1.rst
@@ -0,0 +1,38 @@
+.. _vmware_scenario_1:
+
+**********************************
+Sample Scenario for Ansible VMware
+**********************************
+
+Introductory paragraph.
+
+
+Scenario Requirements
+=====================
+
+Describe the requirements and assumptions for this scenario.
+
+
+Example Description
+===================
+
+Description and code here.
+
+
+Example Output
+--------------
+
+What the user should expect to see.
+
+
+Troubleshooting
+---------------
+
+What to look for if it breaks.
+
+
+Conclusion and Where To Go Next
+===============================
+
+Blah blah for more information please see blah blah...
+
diff --git a/docs/docsite/rst/vmware/vmware_scenarios.rst b/docs/docsite/rst/vmware/vmware_scenarios.rst
@@ -0,0 +1,19 @@
+.. _vmware_scenarios:
+
+****************************
+Ansible for VMware Scenarios
+****************************
+
+Welcome to the Ansible for VMWare Guide!
+
+The purpose of this guide is to teach you everything you need to know about using Ansible with VMWare.
+
+To get started, please select one of the following topics.
+
+
+.. toctree::
+   :maxdepth: 2
+
+   vmware_scenario_1
+
+
diff --git a/docs/docsite/rst/vmware/vmware_troubleshooting.rst b/docs/docsite/rst/vmware/vmware_troubleshooting.rst
@@ -0,0 +1,17 @@
+.. _vmware_troubleshooting:
+
+**********************************
+Troubleshooting Ansible for VMware
+**********************************
+
+This section lists things that can go wrong and possible ways to fix them.
+
+Troubleshooting Item 
+====================
+
+Description
+
+Potential Workaround
+--------------------
+
+How to fix...