Adds documentation structure and stubs for new VMWare guide (#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
This commit is contained in:
scottb 2018-05-03 08:05:28 -07:00 committed by GitHub
parent 947aa52327
commit 0c0dc8d9fc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 177 additions and 0 deletions

View file

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

View file

@ -0,0 +1,8 @@
.. _vmware_faq:
******************
Ansible VMware FAQ
******************
How can I improve this ...?
===========================

View file

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

View file

@ -0,0 +1,17 @@
.. _vmware_concepts:
***************************
Ansible for VMware Concepts
***************************
Introduction...blah blah
Concept 1
=========
Explanation goes here.
Concept 2
=========
Explanation goes here.

View file

@ -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>`_

View file

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

View file

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

View file

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

View file

@ -0,0 +1,7 @@
.. _vmware_requirements:
********************
VMware Prerequisites
********************
This is what you'll need to get started...

View file

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

View file

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

View file

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