diff options
Diffstat (limited to 'docs/docsite/rst')
3 files changed, 54 insertions, 39 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst b/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst index 1ded61370e..cc88e6fe20 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst @@ -136,6 +136,7 @@ Review the autogenerated module documentation for each of your modules, found in If the module documentation hasn't been published live yet, please let a member of the Ansible Core Team know in the ``#ansible-devel`` IRC channel. +.. note:: Consider adding a scenario guide to cover how to use your set of modules. Use the :ref:`sample scenario guide rst file <scenario_template>` to help you get started. For network modules, see :ref:`documenting_modules_network` for further documentation requirements. New to git or GitHub ==================== 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. |