Skip to content

Commit 9460e94

Browse files
authored
Merge pull request #146 from nginx/comm-overhaul
docs: overhaul community page
2 parents 89b85c6 + ec8229c commit 9460e94

File tree

1 file changed

+51
-26
lines changed

1 file changed

+51
-26
lines changed

source/community.rst

Lines changed: 51 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
Community
99
#########
1010

11+
************************
12+
Meetings and discussions
13+
************************
14+
1115
We hold semi-regular meetings on Zoom
1216
to discuss all things related to Unit
1317
with our tightly knit and vibrant community.
@@ -17,41 +21,62 @@ Recorded sessions:
1721
- `NGINX Unit Community Call No.1
1822
<https://www.youtube.com/watch?v=EZbcc6D03Io>`__
1923

24+
*************************
25+
Reporting bugs and issues
26+
*************************
27+
28+
- You can report issues and bugs on the
29+
`Issues <https://github.com/nginx/unit/issues>`_ section of the Unit repo.
30+
31+
- If you have found a fix or want to suggest a change to the code,
32+
you can open a `pull request <https://github.com/nginx/unit/pulls>`_
33+
on the Unit repo.
34+
35+
***************************
36+
Reporting security concerns
37+
***************************
38+
39+
Please report any security-related issues concerning Unit to
40+
41+
For our mutual convenience, specifically mention **NGINX Unit** in the subject and, if possible, provide a
42+
`CVSS score<https://www.first.org/cvss/>`__.
2043

2144
************
22-
Contribution
45+
Contributing
2346
************
2447

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

30-
Please report any security-related issues
31-
concerning Unit to
32-
33-
For our mutual convenience,
34-
specifically mention NGINX Unit in the subject
35-
and follow the
36-
`CVSS v3.1 <https://www.first.org/cvss/v3.1/specification-document>`__
37-
specification.
50+
If you have a feature request or want to suggest an improvement, please submit a pull request on the
51+
`unit repo <https://github.com/nginx/unit/pulls>`_.
3852

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

47-
Source code:
56+
You can also ask questions and discuss your suggestions for Unit by:
4857

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

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

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

55-
Documentation:
72+
.. list-table::
73+
:header-rows: 1
5674

57-
- GitHub repository: https://github.com/nginx/unit-docs
75+
* - Repository
76+
- Description
77+
* - `github.com/nginx/unit <https://github.com/nginx/unit>`_
78+
- The repository for the NGINX Unit project source code.
79+
* - `github.com/nginx/unit-docs <https://github.com/nginx/unit-docs>`_
80+
- The source code for the NGINX Unit documentation you are currently reading.
81+
* - `github.com/nginx/unit/tree/master/tools <https://github.com/nginx/unit/tree/master/tools>`_
82+
- Source code for the NGINX Unit command-line tools.

0 commit comments

Comments
 (0)