Skip to content

Commit

Permalink
Docsite: add communication info (#372)
Browse files Browse the repository at this point in the history
* Docsite: add communication info

* chore: auto fixes from pre-commit.com hooks

* Update docs/index.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/installation.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/faq.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/contributor_guide.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update docs/contributor_guide.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* 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 <dnaro@redhat.com>
  • Loading branch information
3 people authored Sep 5, 2024
1 parent 16e69e9 commit 8e2d7f9
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 17 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
33 changes: 19 additions & 14 deletions docs/contributor_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <mailto:security@ansible.com>.

## 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 <https://forum.ansible.com/t/navigating-the-ansible-forum-tags-categories-and-concepts/39>`\_ for some practical advice on finding your way around.

Possible security bugs should be reported via email to
<mailto:security@ansible.com>.
### 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
2 changes: 2 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8e2d7f9

Please sign in to comment.