From 388760eef69f02d9ac06bdedc826b41e3b7ee71d Mon Sep 17 00:00:00 2001 From: Greg Sutcliffe Date: Tue, 31 Aug 2021 00:44:27 +0100 Subject: [PATCH] Docs: Add more Matrix documentation (#75588) * Refs #75478 - On the communicating page, add Matrix links to first 4 chat spaces, improve introduction, update working groups with Matrix and IRC locations, add a link to the community FAQ, add localised community translations, and remove Lightbulb room, the GitHub project has been archived Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> --- docs/docsite/rst/community/communication.rst | 72 +++++++++++--------- 1 file changed, 39 insertions(+), 33 deletions(-) diff --git a/docs/docsite/rst/community/communication.rst b/docs/docsite/rst/community/communication.rst index c31b699035b..d35128fb8db 100644 --- a/docs/docsite/rst/community/communication.rst +++ b/docs/docsite/rst/community/communication.rst @@ -39,11 +39,13 @@ For real-time interactions, conversations in the Ansible community happen over t Ansible community on Matrix --------------------------- -The Ansible community maintains its own Matrix homeserver at ``ansible.im``. To join the community using Matrix, you need two things: +To join the community using Matrix, you need two things: -* a Matrix account (from matrix.org or any other Matrix homeserver) +* a Matrix account (from `Matrix.org `_ or any other Matrix homeserver) * a `Matrix client `_ (we recommend `Element Webchat `_) +The Ansible community maintains its own Matrix homeserver at ``ansible.im``, however public registration is currently unavailable. + Matrix chat supports: * persistence (when you log on, you see all messages since you last logged off) @@ -54,6 +56,8 @@ Matrix chat supports: * no line limits * images +The room links in the list below will take you directly to the relevant rooms. For more information, see the community-hosted `Matrix FAQ `_. + Ansible community on IRC ------------------------ @@ -67,7 +71,7 @@ IRC chat supports: * simple text interface * bridging from Matrix -Our IRC channels may require you to register your IRC nickname. If you receive an error when you connect, see `libera.chat's Nickname Registration guide `_ for instructions. To find all ``ansible`` specific channels on the libera.chat network, use the following command in your IRC client:: +Our IRC channels may require you to register your IRC nickname. If you receive an error when you connect or when posting a message, see `libera.chat's Nickname Registration guide `_ for instructions. To find all ``ansible`` specific channels on the libera.chat network, use the following command in your IRC client:: /msg alis LIST #ansible* -min 5 @@ -76,10 +80,13 @@ as described in the `libera.chat docs `_ +The clickable links will take you directly to the relevant Matrix room in your browser; room/channel information is also given for use in other clients: + +- `General usage and support questions `_ - ``Matrix: #users:ansible.im | IRC: #ansible`` +- `Discussions on developer topics and code related to features or bugs `_ - ``Matrix: #devel:ansible.im | IRC: #ansible-devel`` +- `Discussions on community and collections related topics `_ - ``Matrix: #community:ansible.im | IRC: #ansible-community`` +- `For public community meetings `_ - ``Matrix: #meeting:ansible.im | IRC: #ansible-meeting`` + - We will generally announce these on one or more of the above mailing lists. See the `meeting schedule and agenda page `_ .. _working_group_list: @@ -88,38 +95,37 @@ Working groups Many of our community `Working Groups `_ meet in chat. If you want to get involved in a working group, join the Matrix room or IRC channel where it meets or comment on the agenda. -- `Amazon (AWS) Working Group `_ - ``#ansible-aws`` -- `Ansible Lockdown Working Group `_ | `gh/ansible/ansible-lockdown `_ - ``#ansible-lockdown``- Security playbooks/roles -- `AWX Working Group `_ - ``#ansible-awx`` -- `Azure Working Group `_ - ``#ansible-azure`` -- `Community Working Group `_ - ``#ansible-community`` - Including Meetups -- `Container Working Group `_ - ``#ansible-container`` -- `Contributor Experience Working Group `_ - ``#ansible-community`` -- `DigitalOcean Working Group `_ - ``#ansible-digitalocean`` -- `Diversity Working Group `_ - ``#ansible-diversity`` -- `Docker Working Group `_ - ``#ansible-devel`` -- `Documentation Working Group `_- ``#ansible-docs`` -- `Galaxy Working Group `_ - ``#ansible-galaxy`` -- `JBoss Working Group `_ - ``#ansible-jboss`` -- `Kubernetes Working Group `_ - ``#ansible-kubernetes`` -- `Lightbulb Training `_ - ``#ansible-lightbulb`` - Ansible training -- `Linode Working Group `_ - ``#ansible-linode`` -- `Molecule Working Group `_ | `molecule.io `_ - ``#ansible-molecule`` - testing platform for Ansible playbooks and roles -- `Network Working Group `_ - ``#ansible-network`` -- `Remote Management Working Group `_ - ``#ansible-devel`` -- `Testing Working Group `_ - ``#ansible-devel`` -- `VMware Working Group `_ - ``#ansible-vmware`` -- `Windows Working Group `_ - ``#ansible-windows`` +- `Amazon (AWS) Working Group `_ - Matrix: `#aws:ansible.im `_ | IRC: ``#ansible-aws`` +- `Ansible Lockdown Working Group `_ (`Security playbooks/roles `_) - Matrix: `#lockdown:ansible.im `_ | IRC: ``#ansible-lockdown`` +- `AWX Working Group `_ - Matrix: `#awx:ansible.im `_ | IRC: ``#ansible-awx`` +- `Azure Working Group `_ - Matrix: `#azure:ansible.im `_ | IRC: ``#ansible-azure`` +- `Community Working Group `_ (including Meetups) - Matrix: `#community:ansible.im `_ | IRC: ``#ansible-community`` +- `Container Working Group `_ - Matrix: `#container:ansible.im `_ | IRC: ``#ansible-container`` +- `Contributor Experience Working Group `_ - Matrix: `#community:ansible.im `_ | IRC: ``#ansible-community`` +- `DigitalOcean Working Group `_ - Matrix: `#digitalocean:ansible.im `_ | IRC: ``#ansible-digitalocean`` +- `Diversity Working Group `_ - Matrix: `#diversity:ansible.im `_ | IRC: ``#ansible-diversity`` +- `Docker Working Group `_ - Matrix: `#devel:ansible.im `_ | IRC: ``#ansible-devel`` +- `Documentation Working Group `_ - Matrix: `#docs:ansible.im `_ | IRC: ``#ansible-docs`` +- `Galaxy Working Group `_ - Matrix: `#galaxy:ansible.im `_ | IRC: ``#ansible-galaxy`` +- `JBoss Working Group `_ - Matrix: `#jboss:ansible.im `_ | IRC: ``#ansible-jboss`` +- `Kubernetes Working Group `_ - Matrix: `#kubernetes:ansible.im `_ | IRC: ``#ansible-kubernetes`` +- `Linode Working Group `_ - Matrix: `#linode:ansible.im `_ | IRC: ``#ansible-linode`` +- `Molecule Working Group `_ (`testing platform for Ansible playbooks and roles `_) - Matrix: `#molecule:ansible.im `_ | IRC: ``#ansible-molecule`` +- `Network Working Group `_ - Matrix: `#network:ansible.im `_ | IRC: ``#ansible-network`` +- `Remote Management Working Group `_ - Matrix: `#devel:ansible.im `_ | IRC: ``#ansible-devel`` +- `Testing Working Group `_ - Matrix: `#devel:ansible.im `_ | IRC: ``#ansible-devel`` +- `VMware Working Group `_ - Matrix: `#vmware:ansible.im `_ | IRC: ``#ansible-vmware`` +- `Windows Working Group `_ - Matrix: `#windows:ansible.im `_ | IRC: ``#ansible-windows`` Want to `form a new Working Group `_? Regional and Language-specific channels --------------------------------------- -- ``#ansible-es`` - Channel for Spanish speaking Ansible community. -- ``#ansible-eu`` - Channel for the European Ansible Community. -- ``#ansible-fr`` - Channel for French speaking Ansible community. -- ``#ansiblezh`` - Channel for Zurich/Swiss Ansible community. +- Comunidad Ansible en español - Matrix: `#espanol:ansible.im `_ | IRC: ``#ansible-es`` +- Communauté française d'Ansible - Matrix: `#francais:ansible.im `_ | IRC: ``#ansible-fr`` +- Communauté suisse d'Ansible - Matrix: `#suisse:ansible.im `_ | IRC: ``#ansible-zh`` +- European Ansible Community - Matrix: `#europe:ansible.im `_ | IRC: ``#ansible-eu`` Meetings on chat ----------------