ansible/docs/docsite
Sloane Hertel a9eb8b0488
Add some documentation for the format of meta/runtime.yml (#71035)
* Document the format of meta/runtime.yml

* Document multiple Ansible versions

Clarify difference between deprecation and tombstone fields

* add note
2020-08-04 11:25:08 -04:00
..
_extensions More boilerplate fixes. (#70224) 2020-06-22 19:05:30 -07:00
_static Docs: improve anchors vs. header bar (#67244) 2020-02-11 13:16:26 -05:00
_themes/sphinx_rtd_theme Warning banner should only show on /devel/ docs, not on pages with 'devel' in their titles (#70849) 2020-08-03 16:56:55 -04:00
js/ansible
rst Add some documentation for the format of meta/runtime.yml (#71035) 2020-08-04 11:25:08 -04:00
.gitignore fix rstcheck problem and gitignore collections dir (#70764) 2020-07-21 15:59:56 -05:00
.nojekyll
ansible_2_5.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_6.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_7.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_8.inv Add the ansible_2_10 intersphinx reference. (#71028) 2020-08-03 12:31:36 -05:00
ansible_2_9.inv Add the ansible_2_10 intersphinx reference. (#71028) 2020-08-03 12:31:36 -05:00
ansible_2_10.inv Add the ansible_2_10 intersphinx reference. (#71028) 2020-08-03 12:31:36 -05:00
collection-plugins.yml Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
jinja2.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
keyword_desc.yml Add description of collections and become_exe keywords (#68055) 2020-06-25 18:49:57 -05:00
Makefile Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
Makefile.sphinx
modules.js
python2.inv Add a script to update the intersphinx inventory (#66646) 2020-01-22 17:20:02 -05:00
python3.inv Add the ansible_2_10 intersphinx reference. (#71028) 2020-08-03 12:31:36 -05:00
README.md reduce docs/docsite/README to essential info (#64287) 2019-11-01 15:35:40 -05:00
requirements.txt Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
variables.dot

Ansible documentation

This project hosts the source behind docs.ansible.com.

To create clear, concise, and consistent contributions to Ansible documentation, please refer to the following information.

Contributions

Contributions to the documentation are welcome.

The Ansible community produces guidance on contributions, building documentation, and submitting pull requests, which you can find in Contributing to the Ansible Documentation.

You can also join the Docs Working Group.

Ansible style guide

Ansible documentation is written in ReStructuredText(RST). The Ansible style guide provides linguistic direction and technical guidelines for working with reStructuredText, in addition to other resources.

Tools

The Ansible community uses a range of tools and programs for working with Ansible documentation. Learn more about Other Tools and Programs in the Ansible Community Guide.

GitHub

Ansible documentation is hosted on the Ansible GitHub project. For GitHub workflows and other information, see the GitHub Guides.