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.7 KiB
ReStructuredText
86 lines
4.7 KiB
ReStructuredText
.. _ansible_community_guide:
|
|
|
|
***********************
|
|
Ansible Community Guide
|
|
***********************
|
|
|
|
Welcome to the Ansible Community Guide!
|
|
|
|
The purpose of this guide is to teach you everything you need to know about being a contributing member of the Ansible community. All types of contributions are welcome and necessary to Ansible's continued success.
|
|
|
|
This page outlines the most common situations and questions that bring readers to this section. If you prefer a traditional table of contents, there's one at the bottom of the page.
|
|
|
|
|
|
Getting started
|
|
===============
|
|
|
|
* I am new to the community. Where can I find the Ansible :ref:`code_of_conduct`?
|
|
* I would like to know what I am agreeing to when I contribute to Ansible. Does Ansible have a :ref:`contributor_license_agreement`?
|
|
* I would like to contribute but I am not sure how. Are there :ref:`easy ways to contribute <how_can_i_help>`?
|
|
* I want to talk to other Ansible users. How do I find an `Ansible Meetup near me <https://www.meetup.com/topics/ansible/>`_?
|
|
* I have a question. Which :ref:`Ansible email lists and IRC channels <communication>` will help me find answers?
|
|
* I want to learn more about Ansible. What can I do?
|
|
|
|
* `Read books <https://www.ansible.com/resources/ebooks>`_.
|
|
* `Get certified <https://www.ansible.com/products/training-certification>`_.
|
|
* `Attend events <https://www.ansible.com/community/events>`_.
|
|
* `Review getting started guides <https://www.ansible.com/resources/get-started>`_.
|
|
* `Watch videos <https://www.ansible.com/resources/videos>`_ - includes Ansible Automates, AnsibleFest & webinar recordings.
|
|
|
|
* I would like updates about new Ansible versions. How are `new releases announced <https://groups.google.com/forum/#!forum/ansible-announce>`_?
|
|
* I want to use the current release. How do I know which :ref:`releases are current <release_schedule>`?
|
|
|
|
Going deeper
|
|
============
|
|
|
|
* I think Ansible is broken. How do I :ref:`report a bug <reporting_bugs>`?
|
|
* I need functionality that Ansible doesn't offer. How do I :ref:`request a feature <request_features>`?
|
|
* How do I :ref:`contribute to an Ansible-maintained collection <contributing_maintained_collections>`?
|
|
* I am waiting for a particular feature. How do I see what is :ref:`planned for future Ansible Releases <roadmaps>`?
|
|
* I have a specific Ansible interest or expertise (for example, VMware, Linode, and so on.). How do I get involved in a :ref:`working group <working_group_list>`?
|
|
* I would like to participate in conversations about features and fixes. How do I review GitHub issues and pull requests?
|
|
* I found a typo or another problem on docs.ansible.com. How can I :ref:`improve the documentation <community_documentation_contributions>`?
|
|
|
|
|
|
Working with the Ansible repo
|
|
=============================
|
|
|
|
* I want to code my first changes to Ansible. How do I :ref:`set up my Python development environment <environment_setup>`?
|
|
* I would like to get more efficient as a developer. How can I find :ref:`editors, linters, and other tools <other_tools_and_programs>` that will support my Ansible development efforts?
|
|
* I want my PR to meet Ansible's guidelines. Where can I find guidance on :ref:`coding in Ansible <developer_guide>`?
|
|
* I want to learn more about Ansible roadmaps, releases, and projects. How do I find information on :ref:`the development cycle <community_development_process>`?
|
|
* I would like to connect Ansible to a new API or other resource. How do I :ref:`create a collection <developing_modules_in_groups>`?
|
|
* My pull request is marked ``needs_rebase``. How do I :ref:`rebase my PR <rebase_guide>`?
|
|
* I am using an older version of Ansible and want a bug fixed in my version that has already been fixed on the ``devel`` branch. How do I :ref:`backport a bugfix PR <backport_process>`?
|
|
* I have an open pull request with a failing test. How do I learn about Ansible's :ref:`testing (CI) process <developing_testing>`?
|
|
* I am ready to step up as a collection maintainer. What are the :ref:`guidelines for maintainers <maintainers>`?
|
|
* A module in a collection I maintain is obsolete. How do I :ref:`deprecate a module <deprecating_modules>`?
|
|
|
|
Traditional Table of Contents
|
|
=============================
|
|
|
|
If you prefer to read the entire Community Guide, here's a list of the pages in order:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
code_of_conduct
|
|
how_can_I_help
|
|
reporting_bugs_and_features
|
|
documentation_contributions
|
|
communication
|
|
development_process
|
|
contributing_maintained_collections
|
|
contributor_license_agreement
|
|
triage_process
|
|
other_tools_and_programs
|
|
../dev_guide/style_guide/index
|
|
|
|
.. toctree::
|
|
:caption: Guidelines for specific types of contributors
|
|
:maxdepth: 1
|
|
|
|
committer_guidelines
|
|
maintainers
|
|
release_managers
|
|
github_admins
|