6c70959131
Use "name" when possible rather than "src" to make the examples of roles and collections in a single requirements files more coherenant. Fundamentally, roles and collections are completely different. But we can make the requiremets file easier to read by unifying the format as much as possible. |
||
---|---|---|
.. | ||
_extensions | ||
_static | ||
_themes/sphinx_rtd_theme | ||
js/ansible | ||
rst | ||
.gitignore | ||
.nojekyll | ||
jinja2.inv | ||
keyword_desc.yml | ||
Makefile | ||
Makefile.sphinx | ||
modules.js | ||
python2.inv | ||
python3.inv | ||
README.md | ||
requirements.txt | ||
variables.dot |
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.