ansible/docs/docsite
Andrew Klychkov c4adf62220
Docsite: update "Migrating Ansible content to a different collection" info (#72710) (#72849)
* add a reminder about ignore-*.txt entries, fix formatting, add symlink removal note
* Update docs/docsite/rst/dev_guide/developing_collections.rst

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: David Moreau Simard <moi@dmsimard.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
(cherry picked from commit 0a7fcd135c)
2021-01-10 23:24:49 -06:00
..
_extensions docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508) 2019-06-18 10:56:33 -05:00
_static Docs: improve anchors vs. header bar (#67244) 2020-02-11 13:16:26 -05:00
_themes/sphinx_rtd_theme left a stray </div> by mistake (#73132) (#73133) 2021-01-06 11:35:34 -06:00
js/ansible
rst Docsite: update "Migrating Ansible content to a different collection" info (#72710) (#72849) 2021-01-10 23:24:49 -06:00
.gitignore Docs backportapalooza 4 (#70875) 2020-07-28 17:38:17 -05:00
.nojekyll
ansible_2_5.inv [2.10] updates intersphinx references for docs links (#71921) (#71945) 2020-09-25 13:53:44 -05:00
ansible_2_6.inv [2.10] updates intersphinx references for docs links (#71921) (#71945) 2020-09-25 13:53:44 -05:00
ansible_2_7.inv [2.10] updates intersphinx references for docs links (#71921) (#71945) 2020-09-25 13:53:44 -05:00
ansible_2_8.inv [2.10] updates intersphinx references for docs links (#71921) (#71945) 2020-09-25 13:53:44 -05:00
ansible_2_9.inv [2.10] updates intersphinx references for docs links (#71921) (#71945) 2020-09-25 13:53:44 -05:00
ansible_2_10.inv [2.10] updates intersphinx references for docs links (#71921) (#71945) 2020-09-25 13:53:44 -05:00
collection-plugins.yml Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
jinja2.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
keyword_desc.yml Doc backportapalooza 2 (#70440) 2020-07-08 16:05:41 -05:00
Makefile Add link to all module and plugin indexes (#72743) (#73099) 2021-01-07 14:10:52 -06:00
Makefile.sphinx Adds the ability to override the doc build output directory from the command line. (#36604) 2018-02-28 16:01:18 -08:00
modules.js
python2.inv Add a script to update the intersphinx inventory (#66646) 2020-01-22 17:20:02 -05:00
python3.inv [2.10] updates intersphinx references for docs links (#71921) (#71945) 2020-09-25 13:53:44 -05:00
README.md [Docs][2.10] Backportapalooza 11 (#71702) 2020-09-10 10:48:28 -05:00
requirements.txt Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
variables.dot

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.