diff options
author | scottb <dharmabumstead@users.noreply.github.com> | 2018-05-03 17:05:28 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-05-03 17:05:28 +0200 |
commit | 0c0dc8d9fcb113adbff076f4326f202ed34e248e (patch) | |
tree | f022dbdb8bf99794c773b3e145fc073f46829e8d /docs | |
parent | Add new OpenStack module for managing cinder volume snapshots (#19122) (diff) | |
download | ansible-0c0dc8d9fcb113adbff076f4326f202ed34e248e.tar.xz ansible-0c0dc8d9fcb113adbff076f4326f202ed34e248e.zip |
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
Diffstat (limited to 'docs')
-rw-r--r-- | docs/docsite/rst/index.rst | 6 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/faq.rst | 8 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/index.rst | 25 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/vmware_concepts.rst | 17 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/vmware_external_doc_links.rst | 14 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/vmware_getting_started.rst | 7 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/vmware_intro.rst | 12 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/vmware_module_reference.rst | 7 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/vmware_requirements.rst | 7 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/vmware_scenario_1.rst | 38 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/vmware_scenarios.rst | 19 | ||||
-rw-r--r-- | docs/docsite/rst/vmware/vmware_troubleshooting.rst | 17 |
12 files changed, 177 insertions, 0 deletions
diff --git a/docs/docsite/rst/index.rst b/docs/docsite/rst/index.rst index 6d3a0ed727..b6a920cc19 100644 --- a/docs/docsite/rst/index.rst +++ b/docs/docsite/rst/index.rst @@ -63,6 +63,12 @@ Ansible releases a new major release of Ansible approximately every two months. .. toctree:: :maxdepth: 2 + :caption: Ansible for VMWare + + vmware/index + +.. toctree:: + :maxdepth: 2 :caption: Ansible for Network Automation network/index diff --git a/docs/docsite/rst/vmware/faq.rst b/docs/docsite/rst/vmware/faq.rst new file mode 100644 index 0000000000..3a17e8b37c --- /dev/null +++ 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 new file mode 100644 index 0000000000..6bfa290333 --- /dev/null +++ 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 new file mode 100644 index 0000000000..3eaa255242 --- /dev/null +++ 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.
\ No newline at end of file diff --git a/docs/docsite/rst/vmware/vmware_external_doc_links.rst b/docs/docsite/rst/vmware/vmware_external_doc_links.rst new file mode 100644 index 0000000000..9a854e2a77 --- /dev/null +++ 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 new file mode 100644 index 0000000000..cab29e856e --- /dev/null +++ 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 new file mode 100644 index 0000000000..e5fdce83fa --- /dev/null +++ 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 new file mode 100644 index 0000000000..24a502fe03 --- /dev/null +++ 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.
\ No newline at end of file diff --git a/docs/docsite/rst/vmware/vmware_requirements.rst b/docs/docsite/rst/vmware/vmware_requirements.rst new file mode 100644 index 0000000000..80ec6f5408 --- /dev/null +++ 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 new file mode 100644 index 0000000000..298736f984 --- /dev/null +++ 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 new file mode 100644 index 0000000000..38e6f7da09 --- /dev/null +++ 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 + +
\ No newline at end of file diff --git a/docs/docsite/rst/vmware/vmware_troubleshooting.rst b/docs/docsite/rst/vmware/vmware_troubleshooting.rst new file mode 100644 index 0000000000..f3c219f008 --- /dev/null +++ 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...
\ No newline at end of file |