ansible/docs/docsite
Sandra McCann 222d35ebbd
[backport][2.10] Docsbackportapaloosa (#70302)
* Fix broken link in AWS Guide (#70153)

Point to collection rather than ansible/ansible for example.

(cherry picked from commit 0ef75f65d9)

* remove gendered example (#70117)

Changed example to not assume things about names and genders

(cherry picked from commit 5885ed4455)

* docs: Add note about ansible-doc (#70162)

ansible-doc can only parse Python modules, added a note about
this is developer guide; Fixes: #69109

(cherry picked from commit da868d9d60)

* Update config.yml (#70154)

typos & branding
* Update .github/ISSUE_TEMPLATE/config.yml

Co-authored-by: Rick Elrod <rick@elrod.me>
(cherry picked from commit 4b358c6641)

* async_status: Update documentation (#70196)

Fixes: #38164

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 40a42de081)

* updates to ansible-maintained collections guidelines (#70178)

(cherry picked from commit 647c6cd289)

Co-authored-by: Jill R <4121322+jillr@users.noreply.github.com>
Co-authored-by: Westley Argentum Hennigh-Palermo <WestleyArgentum@gmail.com>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: John R Barker <john@johnrbarker.com>
2020-06-25 10:17:49 -05: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 Explain module docs loss for devel (#68369) 2020-03-25 13:55:05 -05:00
js/ansible
rst [backport][2.10] Docsbackportapaloosa (#70302) 2020-06-25 10:17:49 -05:00
.gitignore
.nojekyll
ansible_2_5.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_6.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_7.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_8.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_9.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
jinja2.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
keyword_desc.yml note that environment is not good for secrets (#69618) 2020-05-28 15:24:32 -05:00
Makefile Turn on linkchecker in sphinx for documentation (#69590) 2020-05-29 11:48:53 -05: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 Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
README.md reduce docs/docsite/README to essential info (#64287) 2019-11-01 15:35:40 -05:00
requirements.txt updated requirements file for docs build (#70020) 2020-06-11 14:47:17 -04:00
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.