Skip to content

docs: overhaul community page #146

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

Merged
merged 9 commits into from
May 23, 2024
Merged
Changes from all 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
77 changes: 51 additions & 26 deletions source/community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
Community
#########

************************
Meetings and discussions
************************

We hold semi-regular meetings on Zoom
to discuss all things related to Unit
with our tightly knit and vibrant community.
Expand All @@ -17,41 +21,62 @@ Recorded sessions:
- `NGINX Unit Community Call No.1
<https://www.youtube.com/watch?v=EZbcc6D03Io>`__

*************************
Reporting bugs and issues
*************************

- You can report issues and bugs on the
`Issues <https://github.com/nginx/unit/issues>`_ section of the Unit repo.

- If you have found a fix or want to suggest a change to the code,
you can open a `pull request <https://github.com/nginx/unit/pulls>`_
on the Unit repo.

***************************
Reporting security concerns
***************************

Please report any security-related issues concerning Unit to
`[email protected] <[email protected]>`__.
For our mutual convenience, specifically mention **NGINX Unit** in the subject and, if possible, provide a
`CVSS score<https://www.first.org/cvss/>`__.

************
Contribution
Contributing
************

NGINX Unit is released under the
`Apache 2.0 license <https://github.com/nginx/unit/blob/master/LICENSE>`_;
we maintain GitHub
`repos <https://github.com/nginx>`_.
We welcome contributions to the NGINX Unit project.

Please report any security-related issues
concerning Unit to
`[email protected] <[email protected]>`__.
For our mutual convenience,
specifically mention NGINX Unit in the subject
and follow the
`CVSS v3.1 <https://www.first.org/cvss/v3.1/specification-document>`__
specification.
If you have a feature request or want to suggest an improvement, please submit a pull request on the
`unit repo <https://github.com/nginx/unit/pulls>`_.

To suggest changes in code or documentation and ask questions,
`subscribe <https://mailman.nginx.org/mailman3/lists/unit.nginx.org/>`_
to the [email protected] mailing list
and post your ideas there.
Also, you can open a pull request on GitHub
or join our
`Slack community <https://community.nginx.org/joinslack>`__.
Please review the `Contributing Guidelines <https://github.com/nginx/unit/blob/master/CONTRIBUTING.md>`_
before submitting your pull request.

Source code:
You can also ask questions and discuss your suggestions for Unit by:

- GitHub repository: https://github.com/nginx/unit
- Visiting the `Discussions section <https://github.com/nginx/unit/discussions>`_
of the Unit repo.
- Subscribing to the `[email protected] mailing list <https://mailman.nginx.org/mailman3/lists/unit.nginx.org/>`_
and posting your ideas there.

Command-line tools:
If you are interested in contributing to the **Unit documentation**,
or find a typo or an error in the docs, you can submit a pull request on the
`unit-docs repo <https://github.com/nginx/unit-docs/pulls>`_.

- GitHub repository: https://github.com/nginx/unit/tree/master/tools
***********
Source Code
***********
The source code for the NGINX Unit project is available on GitHub.

Documentation:
.. list-table::
:header-rows: 1

- GitHub repository: https://github.com/nginx/unit-docs
* - Repository
- Description
* - `github.com/nginx/unit <https://github.com/nginx/unit>`_
- The repository for the NGINX Unit project source code.
* - `github.com/nginx/unit-docs <https://github.com/nginx/unit-docs>`_
- The source code for the NGINX Unit documentation you are currently reading.
* - `github.com/nginx/unit/tree/master/tools <https://github.com/nginx/unit/tree/master/tools>`_
- Source code for the NGINX Unit command-line tools.