8000 create scenario guide template file by samccann · Pull Request #58212 · ansible/ansible · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

create scenario guide template file #58212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking & 8000 ldquo;Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
====================
Expand Down
53 changes: 53 additions & 0 deletions docs/docsite/rst/scenario_guides/scenario_template.rst
Original file line number Diff line number Diff line change
@@ -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.

This file was deleted.

0