c936b8b638
* Suggest ansible ad-hoc command while developing module (#70308) If a local module has no documentation, the doc command will fail without any hints of what is wrong. Add another way to confirm the presence of a local module. * Update docs/docsite/rst/dev_guide/developing_locally.rst Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit82e5d03bdb) * Update AWS Integration test docmentation (#70454) (cherry picked from commite1ba7dc52a) * Update hacking/shippable docs. The `--all` option downloads more than is needed for analyzing code coverage. (cherry picked from commitfb7740ae3b) * Document that subversion module requires subversion (#70537) (cherry picked from commit64c2cb273f) * update documentation link to python 3 (#70509) update the docs link for strftime on the filters page to point to the python3 docs (cherry picked from commitf7db428375) * Update windows_winrm.rst (#70306) gcc also needed to be installed alongside python-devel, krb5-devel, krb5-libs, and krb5-workstation. (cherry picked from commitf4ea43c4a0) * updated requirements file for docs build (#70609) (cherry picked from commit38ccfb4a3e) * Clarify that index_var is 0 indexed (#70548) A little further down the page is another index, ansible_loop.index, which shares a similar description but is 1 indexed. Its zero indexed twin has a 0 suffix. ``ansible_loop.index`` The current iteration of the loop. (1 indexed) ``ansible_loop.index0`` The current iteration of the loop. (0 indexed) To remove ambiguity around the usage of index_var, explicitly mention that this variable is 0 indexed. (cherry picked from commitc410311f55) * docs: update module development docs (#70594) Update module development docs for flattened modules directory. Fixes: #70261 (at least partially) Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit20209c508f) * Doc: fix examples of changelog entries. (#70551) (cherry picked from commitedcd1a1a70) * Document tags are not supported with task meta. (#70590) fixes #70338 (cherry picked from commit40591d5fbb) * docs: update date format in removed_at_date (#70597) removed_at_date requires YYYY-MM-DD format. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit375c6b4ae4) * partial update of community docs to reflect collections transition (#70488) (cherry picked from commitf1f782fc37) Co-authored-by: Michael Ritsema <michaelritsema@users.noreply.github.com> Co-authored-by: Mark Chappell <mchappel@redhat.com> Co-authored-by: Matt Clay <matt@mystile.com> Co-authored-by: Alan Rominger <arominge@redhat.com> Co-authored-by: FloMiau <37121807+FloMiau@users.noreply.github.com> Co-authored-by: mahadelmi <mahadelmi@cmail.carleton.ca> Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com> Co-authored-by: Karl Goetz <goetzk@users.noreply.github.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
86 lines
4.5 KiB
ReStructuredText
86 lines
4.5 KiB
ReStructuredText
.. _how_can_i_help:
|
|
|
|
***************
|
|
How can I help?
|
|
***************
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Thanks for being interested in helping the Ansible project!
|
|
|
|
There are many ways to help the Ansible project...but first, please read and understand the :ref:`code_of_conduct`.
|
|
|
|
Become a power user
|
|
===================
|
|
|
|
A great way to help the Ansible project is to become a power user:
|
|
|
|
* Use Ansible everywhere you can
|
|
* Take tutorials and classes
|
|
* Read the :ref:`official documentation <ansible_documentation>`
|
|
* Study some of the `many excellent books <https://www.amazon.com/s/ref=nb_sb_ss_c_2_7?url=search-alias%3Dstripbooks&field-keywords=ansible&sprefix=ansible%2Caps%2C260>`_ about Ansible
|
|
* `Get certified <https://www.ansible.com/products/training-certification>`_.
|
|
|
|
When you become a power user, your ability and opportunities to help the Ansible project in other ways will multiply quickly.
|
|
|
|
Ask and answer questions online
|
|
===============================
|
|
|
|
There are many forums online where Ansible users ask and answer questions. Reach out and communicate with your fellow Ansible users.
|
|
|
|
You can find the official :ref:`Ansible communication channels <communication>`.
|
|
|
|
Review, fix, and maintain the documentation
|
|
===========================================
|
|
|
|
Typos are everywhere, even in the Ansible documentation. We work hard to keep the documentation up-to-date, but you may also find outdated examples. We offer easy ways to :ref:`report and/or fix documentation errors <community_documentation_contributions>`.
|
|
|
|
.. _ansible_community_meetup:
|
|
|
|
Participate in your local meetup
|
|
================================
|
|
|
|
There are Ansible meetups `all over the world <https://www.meetup.com/topics/ansible/>`_. Join your local meetup. Attend regularly. Ask good questions. Volunteer to give a presentation about how you use Ansible.
|
|
|
|
If there isn't a meetup near you, we'll be happy to help you `start one <https://www.ansible.com/community/events/ansible-meetups>`_.
|
|
|
|
File and verify issues
|
|
======================
|
|
|
|
All software has bugs, and Ansible is no exception. When you find a bug, you can help tremendously by :ref:`telling us about it <reporting_bugs_and_features>`.
|
|
|
|
|
|
If the bug you found already exists in an issue, you can help by verifying the behavior of the reported bug with a comment in that issue, or by reporting any additional information.
|
|
|
|
Review and submit pull requests
|
|
===============================
|
|
|
|
As you become more familiar with how Ansible works, you may be able to fix issues or develop new features yourself. If you think you have a fix for a bug in Ansible, or if you have a new feature that you would like to share with millions of Ansible users, read all about the :ref:`Ansible development process <community_development_process>` and and :ref:`how to contribute to collections <contributing_maintained_collections>` to learn how to get your code accepted into Ansible.
|
|
|
|
Another good way to help is to review pull requests that other Ansible users have submitted. The Ansible community keeps a full list of `open pull requests by file <https://ansible.sivel.net/pr/byfile.html>`_, so if there's a particular module or plug-in that particularly interests you, you can easily keep track of all the relevant new pull requests and provide testing or feedback.
|
|
|
|
Become a collection maintainer
|
|
==============================
|
|
|
|
Once you have learned about the development process and have contributed code to a collection, we encourage you to become a maintainer of that collection. There are hundreds of modules in dozens of Ansible collections, and the vast majority of them are written and maintained entirely by members of the Ansible community.
|
|
|
|
To learn more about the responsibilities of being an Ansible module maintainer, please read our :ref:`module maintainer guidelines <maintainers>`.
|
|
|
|
.. _community_working_groups:
|
|
|
|
Join a working group
|
|
====================
|
|
|
|
Working groups are a way for Ansible community members to self-organize around particular topics of interest. We have working groups around various topics. To join or create a working group, please read the :ref:`Ansible Working Groups<working_group_list>`.
|
|
|
|
|
|
Teach Ansible to others
|
|
=======================
|
|
|
|
We are working on a standardized `Ansible workshop <https://ansible.github.io/workshops/>`_ that can provide a good hands-on introduction to Ansible usage and concepts.
|
|
|
|
Social media
|
|
============
|
|
|
|
If you like Ansible and just want to spread the good word, feel free to share on your social media platform of choice, and let us know by using ``@ansible`` or ``#ansible``. We'll be looking for you.
|