45c8c9909d
* Add note on where inventory scripts moved to' (#71638) (cherry picked from commit2f240f5dd7) * clarify that collection names use same requirements as namespaces (#71639) (cherry picked from commitbbd4ec13f1) * Fix typo in documentation (#71652) Fix typo on the page about unit testing modules, (cherry picked from commit1ad0f666d5) * Changed all_modules references to list_of_collections in the documentation (#71656) (cherry picked from commita34043c6be) * Adds FAQ and other pointers for collections (#71606) (cherry picked from commitb430f9b9aa) * Docs(lineinfile): Update link to python regex docs (#71688) There was a link still pointing at the python2 documentation. (cherry picked from commit11ba30183e) * Docsite: add reference to Style guide (#71694) (cherry picked from commit73bed95ead) Co-authored-by: Zois Pagoulatos <zpagoulatos@hotmail.com> Co-authored-by: esmersmith <62951573+esmersmith@users.noreply.github.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Valentin Krasontovitsch <v.krasontov@gmail.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
26 lines
2.1 KiB
Markdown
26 lines
2.1 KiB
Markdown
Ansible documentation
|
|
=====================
|
|
|
|
This project hosts the source behind the general pages of [docs.ansible.com](https://docs.ansible.com/). Module-specific documentation is hosted in the various collections repositories. See [Ansible Galaxy](https://galaxy.ansible.com/), the list of [Ansible-maintained collections](https://docs.ansible.com/ansible/devel/community/contributing_maintained_collections.html), and the [ansible-collections organization](https://github.com/ansible-collections) 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](https://docs.ansible.com/ansible/latest/community/documentation_contributions.html).
|
|
|
|
You can also join the [Docs Working Group](https://github.com/ansible/community/wiki/Docs) and/or the ``#ansible-docs`` channel on freenode IRC.
|
|
|
|
Ansible style guide
|
|
===================
|
|
Ansible documentation is written in ReStructuredText(RST). The [Ansible style guide](https://docs.ansible.com/ansible/latest/dev_guide/style_guide/index.html#linguistic-guidelines) 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](https://docs.ansible.com/ansible/latest/community/other_tools_and_programs.html#popular-editors) in the Ansible Community Guide.
|
|
|
|
GitHub
|
|
======
|
|
[Ansible documentation](https://github.com/ansible/ansible/tree/devel/docs/docsite) is hosted on the Ansible GitHub project and various collection repositories, especially those in the [ansible-collections organization](https://github.com/ansible-collections). For general GitHub workflows and other information, see the [GitHub Guides](https://guides.github.com/).
|