Skip to content

Commit 6df5bbd

Browse files
committed
Updated contributing procedure with GitHub workflow.
1 parent e8b5819 commit 6df5bbd

13 files changed

+426
-238
lines changed

xml/en/community.xml

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
<!--
2-
Copyright (C) Igor Sysoev
32
Copyright (C) Nginx, Inc.
43
-->
54

@@ -8,7 +7,7 @@
87
<article name="nginx: community"
98
link="/en/community.html"
109
lang="en"
11-
rev="2">
10+
rev="3">
1211

1312
<section name="Community and Governance">
1413

@@ -19,16 +18,15 @@ As the internet has grown, so have we, from our initial web server to the
1918
myriad of projects involving JavaScript, Kubernetes, API gateways,
2019
OpenTelemetry, and WebAssembly.
2120
NGINX is committed to open source both in ethos and practicality, aiming to
22-
deliver reliable and cutting-edge technology within a healthy open source
23-
culture.
21+
deliver reliable and cutting-edge technology
22+
within a healthy open source culture.
2423
Whether NGINX is part of your open source past or a step in your present,
2524
we welcome you into the future together.
2625
</para>
2726

2827
<para>
2928
To learn more about our commitment, please visit
30-
our <link url="/en/docs/governance.html">Governance</link>
31-
page.
29+
our <link doc="docs/governance.xml">Governance</link> page.
3230
</para>
3331

3432
</section>
@@ -37,8 +35,8 @@ page.
3735
<section name="Committed to Our Mission">
3836

3937
<para>
40-
We believe that healthy communities are core to innovation and open source
41-
sustainability.
38+
We believe that healthy communities are core to innovation
39+
and open source sustainability.
4240
It is our mission to enable the NGINX community to engage with
4341
and develop solutions based on open and available NGINX technologies.
4442
Together we can power the future.
@@ -58,14 +56,15 @@ Thanks for joining us.
5856
<para>
5957
Per our values, NGINX strives to create an inclusive community for all.
6058
Please remember our
61-
<link url="https://github.com/nginxinc/.github/blob/main/CODE_OF_CONDUCT.md">
62-
Code of Conduct</link> (CoC) when participating in the NGINX community.
59+
<link url="https://github.com/nginx/nginx/blob/master/CODE_OF_CONDUCT.md">
60+
Code of Conduct</link>
61+
(CoC) when participating in the NGINX community.
6362
</para>
6463

6564
<para>
66-
If you wish to tell us about a CoC violation, please email us here:
67-
68-
</link>
65+
If you wish to tell us about a CoC violation,
66+
please email us here:
67+
<link url="mailto://[email protected]">[email protected]</link>
6968
</para>
7069

7170
</section>
@@ -78,6 +77,10 @@ Find the NGINX community here:
7877

7978
<list type="bullet">
8079

80+
<listitem>
81+
<link url="https://github.com/nginx/nginx/discussions">GitHub Discussions</link>
82+
</listitem>
83+
8184
<listitem>
8285
<link url="https://community.nginx.org/joinslack">Slack</link>
8386
</listitem>
@@ -164,12 +167,12 @@ archive</link>
164167
</listitem>
165168

166169
<listitem>
167-
<link url="http://trac.nginx.org/nginx/browser">
170+
<link url="https://github.com/nginx/nginx">
168171
Browse a Source Code</link>
169172
</listitem>
170173

171174
<listitem>
172-
<link url="http://trac.nginx.org/nginx/report">
175+
<link url="https://github.com/nginx/nginx/issues">
173176
Report a Bug</link>
174177
</listitem>
175178

@@ -187,9 +190,9 @@ Participate</link>
187190
<section name="Commercial Support">
188191

189192
<para>
190-
We offer
193+
F5, Inc. offers
191194
<link url="https://www.f5.com/support">commercial support</link>
192-
for nginx and our commercial products.
195+
for nginx and its commercial products.
193196
</para>
194197

195198
</section>

xml/en/docs/contributing_changes.xml

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
<section id="getting_sources" name="Getting Sources">
1515

1616
<para>
17-
<link url="https://www.mercurial-scm.org">Mercurial</link> is used
17+
<link url="https://github.com">GitHub</link> is used
1818
to store source code.
19-
The <link url="http://hg.nginx.org/nginx">repository</link> can be cloned
19+
The <link url="https://github.com/nginx/nginx">repository</link> can be cloned
2020
with the following command:
2121
<programlisting>
22-
hg clone http://hg.nginx.org/nginx
22+
git clone https://github.com/nginx/nginx.git
2323
</programlisting>
2424
</para>
2525

@@ -39,34 +39,34 @@ code.
3939
</para>
4040

