diff --git a/src/antsibull/data/ansible-readme.rst b/src/antsibull/data/ansible-readme.rst index 0684e457..44473319 100644 --- a/src/antsibull/data/ansible-readme.rst +++ b/src/antsibull/data/ansible-readme.rst @@ -3,7 +3,7 @@ SPDX-License-Identifier: GPL-3.0-or-later SPDX-FileCopyrightText: Ansible Project, 2020 -|PyPI version| |Docs badge| |Chat badge| |Build Status| |Code Of Conduct| |Mailing Lists| |License| +|PyPI version| |Docs badge| |Chat badge| |Code Of Conduct| |Mailing Lists| |License| ******* Ansible @@ -14,6 +14,19 @@ deployment, cloud provisioning, ad-hoc task execution, network automation, and m orchestration. Ansible makes complex changes like zero-downtime rolling updates with load balancers easy. More information on the Ansible `website `_. +This is the ``ansible`` community package. +The ``ansible`` python package contains a set of +independent Ansible collections that are curated by the community, +and it pulls in `ansible-core `_. +The ``ansible-core`` python package contains the core runtime and CLI tools, +such as ``ansible`` and ``ansible-playbook``, +while the ``ansible`` package contains extra modules, plugins, and roles. + +``ansible`` follows `semantic versioning `_. +Each major version of ``ansible`` depends on a specific major version of +``ansible-core`` and contains specific major versions of the collections it +includes. + Design Principles ================= @@ -37,6 +50,18 @@ You can install a released version of Ansible with ``pip`` or a package manager. `Installation guide `_ for details on installing Ansible on a variety of platforms. +Reporting Issues +================ +Issues with plugins and modules in the Ansible package should be reported +on the individual collection's issue tracker. +Issues with ``ansible-core`` should be reported on +the `ansible-core issue tracker `_. + +Refer to the `Communication page +`_ for a +list of support channels if you need assistance from the community or are +unsure where to report your issue. + Get Involved ============ @@ -67,6 +92,10 @@ Branch Info * The Ansible package is a 'batteries included' package that brings in ``ansible-core`` and a curated set of collections. Ansible uses `semantic versioning `_ (for example, Ansible 5.6.0). * The Ansible package has only one stable branch, called 'latest' in the documentation. * See `Ansible release and maintenance `_ for information about active branches and their corresponding ``ansible-core`` versions. +* Refer to the + `ansible-build-data `_ + repository for the exact versions of ``ansible-core`` and collections that + are included in each ``ansible`` release. Roadmap ======= @@ -90,14 +119,13 @@ License GNU General Public License v3.0 or later -See `COPYING `_ to see the full text. +See `COPYING `_ +for the full license text. .. |PyPI version| image:: https://img.shields.io/pypi/v/ansible.svg :target: https://pypi.org/project/ansible .. |Docs badge| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg :target: https://docs.ansible.com/ansible/latest/ -.. |Build Status| image:: https://dev.azure.com/ansible/ansible/_apis/build/status/CI?branchName=devel - :target: https://dev.azure.com/ansible/ansible/_build/latest?definitionId=20&branchName=devel .. |Chat badge| image:: https://img.shields.io/badge/chat-IRC-brightgreen.svg :target: https://docs.ansible.com/ansible/latest/community/communication.html .. |Code Of Conduct| image:: https://img.shields.io/badge/code%20of%20conduct-Ansible-silver.svg