From 8e2d7f90c9857753e58b72dbc8c1252c4553a3ba Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Thu, 5 Sep 2024 11:07:14 +0200 Subject: [PATCH] Docsite: add communication info (#372) * Docsite: add communication info * chore: auto fixes from pre-commit.com hooks * Update docs/index.md Co-authored-by: Don Naro * Update docs/installation.md Co-authored-by: Don Naro * Update docs/faq.md Co-authored-by: Don Naro * Update docs/contributor_guide.md Co-authored-by: Don Naro * Update docs/contributor_guide.md Co-authored-by: Don Naro * Update README.md Co-authored-by: Don Naro * chore: auto fixes from pre-commit.com hooks * fix mkdocs.yml --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Don Naro --- README.md | 4 ++++ docs/contributor_guide.md | 33 +++++++++++++++++++-------------- docs/faq.md | 2 ++ docs/index.md | 2 ++ docs/installation.md | 2 ++ docs/user_guide.md | 2 ++ mkdocs.yml | 6 +++--- 7 files changed, 34 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 287b9f4..54df431 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ By using `tox` to create and manage the testing environments, Test outcomes shou `tox` virtual environments are created in the `.tox` directory. These are easily deleted and recreated if needed. +## Talk to us + +Need help or want to discuss the project? See our [Contributor guide](https://ansible.readthedocs.io/projects/tox-ansible/contributor_guide/#talk-to-us) join the conversation! + ## Installation Install from pypi: diff --git a/docs/contributor_guide.md b/docs/contributor_guide.md index bbcc618..8875300 100644 --- a/docs/contributor_guide.md +++ b/docs/contributor_guide.md @@ -26,25 +26,30 @@ Prerequisites: Feel free to raise issues in the repo if you feel unable to contribute a code fix. +Possible security bugs should be reported via email to . + ## Talk to us -Use Github [discussions] forum or for a live chat experience try -`#ansible-devtools` IRC channel on libera.chat or Matrix room -[#devtools:ansible.com](https://matrix.to/#/#devtools:ansible.com). +### Code of Conduct + +Please read and adhere to the [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all your interactions with the Ansible community. + +### Forum + +Join the [Ansible Forum](https://forum.ansible.com) as a single starting point and our default communication platform for questions and help, development discussions, events, and much more. [Register](https://forum.ansible.com/signup?) 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](https://forum.ansible.com/c/help/6): get help or help others. Please add appropriate tags if you start new discussions, for example `devtools`. +- [Posts tagged with 'devtools'](https://forum.ansible.com/tag/devtools): subscribe to participate in project-related conversations. +- [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn) used to announce releases and important changes. +- [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts. +- [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events. -For the full list of Ansible IRC and Mailing list, please see the [Ansible -Communication] page. Release announcements will be made to the [Ansible -Announce] list. +See `Navigating the Ansible forum `\_ for some practical advice on finding your way around. -Possible security bugs should be reported via email to -. +### Matrix -## Code of Conduct +For real-time interactions, conversations in the community happen over the Matrix protocol in the [#devtools:ansible.com](https://matrix.to/#/#devtools:ansible.com). -Please see the official [Ansible Community Code of Conduct]. +For more information, see the community-hosted [Matrix FAQ](https://hackmd.io/@ansible-community/community-matrix-faq). -[discussions]: https://github.com/ansible/tox-ansible/discussions -[ansible communication]: https://docs.ansible.com/ansible/latest/community/communication.html -[ansible announce]: https://groups.google.com/forum/#!forum/ansible-announce -[Ansible Community Code of Conduct]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html [creating your fork on github]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects diff --git a/docs/faq.md b/docs/faq.md index 3f82652..b36eea4 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,7 @@ # Frequently asked questions +> Need help or want to discuss the project? See our [Contributor guide](https://ansible.readthedocs.io/projects/tox-ansible/contributor_guide/#talk-to-us) join the conversation! + ## How does it work? `tox` will, by default, create a Python virtual environment for a given environment. `tox-ansible` adds Ansible collection specific build and test logic to tox. The collection is copied into the virtual environment created by tox, built, and installed into the virtual environment. The installation of the collection will include the collection's collection dependencies. `tox-ansible` will also install any Python dependencies from a `test-requirements.txt` (or `requirements-test.txt`) and `requirements.txt` file. The virtual environment's temporary directory is used, so the copy, build and install steps are performed with each test run ensuring the current collection code is used. diff --git a/docs/index.md b/docs/index.md index 614d902..f17a7ef 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,7 @@ # Tox Ansible Documentation +> Need help or want to discuss the project? See our [Contributor guide](https://ansible.readthedocs.io/projects/tox-ansible/contributor_guide/#talk-to-us) to join the conversation! + ## About Tox Ansible `tox-ansible` is a utility designed to simplify the testing of ansible content collections. diff --git a/docs/installation.md b/docs/installation.md index fcbba40..43ff134 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,5 +1,7 @@ # Installation +> Need help or want to discuss the project? See our [Contributor guide](https://ansible.readthedocs.io/projects/tox-ansible/contributor_guide/#talk-to-us) to join the conversation! + Getting started with tox-ansible is as simple as: ```bash diff --git a/docs/user_guide.md b/docs/user_guide.md index 9787e73..ef73ae9 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -1,5 +1,7 @@ # Usage of tox-ansible +> Need help or want to discuss the project? See our [Contributor guide](https://ansible.readthedocs.io/projects/tox-ansible/contributor_guide/#talk-to-us) to learn how to join the conversation! + From the root of your collection, create an empty `tox-ansible.ini` file and list the available environments: ```bash diff --git a/mkdocs.yml b/mkdocs.yml index cb3e061..71762f9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,9 +33,9 @@ extra: - icon: simple/matrix link: https://matrix.to/#/#devtools:ansible.com name: Matrix - - icon: fontawesome/solid/comments - link: https://github.com/ansible/tox-ansible/discussions - name: Discussions + - icon: fontawesome/brands/discourse + link: https://forum.ansible.com/c/project/7 + name: Ansible forum - icon: fontawesome/brands/github-alt link: https://github.com/ansible/tox-ansible name: GitHub