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 374d4ecd98 Doc backportapalooza 2 (#70440 ) * doc: avoid mix of single and double quotes (#70115) Avoid mix of single and double quotes in the `ternary`, this way we can copy/past the example without any surprise. (cherry picked from commit `b491f776b9`) * document FQCN for M() and :seealso: in DOCUMENTATION blocks (#70245) * document FQCN for M() in DOCUMENTATION blocks * add note about c (cherry picked from commit `83f6e4850b`) * Fix bullet points in intro_getting_started.rst. (#70365) The layout was jumbled due to issues with whitespace. (cherry picked from commit `dc6f4b6502`) * Add steps for how to create changelog.rst for a collection (#70262) * Update docs/docsite/rst/dev_guide/developing_collections.rst * add steps to create changelogs, add sentence about not using the tool * add note for rerunning the command Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit `5a28b2b86c`) * ansible-doc: avoid problems with YAML anchors when formatting man page (#70045) * Avoid problems with YAML anchors when formatting man page. * Add changelog. (cherry picked from commit `5e4f708241`) * Minor grammatical fix (#70405) 'you' -> 'your' (cherry picked from commit `a1ac595d42`) * incorporate minimalism feedback on filters page (#70366) Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit `c89f3cda9e`) * more correct info about role main.yml (#70326) fixes #40496 (cherry picked from commit `5d3d097de3`) * Fix a small typo in cache plugin description @ `config/base.yml` PR #70420 (cherry picked from commit `626df08d9d`) * with_sequence: example using vars (#69369) Added an example for using vars in with_sequence. Fixes: #68836 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `5709173c32`) * Update pull.py (#70393) (cherry picked from commit `46ad3c1162`) * Update playbooks.rst (#70317) (cherry picked from commit `7c90a2d2a6`) * Add documentation for ipaddr filters (#70343) (cherry picked from commit `9eb904ea61`) * update platform table with links to collections (#70373) (cherry picked from commit `aa59c23aed`) * Add description of collections and become_exe keywords (#68055) * Add description of collections keyword * Update based on feedback. - Add link to become plugins. - Add note about how the collections keyword works with roles. (cherry picked from commit `5833af9e2a`) Co-authored-by: Gonéri Le Bouder <goneri@lebouder.net> Co-authored-by: Mark Sanders <ziplokk.mark.sanders@gmail.com> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Sir Mobus Gochfulshigan Dorphin Esquire XXIII <celestialtuba@gmail.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Brian Coca <bcoca@users.noreply.github.com> Co-authored-by: Michael Scherer <mscherer@users.noreply.github.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Ethan <smithe2413@gmail.com> Co-authored-by: jafiala <56597272+jafiala@users.noreply.github.com> Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Co-authored-by: Sam Doran <sdoran@redhat.com>		4 years ago
..
_extensions	docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508 )	6 years ago
_static	Docs: improve anchors vs. header bar (#67244 )	5 years ago
_themes/sphinx_rtd_theme	Explain module docs loss for devel (#68369 )	5 years ago
js/ansible	consolidated docs	8 years ago
rst	Doc backportapalooza 2 (#70440 )	4 years ago
.gitignore	Initial ansible-test sanity docs. (#26775 )	7 years ago
.nojekyll	consolidated docs	8 years ago
Makefile	Turn on linkchecker in sphinx for documentation (#69590 )	5 years ago
Makefile.sphinx	Adds the ability to override the doc build output directory from the command line. (#36604 )	7 years ago
README.md	reduce docs/docsite/README to essential info (#64287 )	5 years ago
ansible_2_5.inv	Intersphinx (#68090 )	5 years ago
ansible_2_6.inv	Intersphinx (#68090 )	5 years ago
ansible_2_7.inv	Intersphinx (#68090 )	5 years ago
ansible_2_8.inv	Intersphinx (#68090 )	5 years ago
ansible_2_9.inv	Intersphinx (#68090 )	5 years ago
jinja2.inv	Intersphinx (#68090 )	5 years ago
keyword_desc.yml	Doc backportapalooza 2 (#70440 )	4 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	Intersphinx (#68090 )	5 years ago
requirements.txt	updated requirements file for docs build (#70020 )	5 years ago
variables.dot	consolidated docs	8 years ago

README.md

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.