forked from ansible/ansible
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create separate core vs collection contributor guides (ansible#76764)
* updated core guides * ansible package docs guides * add core guide to Ansible docs * Update docs/docsite/rst/community/maintainers.rst
- Loading branch information
Showing
17 changed files
with
454 additions
and
108 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
.. _advanced_community_guide: | ||
|
||
********************************************** | ||
Advanced Contributor Guide | ||
********************************************** | ||
|
||
This guide focuses on contributors who are committers, GitHub admins, or release managers. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
committer_guidelines | ||
release_managers | ||
github_admins |
288 changes: 288 additions & 0 deletions
288
docs/docsite/rst/community/collection_development_process.rst
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
.. _community_contributions: | ||
|
||
******************************** | ||
ansible-core Contributors Guide | ||
******************************** | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
reporting_bugs_and_features | ||
documentation_contributions | ||
development_process | ||
other_tools_and_programs | ||
|
||
|
||
If you have a specific Ansible interest or expertise (for example, VMware, Linode, and so on, consider joining a :ref:`working group <working_group_list>`. | ||
|
||
Working with the Ansible repo | ||
============================= | ||
|
||
* I want to make my first code changes to a collection or to ``ansible-core``. 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 code to meet Ansible's guidelines. Where can I find guidance on :ref:`coding in Ansible <developer_guide>`? | ||
* 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>`? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
.. _colllections_contributions: | ||
|
||
************************************* | ||
Ansible Collections Contributor Guide | ||
************************************* | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
collection_development_process | ||
reporting_collections | ||
documentation_contributions | ||
maintainers | ||
contributing_maintained_collections | ||
other_tools_and_programs | ||
|
||
|
||
|
||
If you have a specific Ansible interest or expertise (for example, VMware, Linode, and so on, consider joining a :ref:`working group <working_group_list>`. | ||
|
||
Working with the Ansible collection repositories | ||
================================================= | ||
|
||
* How can I find :ref:`editors, linters, and other tools <other_tools_and_programs>` that will support my Ansible development efforts? | ||
* Where can I find guidance on :ref:`coding in Ansible <developer_guide>`? | ||
* How do I :ref:`create a collection <developing_modules_in_groups>`? | ||
* How do I :ref:`rebase my PR <rebase_guide>`? | ||
* How do I learn about Ansible's :ref:`testing (CI) process <developing_testing>`? | ||
* How do I :ref:`deprecate a module <deprecating_modules>`? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
.. _community_getting_started: | ||
|
||
**************** | ||
Getting started | ||
**************** | ||
|
||
Welcome and thank you for getting more involved with the Ansible community. Here are some ways you can get started. | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
code_of_conduct | ||
contributor_license_agreement | ||
communication | ||
how_can_I_help | ||
|
||
|
||
|
||
Other ways to get involved | ||
========================== | ||
|
||
Here are some other ways to connect with the Ansible community: | ||
|
||
* Find an `Ansible Meetup near me <https://www.meetup.com/topics/ansible/>`_ | ||
communication | ||
* Learn more about Ansible: | ||
|
||
* `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. | ||
* See where `new releases are announced <https://groups.google.com/forum/#!forum/ansible-announce>`_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
.. _reporting_bugs_in_collections: | ||
|
||
*********************************** | ||
Requesting changes to a collection | ||
*********************************** | ||
|
||
.. contents:: | ||
:local: | ||
|
||
Reporting a bug | ||
=============== | ||
|
||
Security bugs | ||
------------- | ||
|
||
Ansible practices responsible disclosure - if this is a security-related bug, email `security@ansible.com <mailto:security@ansible.com>`_ instead of filing a ticket or posting to any public groups, and you will receive a prompt response. | ||
|
||
|
||
Bugs in collections | ||
------------------- | ||
|
||
Many bugs only affect a single module or plugin. If you find a bug that affects a module or plugin hosted in a collection, file the bug in the repository of the :ref:`collection <collections>`: | ||
|
||
#. Find the collection on `Galaxy <https://galaxy.ansible.com>`_. | ||
#. Click on the Issue Tracker link for that collection. | ||
#. Follow the contributor guidelines or instructions in the collection repo. | ||
|
||
If you are not sure whether a bug is in ansible-core or in a collection, you can report the behavior on the :ref:`mailing list or community chat channel first <communication>`. | ||
|
||
Requesting a feature | ||
==================== | ||
|
||
Before you request a feature, check what is :ref:`planned for future Ansible Releases <roadmaps>`. | ||
The best way to get a feature into an Ansible collection is to :ref:`submit a pull request <community_pull_requests>`, either against ansible-core or against a collection. See also :ref:`ansible_collection_merge_requirements`. | ||
|
||
You can also submit a feature request through opening an issue in the collection repository. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters