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 b264386f3f Backportapalooza 04 21 (#80600 ) * Fix typo in playbooks_keywords.rst.j2 (#80461) (cherry picked from commit `2ed4396558`) * Correct bypass_host_loop attribute for group_by (#80380) This action originally bypassed the host loop, but it does not currently. (cherry picked from commit `fc5c0aadc9`) * Add Ansible community 8.0.0a1 porting guide (#80498) (cherry picked from commit `362c949622`) * Adds Ansible 8 Porting Guide to Index Page (#80511) (cherry picked from commit `d081ed3616`) * documents approaches to octal modes better (#80112) (cherry picked from commit `032881e4f1`) * Update password.py documentation (#80297) * Update password.py documentation with new semantic markup (cherry picked from commit `bf4e0166a5`) * Add OpenSUSE to the distro's installation guide (#80308) * Add OpenSUSE to the distro's installation guide Similar to the rest of the distros, OpenSUSE distributes ansible and it was missing. Signed-off-by: ybonatakis <ybonatakis@suse.com> (cherry picked from commit `af6d75e313`) * Document how to run all tasks, even the ones with the never tag (#80315) Co-authored-by: Martin Krizek <martin.krizek@gmail.com> (cherry picked from commit `ec403db1c7`) * 📝 Document macOS user deletion over SSH (#80358) Co-authored-by: Matt Clay <matt@mystile.com> Co-authored-by: Don Naro <dnaro@redhat.com> (cherry picked from commit `88a380c8f0`) * Update playbooks_templating.rst (#80375) (cherry picked from commit `a6e0012b8a`) * Documentation changes for #80367 and #80270 (#80391) (cherry picked from commit `0460f78081`) * [Docs] communication.rst: Add a hint about adding Matrix shields to READMEs (#80392) (cherry picked from commit `db8f1756bc`) * installation_distros: update Fedora section (#80453) (cherry picked from commit `4e9d21ec32`) * Fix PolicyRcD.__exit__ docstring (#80528) (cherry picked from commit `64fb64643d`) * Update validate_argument_spec.py (#80547) ##### SUMMARY Fix example with file lookup, filter 'from_yaml' is required. ##### ISSUE TYPE - Docs Pull Request +label: docsite_pr (cherry picked from commit `8d685b89f2`) * redirect old vmware guide (#80553) (cherry picked from commit `c1d8130df5`) * Update tools and programs page as per community feedback (#80493) (cherry picked from commit `44794e3ebc`) * uri module, fix example (#80554) (cherry picked from commit `449c628f3d`) * apt key and repository example security patch (#80381) (cherry picked from commit `ed9cd39d0f`) * note in systemd that systemctl can change behaviour due to diff order… (#80570) (cherry picked from commit `9ca863501c`) * Vars Plugin Documentation Improvement (#80470) (cherry picked from commit `791510ccba`) * Add note guidelines for additional distributions (#80389) (cherry picked from commit `68e270d4cc`) --------- Co-authored-by: Christinanik251 <93385939+Christinanik251@users.noreply.github.com> Co-authored-by: flowerysong <paul.arthur@flowerysong.com> Co-authored-by: Anwesha Das <anwesha@das.community> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: aaronk1 <aaronk1@users.noreply.github.com> Co-authored-by: Yiannis <jbonatakis@gmail.com> Co-authored-by: Daniel-at-github <Daniel-at-github@users.noreply.github.com> Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com> Co-authored-by: dzvision <5590839+dzvision@users.noreply.github.com> Co-authored-by: WeiXinFam-Insta <86450936+WeiXinFam-Insta@users.noreply.github.com> Co-authored-by: Andrew Klychkov <aklychko@redhat.com> Co-authored-by: Maxwell G <maxwell@gtmx.me> Co-authored-by: Rodrigo Candido Gryzinski <contact@rogryza.me> Co-authored-by: 7840vz <122374011+7840vz@users.noreply.github.com> Co-authored-by: JaroslavKlech <klechh@gmail.com> Co-authored-by: Brian Coca <bcoca@users.noreply.github.com> Co-authored-by: hexagon6 <hexagon6@fet.li> Co-authored-by: Tim Way <1091435+timway@users.noreply.github.com> Co-authored-by: Sarah Lau-Kilo <slaukilo@gmail.com>		3 years ago
..
.templates	update banner' (#79971 )	3 years ago
_static/css	🔥 Drop unused `core.css` file	5 years ago
rst	Backportapalooza 04 21 (#80600 )	3 years ago
sphinx_conf	Move Collection requirements to ansible/ansible (#80234 )	3 years ago
.gitignore	fix rstcheck problem and gitignore collections dir (#70764 )	5 years ago
.nojekyll	consolidated docs	9 years ago
Makefile	Use a dedicated version helper for the docs build (#80345 )	3 years ago
Makefile.sphinx	Documentation: Lay the ground for i18n work. (#73746 )	5 years ago
README.md	Fix markdown links that were errantly formatted as rst (#75697 )	4 years ago
ansible_2_9.inv	update intersphinx links for Ansible 3	5 years ago
ansible_6.inv	Docs: Update intersphinx links for Ansible 7 (#79485 )	3 years ago
ansible_7.inv	Docs: Update intersphinx links for Ansible 7 (#79485 )	3 years ago
collection-plugins.yml	Collections docs generation (#59761 )	5 years ago
jinja2.inv	Docs: Update intersphinx links for Ansible 7 (#79485 )	3 years ago
modules.js	consolidated docs	9 years ago
python2.inv	Add a script to update the intersphinx inventory (#66646 )	6 years ago
python3.inv	Docs: Update intersphinx links for Ansible 7 (#79485 )	3 years ago
requirements.txt	Remove straight.plugin dependency (#80084 )	3 years ago
variables.dot	consolidated docs	9 years ago
version_helper.py	Use a dedicated version helper for the docs build (#80345 )	3 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.