summaryrefslogtreecommitdiff
path: root/docs/docsite/rst/scenario_guides
diff options
context:
space:
mode:
authorSandra McCann <samccann@redhat.com>2019-06-24 12:35:37 -0400
committerAlicia Cozine <879121+acozine@users.noreply.github.com>2019-06-24 11:35:37 -0500
commit5569135efdab18be61da42557e6c0de99b768e17 (patch)
tree9a1cc97ad8bad853106068a6236afd89bc62c81f /docs/docsite/rst/scenario_guides
parent4d357ffca59db30247ff9290b38032d78edbe5ce (diff)
downloadansible-5569135efdab18be61da42557e6c0de99b768e17.tar.gz
create scenario guide template file (#58212)
* create scenario guide template file * Apply suggestions from code review Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
Diffstat (limited to 'docs/docsite/rst/scenario_guides')
-rw-r--r--docs/docsite/rst/scenario_guides/scenario_template.rst53
-rw-r--r--docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_scenario_1.rst39
2 files changed, 53 insertions, 39 deletions
diff --git a/docs/docsite/rst/scenario_guides/scenario_template.rst b/docs/docsite/rst/scenario_guides/scenario_template.rst
new file mode 100644
index 0000000000..14695bed64
--- /dev/null
+++ b/docs/docsite/rst/scenario_guides/scenario_template.rst
@@ -0,0 +1,53 @@
+:orphan:
+
+.. _scenario_template:
+
+*************************************
+Sample scenario for Ansible platforms
+*************************************
+
+*Use this ``rst`` file as a starting point to create a scenario guide for your platform. The sections below are suggestions on what should be in a scenario guide.*
+
+Introductory paragraph.
+
+.. contents::
+ :local:
+
+Prerequisites
+=============
+
+Describe the requirements and assumptions for this scenario. This should include applicable subsections for hardware, software, and any other caveats to using the scenarios in this guide.
+
+Credentials and authenticating
+==============================
+
+Describe credential requirements and how to authenticate to this platform.
+
+Using dynamic inventory
+=========================
+
+If applicable, describe how to use a dynamic inventory plugin for this platform.
+
+
+Example description
+===================
+
+Description and code here. Change the section header to something descriptive about this example, such as "Renaming a virtual machine". The goal is that this is the text someone would search for to find your example.
+
+
+Example output
+--------------
+
+What the user should expect to see.
+
+
+Troubleshooting
+---------------
+
+What to look for if it breaks.
+
+
+Conclusion and where to go next
+===============================
+
+Recap of important points. For more information please see: links.
diff --git a/docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_scenario_1.rst b/docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_scenario_1.rst
deleted file mode 100644
index cc743fa80b..0000000000
--- a/docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_scenario_1.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-:orphan:
-
-**********************************
-Sample Scenario for Ansible VMware
-**********************************
-
-Introductory paragraph.
-
-.. contents::
- :local:
-
-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
-===============================
-
-Recap of important points. For more information please see: links.