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 45c8c9909d
[Docs][2.10] Backportapalooza 11 (#71702)
* Add note on where inventory scripts moved to' (#71638)

(cherry picked from commit 2f240f5dd7)

* clarify that collection names use same requirements as namespaces (#71639)

(cherry picked from commit bbd4ec13f1)

* Fix typo in documentation (#71652)

Fix typo on the page about unit testing modules,

(cherry picked from commit 1ad0f666d5)

* Changed all_modules references to list_of_collections in the documentation (#71656)

(cherry picked from commit a34043c6be)

* Adds FAQ and other pointers for collections (#71606)

(cherry picked from commit b430f9b9aa)

* Docs(lineinfile): Update link to python regex docs (#71688)

There was a link still pointing at the python2 documentation.

(cherry picked from commit 11ba30183e)

* Docsite: add reference to Style guide (#71694)

(cherry picked from commit 73bed95ead)

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>
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 [backport][docs][2.10]Docsbackportapalooza 8 (#71379) 4 years ago
js/ansible consolidated docs 8 years ago
rst [Docs][2.10] Backportapalooza 11 (#71702) 4 years ago
.gitignore Docs backportapalooza 4 (#70875) 4 years ago
.nojekyll consolidated docs 8 years ago
Makefile Antsibull build format backport 71080 (#71285) 4 years ago
Makefile.sphinx Adds the ability to override the doc build output directory from the command line. (#36604) 7 years ago
README.md [Docs][2.10] Backportapalooza 11 (#71702) 4 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 Add the ansible_2_10 intersphinx reference. (#71028) (#71384) 4 years ago
ansible_2_9.inv Add the ansible_2_10 intersphinx reference. (#71028) (#71384) 4 years ago
ansible_2_10.inv Add the ansible_2_10 intersphinx reference. (#71028) (#71384) 4 years ago
collection-plugins.yml Collections docs generation backport (#70515) 4 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 Add the ansible_2_10 intersphinx reference. (#71028) (#71384) 4 years ago
requirements.txt Collections docs generation backport (#70515) 4 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 channel on freenode IRC.

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.