Skip to content

Commit

Permalink
rename intro docs to config
Browse files Browse the repository at this point in the history
  • Loading branch information
Shrews committed Nov 5, 2024
1 parent 9ef249d commit ba9f6b9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/intro.rst → docs/configuration.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _intro:
.. _config:

Introduction to Ansible Runner
==============================
Configuring Ansible Runner
==========================

**Runner** is intended to be most useful as part of automation and tooling that needs to invoke Ansible and consume its results.
Most of the parameterization of the **Ansible** command line is also available on the **Runner** command line but **Runner** also
Expand Down
12 changes: 3 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ want to manage the complexities of the interface on their own (such as CI/CD pla
for running ``ansible`` and ``ansible-playbook`` tasks and gathers the output from it. It does this by presenting a common interface that doesn't
change, even as **Ansible** itself grows and evolves.

Part of what makes this tooling useful is that it can gather its inputs in a flexible way (See :ref:`intro`:). It also has a system for storing the
Part of what makes this tooling useful is that it can gather its inputs in a flexible way (See :ref:`config`). It also has a system for storing the
output (stdout) and artifacts (host-level event data, fact data, etc) of the playbook run.

There are 3 primary ways of interacting with **Runner**
Expand All @@ -30,18 +30,12 @@ Examples of this could include:
* Sending status to Ansible AWX
* Sending events to an external logging service


.. toctree::
:maxdepth: 1
:caption: Introduction

intro

.. toctree::
:maxdepth: 1
:caption: Installation and Upgrade
:caption: Installation, Upgrade & Configuration

install
configuration
porting_guides/porting_guide

.. toctree::
Expand Down

0 comments on commit ba9f6b9

Please sign in to comment.