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 a7aeb61c03 Backportapalooza 01 19 (#79771 ) * Update authentication.rst (#79623) (cherry picked from commit `e7af7532bd`) * Fix typo (#79641) (cherry picked from commit `8e7cc371be`) * correct the mistake of example repeat_original (#79659) there is a little mistake ##### ISSUE TYPE - Docs Pull Request +label: docsite_pr (cherry picked from commit `6f8c1da0c8`) * switched reference from katacoda to instruqt (#79698) (cherry picked from commit `0fc932fda0`) * contributor_path: fix typos (#79678) (cherry picked from commit `fe7d488a1b`) * Fix broken reference to FAQ (#79621) (cherry picked from commit `602824db1d`) * Docsite: add Security Automation Working Group to Communication guide (#79692) (cherry picked from commit `65efa4b97f`) * Docsite: remove dead Lockdown Working Group from Communication guide (#79693) (cherry picked from commit `55f9d7f71f`) * Fix `undef()` example to a valid Jinja template (#79701) (cherry picked from commit `e41d2874a6`) * Truthy value should be one of false or true (#79730) Otherwise ansible-lint complains: https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.truthy (cherry picked from commit `b756a08d89`) * Fix regex filter docs (#79736) * Fix notes in regex_replace doc The documentation says that this maps to 'regex.replace' when it should say 're.replace'. The distinction is important because of the third-party 'regex' module that has more features than the built-in 're' module. https://pypi.org/project/regex/ * Fix notes in re.search docs The documentation says that this maps to 'regex.search' when it should say 're.search'. The distinction is important because of the third-party 'regex' module that has more features than the built-in 're' module. https://pypi.org/project/regex/ (cherry picked from commit `cf50d8131f`) * complex_data_manipulation.rst: fix typo (#79758) (cherry picked from commit `b5b7f9bce2`) * Fix broken link for inventory script examples (#79762) These scripts were removed from community.general in https://github.com/ansible-collections/community.general/pull/2696 and moved to ansible-community/contrib-scripts per https://github.com/ansible-community/community-topics/issues/16#issuecomment-853317111 (cherry picked from commit `97993eeb10`) * communication.rst: improve (#79751) (cherry picked from commit `11a27eefa2`) * Fix broken docs links. (#79769) (cherry picked from commit `5d71ace583`) Co-authored-by: Gineesh Madapparambath <net.gini@gmail.com> Co-authored-by: Kristopher Henry Kram <kristopher@kristopherkram.com> Co-authored-by: evangelionlion <546620084@qq.com> Co-authored-by: Deric Crago <deric.crago@gmail.com> Co-authored-by: Andrew Klychkov <aklychko@redhat.com> Co-authored-by: Rune Juhl Jacobsen <rune@juhljacobsen.dk> Co-authored-by: Kristian Heljas <11139388+kristianheljas@users.noreply.github.com> Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com> Co-authored-by: antonc42 <antonc42@users.noreply.github.com> Co-authored-by: Kenyon Ralph <kenyon@kenyonralph.com> Co-authored-by: Matt Clay <matt@mystile.com>		2 years ago
..
.templates	Backportapalooza 10 27 (#79247 )	2 years ago
_static/css	🔥 Drop unused `core.css` file	3 years ago
rst	Backportapalooza 01 19 (#79771 )	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.