From 77f31756b80b343a1bff98fa783513c6321f44ff Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Thu, 29 Aug 2024 09:29:17 +0200 Subject: [PATCH] Communication: add the guide, update README --- README.md | 14 ++++++-------- docs/communication.rst | 31 +++++++++++++++++++++++++++++++ docs/index.rst | 5 +++++ 3 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 docs/communication.rst diff --git a/README.md b/README.md index 9cfbd38a..d969d09c 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,12 @@ https://ansible-builder.readthedocs.io/en/stable/ ## Get Involved: +* We welcome your feedback, questions and ideas. + See our [Communication guide](https://ansible.readthedocs.io/projects/builder/en/latest/installation/) + to learn how to join the conversation. * We use [GitHub issues](https://github.com/ansible/ansible-builder/issues) to - track bug reports and feature ideas -* Want to contribute, check out our [guide](CONTRIBUTING.md) -* Join us in the `#ansible-builder` channel on Libera.chat IRC -* For the full list of Ansible email Lists, IRC channels and working groups, - check out the [Ansible Mailing - lists](https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information) - page of the official Ansible documentation. + track bug reports and feature ideas. +* Want to contribute, check out our [guide](CONTRIBUTING.md). ## Code of Conduct @@ -29,7 +27,7 @@ We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions, or need assistance, please reach out to our community team -at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com) +at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com). ## License diff --git a/docs/communication.rst b/docs/communication.rst new file mode 100644 index 00000000..11e2d022 --- /dev/null +++ b/docs/communication.rst @@ -0,0 +1,31 @@ +.. _communication: + +************* +Communication +************* + +We welcome your feedback, questions and ideas. Here's how to reach the community. + +Code of Conduct +=============== + +All communication and interactions in the Ansible Builder community are governed by the `Ansible code of conduct `_. Please read and abide by it! +Reach out to our community team at `codeofconduct@ansible.com `_ if you have any questions or need assistance. + +Forum +===== + +Join the `Ansible Forum `_ as a single starting point and our default communication platform for questions and help, development discussions, events, and much more. `Register `_ to join the community. Search by categories and tags to find interesting topics or start a new one; subscribe only to topics you need! + +* `Get Help `_: get help or help others. Please add appropriate tags if you start new discussions, for example `ansible-builder`, `ee`, and `documentation`. +* `Posts tagged with 'ansible-builder' `_: subscribe to participate in project-related conversations. +* `Bullhorn newsletter `_: used to announce releases and important changes. +* `Social Spaces `_: gather and interact with fellow enthusiasts. +* `News & Announcements `_: track project-wide announcements including social events. + +For more information on the forum navigation, see `Navigating the Ansible forum `_ post. + +Libera.Chat IRC +=============== + +Real-time conversations happen in the ``#ansible-builder`` Libera.Chat IRC channel. diff --git a/docs/index.rst b/docs/index.rst index ea282e20..af1d6b06 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,6 +14,10 @@ These containers are known as execution environments. You can use them on AWX or You can design and distribute specialized execution environments for your Ansible content, choosing the versions of Python and ansible-core you want, and installing only the Python packages, system packages, and Ansible collections you need for your tasks. +.. note:: + + Need help or want to discuss Ansible Builder including the documentation? See the :ref:`Communication guide` to learn how to join the conversation! + .. contents:: :local: @@ -105,6 +109,7 @@ Collection maintainers can learn to correctly declare dependencies for their col :caption: Contents: self + communication installation definition usage