You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Sandra McCann 24f40b44ae Backportapalooza 03 16 (#80246 ) * improve doc dependency install steps (#80120) (cherry picked from commit `352010f9c3`) * docs: automatic `always` tag in gather_facts (#80052) (cherry picked from commit `3216e071c7`) * docsite requirements path (#80134) (cherry picked from commit `1055803c3a`) * Adjust release schedule docs to four weeks (#80166) (cherry picked from commit `7ce951ff48`) * Fix spelling and grammar in subelements filter doc (#80137) (cherry picked from commit `12c1891ce6`) * Fixed typo (#80184) `uvault` should be `unvault` (cherry picked from commit `cb2180e286`) * Document debugging conditionals (#80239) ##### SUMMARY Add a section to the docs describing how to debug conditional statements - how to get Ansible to show you whether your `when:` clause evaluates to `true` or `false`. I ran into trouble with this and couldn't find anything in the docs. Thought I'd add it. ##### ISSUE TYPE - Docs Pull Request +label: docsite_pr (cherry picked from commit `507fd1bd60`) * Update connection.rst (#80194) (cherry picked from commit `0937cc4862`) --------- Co-authored-by: Don Naro <dnaro@redhat.com> Co-authored-by: Jairo Llopis <973709+yajo@users.noreply.github.com> Co-authored-by: Kristian Heljas <11139388+kristianheljas@users.noreply.github.com> Co-authored-by: Zachary Peschke <8718570+zpeschke@users.noreply.github.com> Co-authored-by: Harmdhast <pandemonium.harmdhast@gmail.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Esther Christopher <estheradamuchris@gmail.com>		2 years ago
..
.templates	Backportapalooza 02 16 (#80019 )	2 years ago
_static/css	🔥 Drop unused `core.css` file	3 years ago
rst	Backportapalooza 03 16 (#80246 )	2 years ago
sphinx_conf	Docs: Update intersphinx links for Ansible 7 (#79485 ) (#79515 )	2 years ago
.gitignore	fix rstcheck problem and gitignore collections dir (#70764 )	4 years ago
.nojekyll	consolidated docs	8 years ago
Makefile	Backportapaloosa 12 08 (#79565 )	2 years ago
Makefile.sphinx	Documentation: Lay the ground for i18n work. (#73746 )	4 years ago
README.md	Fix markdown links that were errantly formatted as rst (#75697 )	3 years ago
ansible_2_9.inv	update intersphinx links for Ansible 3	4 years ago
ansible_6.inv	Docs: Update intersphinx links for Ansible 7 (#79485 ) (#79515 )	2 years ago
ansible_7.inv	Docs: Update intersphinx links for Ansible 7 (#79485 ) (#79515 )	2 years ago
collection-plugins.yml	Collections docs generation (#59761 )	4 years ago
jinja2.inv	Docs: Update intersphinx links for Ansible 7 (#79485 ) (#79515 )	2 years ago
known_good_reqs.txt	set antsibull-docs to 1.7.3 (#79407 )	2 years ago
modules.js	consolidated docs	8 years ago
python2.inv	Add a script to update the intersphinx inventory (#66646 )	5 years ago
python3.inv	Docs: Update intersphinx links for Ansible 7 (#79485 ) (#79515 )	2 years ago
requirements.txt	Upgrade antsibull-docs to 1.6.1 (#78872 ) (#78929 )	2 years ago
variables.dot	consolidated docs	8 years ago

README.md

Ansible documentation

This project hosts the source behind the general pages of docs.ansible.com. Module-specific documentation is hosted in the various collections repositories. See Ansible Galaxy, the list of Ansible-maintained collections, and the ansible-collections organization for collections sources.

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 and/or the #ansible-docs IRC channel on irc.libera.chat

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 and various collection repositories, especially those in the ansible-collections organization. For general GitHub workflows and other information, see the GitHub Guides.