86 lines
4.6 KiB
ReStructuredText
86 lines
4.6 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'm new to the community. Where can I find the Ansible :ref:`code_of_conduct`?
|
|
* I'd like to know what I'm agreeing to when I contribute to Ansible. Does Ansible have a :ref:`contributor_license_agreement`?
|
|
* I'd like to contribute but I'm 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'd 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'm waiting for a particular feature. How do I see what's :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'd 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'd 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'd like to connect Ansible to a new API or other resource. How do I :ref:`contribute a group of related modules <developing_modules_in_groups>`?
|
|
* My pull request is marked ``needs_rebase``. How do I :ref:`rebase my PR <rebase_guide>`?
|
|
* I'm using an older version of Ansible and want a bug fixed in my version that's 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'm ready to step up as a module maintainer. What are the :ref:`guidelines for maintainers <maintainers>`?
|
|
* A module 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
|