Skip to content

Commit 6ac1f09

Browse files
Andersson007oraNod
andauthored
Docsite: add Community and Contributing guides (#53)
* Docsite: add Community and Contributing guides * Update README.md Co-authored-by: Don Naro <[email protected]> * Update docs/contributing.rst Co-authored-by: Don Naro <[email protected]> * Update docs/index.rst Co-authored-by: Don Naro <[email protected]> * fix * Update docs/contributing.rst Co-authored-by: Don Naro <[email protected]> * Update docs/community.rst Co-authored-by: Don Naro <[email protected]> * Update docs/index.rst Co-authored-by: Don Naro <[email protected]> --------- Co-authored-by: Don Naro <[email protected]>
1 parent f54f775 commit 6ac1f09

File tree

4 files changed

+44
-0
lines changed

4 files changed

+44
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,7 @@ Documentation can be found on [ansible-sign.readthedocs.io](https://ansible.read
1717
including a
1818
[rundown/tutorial](https://ansible.readthedocs.io/projects/sign/en/latest/rundown.html)
1919
explaining how to use the CLI for basic project signing and verification.
20+
21+
## Community
22+
23+
Need help or want to discuss the project? See our [Community guide](https://ansible.readthedocs.io/projects/sign/en/latest/community.html) join the conversation.

docs/community.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _community:
2+
3+
=========
4+
Community
5+
=========
6+
7+
We welcome your feedback, questions and ideas. Here's how to reach the community.
8+
9+
Code of Conduct
10+
===============
11+
12+
All communication and interactions in the Ansible community are governed by the `Ansible code of conduct <https://docs.ansible.com/ansible/devel/community/code_of_conduct.html>`_. Please read and abide by it!
13+
Reach out to our community team at `[email protected] <mailto:[email protected]>`_ if you have any questions or need assistance.
14+
15+
Ansible Forum
16+
=============
17+
18+
Join the `Ansible Forum <https://forum.ansible.com>`_, the 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!
19+
20+
* `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 `ansible-sign`.
21+
* `Posts tagged with 'ansible-sign' <https://forum.ansible.com/tag/ansible-sign>`_: subscribe to participate in project-related conversations.
22+
* `Bullhorn newsletter <https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn>`_: used to announce releases and important changes.
23+
* `Social Spaces <https://forum.ansible.com/c/chat/4>`_: gather and interact with fellow enthusiasts.
24+
* `News & Announcements <https://forum.ansible.com/c/news/5>`_: track project-wide announcements including social events.
25+
26+
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.

docs/contributing.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
============
2+
Contributing
3+
============
4+
5+
.. note::
6+
7+
Need help or want to discuss the project? See the :ref:`Community guide<community>` to join the conversation!
8+
9+
See out `Contributing guide <https://github.com/ansible/ansible-sign/blob/main/CONTRIBUTING.md>`_ to learn how to contribute to ``ansible-sign``!

docs/index.rst

+5
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,18 @@ ansible-sign
55
This is the documentation for the **ansible-sign** utility used for signing and
66
verifying Ansible content.
77

8+
.. note::
9+
10+
Need help or want to discuss the project? See the :ref:`Community guide<community>` to join the conversation!
11+
812
Contents
913
========
1014

1115
.. toctree::
1216
:maxdepth: 2
1317

1418
Overview <readme>
19+
Community <community>
1520
Contributions & Help <contributing>
1621
License <license>
1722
Authors <authors>

0 commit comments

Comments
 (0)