Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docsite: add Community and Contributing guides #53

Merged
merged 8 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ Documentation can be found on [ansible-sign.readthedocs.io](https://ansible.read
including a
[rundown/tutorial](https://ansible.readthedocs.io/projects/sign/en/latest/rundown.html)
explaining how to use the CLI for basic project signing and verification.

## Community

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.
26 changes: 26 additions & 0 deletions docs/community.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _community:

=========
Community
=========

We welcome your feedback, questions and ideas. Here's how to reach the community.

Code of Conduct
===============

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!
Reach out to our community team at `[email protected] <mailto:[email protected]>`_ if you have any questions or need assistance.

Ansible Forum
=============

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!

* `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`.
* `Posts tagged with 'ansible-sign' <https://forum.ansible.com/tag/ansible-sign>`_: 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 more information on the forum navigation, see `Navigating the Ansible forum <https://forum.ansible.com/t/navigating-the-ansible-forum-tags-categories-and-concepts/39>`_ post.
9 changes: 9 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
============
Contributing
============

.. note::

Need help or want to discuss the project? See the :ref:`Community guide<community>` to join the conversation!

See out `Contributing guide <https://github.com/ansible/ansible-sign/blob/main/CONTRIBUTING.md>`_ to learn how to contribute to ``ansible-sign``!
5 changes: 5 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,18 @@ ansible-sign
This is the documentation for the **ansible-sign** utility used for signing and
verifying Ansible content.

.. note::

Need help or want to discuss the project? See the :ref:`Community guide<community>` to join the conversation!

Contents
========

.. toctree::
:maxdepth: 2

Overview <readme>
Community <community>
Contributions & Help <contributing>
License <license>
Authors <authors>
Expand Down
Loading