4141
<para>
42-
Commit the changes to create a Mercurial
43-
<link url="https://www.mercurial-scm.org/wiki/ChangeSet">changeset</link>.
42+
<link url="https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits">Commit</link>
43+
the changes in your nginx GitHub fork.
4444
Please ensure that the specified
45-
<link url="https://www.mercurial-scm.org/wiki/QuickStart#Setting_a_username">e-mail</link>
46-
address and real name of the change’s author are correct.
45+
<link url="https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git">e-mail</link>
46+
address and real name of the author are correct.
4747
</para>
4848

4949
<para>
5050
The commit message should have a single-line synopsis followed by verbose
5151
description after an empty line.
52-
It is desirable that the first line is no longer than 67 symbols.
53-
The resulting changeset as a patch can be obtained using the
54-
<literal>hg export</literal> command:
52+
It is desirable that the first line is no longer than 67 symbols,
53+
and the remaining lines are no longer than 76 symbols.
54+
The resulting commit can be obtained using the
55+
<literal>git show</literal> command:
5556
<programlisting>
56-
# HG changeset patch
57-
# User Filipe Da Silva &lt;[email protected]>
58-
# Date 1368089668 -7200
59-
# Thu May 09 10:54:28 2013 +0200
60-
# Node ID 2220de0521ca2c0b664a8ea1e201ce1cb90fd7a2
61-
# Parent 822b82191940ef309cd1e6502f94d50d811252a1
62-
Mail: removed surplus ngx_close_connection() call.
57+
commit 8597218f386351d6c6cdced24af6716e19a18fc3
58+
Author: Filipe Da Silva &lt;[email protected]&gt;
59+
Date: Thu May 9 10:54:28 2013 +0200
6360

64-
It is already called for a peer connection a few lines above.
61+
Mail: removed surplus ngx_close_connection() call.
6562

