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.
ansible/docs/docsite
Sandra McCann 30d1a93d93
update changelog fragment guidance with examples (#77040)
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
3 years ago
..
.templates Bump antsibull version from 0.40.1 to 0.41.0 and ansible sphinx theme version to fix HTML generation in return value tables (#76759) 3 years ago
_static/css
rst update changelog fragment guidance with examples (#77040) 3 years ago
sphinx_conf Create collection maintainer's guide (#76976) 3 years ago
.gitignore
.nojekyll
Makefile Remove use of distutils in docs Makefile. 3 years ago
Makefile.sphinx
README.md Fix markdown links that were errantly formatted as rst (#75697) 3 years ago
ansible_2_5.inv
ansible_2_6.inv
ansible_2_7.inv
ansible_2_8.inv
ansible_2_9.inv
ansible_2_10.inv
ansible_3.inv
ansible_4.inv add intersphinx mapping for Ansible 5 (#76470) 3 years ago
ansible_5.inv add intersphinx mapping for Ansible 5 (#76470) 3 years ago
collection-plugins.yml
jinja2.inv
known_good_reqs.txt Bump antsibull version from 0.40.1 to 0.41.0 and ansible sphinx theme version to fix HTML generation in return value tables (#76759) 3 years ago
modules.js
python2.inv
python3.inv add intersphinx mapping for Ansible 5 (#76470) 3 years ago
requirements.txt Bump antsibull version from 0.40.1 to 0.41.0 and ansible sphinx theme version to fix HTML generation in return value tables (#76759) 3 years ago
variables.dot

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.