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 4 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
83 changes: 52 additions & 31 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,58 @@ Recorded sessions:
- `NGINX Unit Community Call No.1
<https://www.youtube.com/watch?v=EZbcc6D03Io>`__

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

************
Contribution
************

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>`_.

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.

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>`__.
- You can report issues and bugs on the
`Issues <https://github.com/nginx/unit-docs/issues>`_ section of the Unit repo.

Source code:
- 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-docs/pulls>`_
on the Unit repo.

- GitHub repository: https://github.com/nginx/unit
You can also ask questions and discuss your suggestions for Unit by
`subscribing <https://mailman.nginx.org/mailman3/lists/unit.nginx.org/>`_
to the [email protected] mailing list and posting your ideas there.

Command-line tools:
***************************
Reporting security concerns
***************************

- GitHub repository: https://github.com/nginx/unit/tree/master/tools
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>`__.

Documentation:
************
Contributing
************

- GitHub repository: https://github.com/nginx/unit-docs
We welcome contributions to the NGINX Unit project.
If you have a feature request or a bug fix, please submit a pull request on the
`unit repo <https://github.com/nginx/unit-docs/pulls>`_.

Please review the `Contributing Guideliens <https://github.com/nginx/unit/blob/master/CONTRIBUTING.md>`_
before submitting your pull request.

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>`_.

***********
Source Code
***********
The source code for the NGINX Unit project is available on GitHub.

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

* - 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.