66-
diff -r 822b82191940 -r 2220de0521ca src/mail/ngx_mail_auth_http_module.c
67-
--- a/src/mail/ngx_mail_auth_http_module.c Wed May 15 15:04:49 2013 +0400
68-
+++ b/src/mail/ngx_mail_auth_http_module.c Thu May 09 10:54:28 2013 +0200
69-
@@ -699,7 +699,6 @@ ngx_mail_auth_http_process_headers(ngx_m
63+
It is already called for a peer connection a few lines above.
64+
65+
diff --git a/src/mail/ngx_mail_auth_http_module.c b/src/mail/ngx_mail_auth_http_module.c
66+
index 2e9b9f24d..8094bbc5c 100644
67+
--- a/src/mail/ngx_mail_auth_http_module.c
68+
+++ b/src/mail/ngx_mail_auth_http_module.c
69+
@@ -699,7 +699,6 @@ ngx_mail_auth_http_process_headers(ngx_mail_session_t *s,
7070

7171
p = ngx_pnalloc(s->connection->pool, ctx->err.len);
7272
if (p == NULL) {
@@ -100,10 +100,10 @@ case, if possible.
100100
<listitem>
101101
Passing your changes through the test suite is a good way to ensure
102102
that they do not cause a regression.
103-
The <link url="http://hg.nginx.org/nginx-tests">repository</link> with
103+
The <link url="https://github.com/nginx/nginx-tests">repository</link> with
104104
tests can be cloned with the following command:
105105
<programlisting>
106-
hg clone http://hg.nginx.org/nginx-tests
106+
git clone https://github.com/nginx/nginx-tests.git
107107
</programlisting>
108108
</listitem>
109109

@@ -116,13 +116,10 @@ hg clone http://hg.nginx.org/nginx-tests
116116
<section id="submitting_changes" name="Submitting Changes">
117117

118118
<para>
119-
The proposed changes should be sent to the
120-
<link doc="../support.xml" id="nginx_devel">nginx development</link>
121-
mailing list.
122-
The preferred and convenient method of submitting changesets
123-
is with the
124-
<link url="https://www.mercurial-scm.org/wiki/PatchbombExtension">patchbomb</link>
125-
extension.
119+
The proposed changes should be submitted from your fork to
120+
<link url="https://github.com/nginx/nginx">nginx repository</link>
121+
as a
122+
<link url="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork">pull request</link>.
126123
</para>
127124

128125
</section>
@@ -131,9 +128,14 @@ extension.
131128
<section id="website" name="Website">
132129

133130
<para>
134-
<link url="https://www.github.com/nginx/nginx.org">GitHub</link> is used
135-
to store the sources for this website. Documentation changes should be
136-
submitted as a pull request.
131+
GitHub is used to store the sources for this website.
132+
The <link url="https://www.github.com/nginx/nginx.org">repository</link>
133+
can be cloned with the following command:
134+
<programlisting>
135+
git clone https://github.com/nginx/nginx.org.git
136+
</programlisting>
137+
Documentation changes should be submitted from your fork
138+
as a pull request.
137139
</para>
138140

139141
</section>

xml/en/docs/governance.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@ NGINX is proud to be part of that change, from our very beginning.
2121
</para>
2222

2323
<para>
24-
NGINX embraces open source ethos and intends to remain an active contributor
25-
and leader in the ecosystem.
26-
This is encapsulated by our Core Commitments and Principles, which serve to
27-
help the longevity, transparency, and impact of our open source projects.
24+
NGINX embraces open source ethos and intends to remain
25+
an active contributor and leader in the ecosystem.
26+
This is encapsulated by our Core Commitments and Principles,
27+
which serve to help the longevity, transparency,
28+
and impact of our open source projects.
2829
</para>
2930

3031
</section>

xml/en/docs/howto_build_on_win32.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<article name="Building nginx on the Win32 platform with Visual C"
1010
link="/en/docs/howto_build_on_win32.html"
1111
lang="en"
12-
rev="27">
12+
rev="28">
1313

1414
<section name="Prerequisites">
1515

@@ -35,7 +35,7 @@ or <link url="http://strawberryperl.com">Strawberry Perl</link>.
3535
</listitem>
3636

3737
<listitem>
38-
<link url="https://www.mercurial-scm.org">Mercurial</link> client.
38+
<link url="https://cli.github.com/">Git</link> client.
3939
</listitem>
4040

4141
<listitem>
@@ -52,7 +52,7 @@ and <link url="http://www.openssl.org">OpenSSL</link> libraries sources.
5252
name="Build steps">
5353

5454
<para>
55-
Ensure that paths to Perl, Mercurial and MSYS bin directories are added to
55+
Ensure that paths to Perl, Git and MSYS bin directories are added to
5656
PATH environment variable before you start build. To set Visual C environment
5757
run vcvarsall.bat script from Visual C directory.
5858
</para>
@@ -67,9 +67,9 @@ Start MSYS bash.
6767
</listitem>
6868

6969
<listitem>
70-
Check out nginx sources from the hg.nginx.org repository. For example:
70+
Check out nginx sources from the GitHub repository:
7171
<programlisting>
72-
hg clone http://hg.nginx.org/nginx
72+
git clone https://github.com/nginx/nginx.git
7373
</programlisting>
7474
</listitem>
7575

xml/en/download.xml

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<article name="nginx: download"
99
link="/en/download.html"
1010
lang="en"
11-
rev="3">
11+
rev="4">
1212

1313

1414
<section name="Mainline version">
@@ -35,41 +35,35 @@
3535
<section name="Source Code">
3636

3737
<para>
38-
Read-only Mercurial repositories:
38+
GitHub repositories:
3939
<list type="bullet">
4040

4141
<listitem>
42-
code: <literal>http://hg.nginx.org/nginx</literal>
42+
code: <literal>https://github.com/nginx/nginx</literal>
4343
</listitem>
4444

4545
<listitem>
46-
website: <literal>http://hg.nginx.org/nginx.org</literal>
47-
(mirror of GitHub repository)
46+
website: <literal>https://github.com/nginx/nginx.org</literal>
4847
</listitem>
4948

5049
</list>
5150
</para>
5251

5352
<para>
54-
GitHub repositories:
53+
Mercurial mirrors:
5554
<list type="bullet">
5655

5756
<listitem>
58-
code: <link url="https://github.com/nginx/nginx"/>
59-
(mirror of Mercurial repository)
57+
code: <literal>http://hg.nginx.org/nginx</literal>
6058
</listitem>
6159

6260
<listitem>
63-
website: <link url="https://github.com/nginx/nginx.org"/>
61+
website: <literal>http://hg.nginx.org/nginx.org</literal>
6462
</listitem>
6563

6664
</list>
6765
</para>
6866

69-
<para>
70-
<link url="http://trac.nginx.org/nginx/browser">Trac source browser</link>
71-
</para>
72-
7367
</section>
7468

7569

xml/en/security_advisories.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414

1515
<para>
1616
All nginx security issues should be reported to
17-
<link url="mailto:[email protected]">[email protected]</link>.
17+
<link url="mailto:[email protected]">[email protected]</link>
18+
or via one of the methods listed
19+
<link url="https://github.com/nginx/nginx/blob/update_security_file/SECURITY.md">here</link>.
1820
</para>
1921

2022
<para>

xml/menu.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@
189189
<item href="/ru/docs/"> документация </item>
190190
<item href="/ru/docs/faq.html"> faq </item>
191191
<item href="/en/books.html" lang="en"> книги </item>
192-
<item href="/ru/support.html"> поддержка </item>
192+
<item href="/ru/community.html"> сообщество </item>
193193
<item />
194194

195195
<item href="http://trac.nginx.org/nginx"> trac </item>

xml/ru/GNUmakefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ DOCS = \
2020
beginners_guide \
2121
configure \
2222
quic \
23+
governance \
2324

2425
FAQ = \
2526
sys_errlist \
@@ -126,5 +127,5 @@ REFS = \
126127

127128
TOP = \
128129
download \
129-
support \
130+
community \
130131
linux_packages \

0 commit comments

Comments
 (0)