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.

History

Alicia Cozine af07c35f98 Backport/2.11/docs2 (#74484 ) * Add description for COLLECTIONS_SCAN_SYS_PATH (#74351) Fixes: #74275 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `567361b124`) * lighten navigation background to make section labels easier to read for core docs (#74356) * make section labels for /ansible-core/ docs easier to read, with black text and lighter gray background (cherry picked from commit `6119fb0a9a`) * Correct splitext() description, and example (#74377) `splitext()` returns a 2-tuple of strings, and the last element of the return value includes the `.` (cherry picked from commit `c295de661c`) * Using "~" instead of "+" for concatination (#74364) Changed FAQ examples to conform with the Jinja documentation: If both values on either side of a plus/+ are numbers, they will be added whereas using "~" will convert all operands into strings and then concatenate them. Closes #73799. (cherry picked from commit `e6a5245d60`) * Docs - Split Developing collections page, add info on optional module_utils (#74105) * (cherry picked from commit `c90922ee36`) * Add weos4 network platform to documentation (#74088) * Add weos4 network platform to documentation * Fix small format issues (cherry picked from commit `7ca5dede97`) * Fix typo in Makefile (#74396) Fixed minor typo specfic -> specific (cherry picked from commit `4880fee6ca`) * Update complex_data_manipulation.rst (#72509) (cherry picked from commit `c2985c491b`) * Update VMware library installation docs (#71219) Depending upon OS/distro, please use pip/pip3. (cherry picked from commit `ddfc648d37`) * Update AWS dev guides to use collections utils and fragments (#72312) (cherry picked from commit `cf08c23b4f`) * Use is_boto3_error_code in 'standard' example (#72313) Use is_boto3_error_code in 'standard' example rather than e.response['Error']['Code'] (#72313) Co-authored-by: Sloane Hertel <shertel@redhat.com> (cherry picked from commit `63afb33d86`) * Update Kubernetes collection name in docs (#74440) (cherry picked from commit `8d499bbc83`) * Update argcomplete docs links on installation guide (#74410) Link on installation docs is outdated. Switch to currently docs at: https://kislyuk.github.io/argcomplete/ (cherry picked from commit `f97787ca74`) * fix spacing to fix header, reorg contributing page (#74421) Co-authored-by: John R Barker <john@johnrbarker.com> (cherry picked from commit `9d9b08bece`) * Update first_found documentation (#70502) * import_tasks do not work with loop, use use include_tasks instead * update documentation (cherry picked from commit `bacede7a2b`) * Product-related updates. (#74454) (cherry picked from commit `34c9ed8a28`) Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Alex Willmer <alex@moreati.org.uk> Co-authored-by: Hublerho <43293510+Hublerho@users.noreply.github.com> Co-authored-by: Ernst Oudhof <17832702+ernst-s@users.noreply.github.com> Co-authored-by: Hu Shuai <hus.fnst@cn.fujitsu.com> Co-authored-by: dhx-mike-palandra <45608336+dhx-mike-palandra@users.noreply.github.com> Co-authored-by: jakelevinez <31458570+jakelevinez@users.noreply.github.com> Co-authored-by: Mark Chappell <mchappel@redhat.com> Co-authored-by: Lidiane Taquehara <lidi.mayra@gmail.com> Co-authored-by: Alex Domoradov <alex.hha@gmail.com> Co-authored-by: Bill Nottingham <notting@redhat.com>		5 years ago
..
_extensions	More boilerplate fixes. (#70224 )	6 years ago
_static	Backport/2.11/docs2 (#74484 )	5 years ago
_themes/sphinx_rtd_theme	Backport/2.11/docs1 (#74457 )	5 years ago
js/ansible	consolidated docs	9 years ago
rst	Backport/2.11/docs2 (#74484 )	5 years ago
sphinx_conf	set version to 2.11 (#74455 )	5 years ago
.gitignore	fix rstcheck problem and gitignore collections dir (#70764 )	5 years ago
.nojekyll	consolidated docs	9 years ago
Makefile	Rebased pr73824 (#73934 )	5 years ago
Makefile.sphinx	Documentation: Lay the ground for i18n work. (#73746 )	5 years ago
README.md	Adds FAQ and other pointers for collections (#71606 )	5 years ago
ansible_2_5.inv	updates intersphinx references for docs links (#71921 )	5 years ago
ansible_2_6.inv	updates intersphinx references for docs links (#71921 )	5 years ago
ansible_2_7.inv	updates intersphinx references for docs links (#71921 )	5 years ago
ansible_2_8.inv	[backport][Docs] Docs backportapalooza1 (#74355 )	5 years ago
ansible_2_9.inv	[backport][Docs] Docs backportapalooza1 (#74355 )	5 years ago
ansible_2_10.inv	[backport][Docs] Docs backportapalooza1 (#74355 )	5 years ago
ansible_3.inv	[backport][Docs] Docs backportapalooza1 (#74355 )	5 years ago
collection-plugins.yml	Collections docs generation (#59761 )	5 years ago
jinja2.inv	Intersphinx (#68090 )	6 years ago
modules.js	consolidated docs	9 years ago
python2.inv	Add a script to update the intersphinx inventory (#66646 )	6 years ago
python3.inv	[backport][Docs] Docs backportapalooza1 (#74355 )	5 years ago
requirements.txt	[backport][Docs] Docs backportapalooza1 (#74355 )	5 years ago
variables.dot	consolidated docs	9 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.