Skip to content

Commit b8c3b0e

Browse files
eepifanovaeepifanova
authored
Merge pull request #1 from nginx/public
Update docs to point towards Standard V2 (#254)
2 parents b679460 + 4dd3142 commit b8c3b0e

File tree

22 files changed

+243
-150
lines changed

22 files changed

+243
-150
lines changed

Diff for: ‎.github/labeler.yml

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Label PRs based on modified file paths (v5 format)
2+
# https://github.com/actions/labeler
3+
4+
# General documentation
5+
6+
documentation:
7+
- changed-files:
8+
- any-glob-to-any-file:
9+
- 'content/**'
10+
- 'assets/**'
11+
- 'static/**'
12+
- 'data/**'
13+
14+
# Product labels
15+
16+
product/agent:
17+
- changed-files:
18+
- any-glob-to-any-file:
19+
- 'content/agent/**'
20+
- 'content/includes/agent/**'
21+
22+
product/amplify:
23+
- changed-files:
24+
- any-glob-to-any-file: 'content/amplify/**'
25+
26+
product/controller:
27+
- changed-files:
28+
- any-glob-to-any-file:
29+
- 'content/controller/**'
30+
- 'content/includes/controller/**'
31+
32+
product/mesh:
33+
- changed-files:
34+
- any-glob-to-any-file: 'content/mesh/**'
35+
36+
product/modsec-waf:
37+
- changed-files:
38+
- any-glob-to-any-file: 'content/modsec-waf/**'
39+
40+
product/nap-dos:
41+
- changed-files:
42+
- any-glob-to-any-file:
43+
- 'content/nap-dos/**'
44+
- 'content/includes/nap-dos/**'
45+
46+
product/nap-waf:
47+
- changed-files:
48+
- any-glob-to-any-file:
49+
- 'content/nap-waf/**'
50+
- 'content/includes/nap-waf/**'
51+
52+
product/ngf:
53+
- changed-files:
54+
- any-glob-to-any-file:
55+
- 'content/ngf/**'
56+
- 'content/includes/ngf/**'
57+
58+
product/nginx-plus:
59+
- changed-files:
60+
- any-glob-to-any-file:
61+
- 'content/nginx/**'
62+
- 'content/includes/nginx-plus/**'
63+
64+
product/nginx-one:
65+
- changed-files:
66+
- any-glob-to-any-file:
67+
- 'content/nginx-one/**'
68+
- 'content/includes/nginx-one/**'
69+
70+
product/nginxaas:
71+
- changed-files:
72+
- any-glob-to-any-file:
73+
- 'content/nginxaas-azure/**'
74+
- 'content/includes/nginxaas-azure/**'
75+
76+
product/nim:
77+
- changed-files:
78+
- any-glob-to-any-file:
79+
- 'content/nim/**'
80+
- 'content/includes/nim/**'
81+
82+
product/nms:
83+
- changed-files:
84+
- any-glob-to-any-file:
85+
- 'content/nms/**'
86+
- 'content/includes/nms/**'
87+
88+
product/unit:
89+
- changed-files:
90+
- any-glob-to-any-file:
91+
- 'content/unit/**'
92+
- 'content/includes/unit/**'
93+
94+
# Other labels
95+
96+
process documentation:
97+
- changed-files:
98+
- any-glob-to-any-file:
99+
- 'templates/**'
100+
- '*.md'
101+
- 'LICENSE'
102+
103+
tooling:
104+
- changed-files:
105+
- any-glob-to-any-file:
106+
- 'layouts/**'
107+
- '.github/**'
108+
- '.cloudcannon/**'
109+
- 'styles/**'
110+
- 'layouts/**'
111+
- 'config/**'
112+
- 'archetypes/**'
113+
- '*.yml'
114+
- '*.yaml'
115+
- '*.json'
116+
- '*.ts'
117+
- '*.sh'
118+
- '*.js'
119+
- 'Makefile'
120+
- '.vale.ini'
121+
- '.gitignore'
122+
- '.gitattributes'

Diff for: ‎.github/workflows/labeler.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: PR Labeler
2+
3+
on:
4+
- pull_request_target
5+
6+
permissions:
7+
contents: read # Required to read the labeler.yml file
8+
pull-requests: write # Required to apply labels to PRs
9+
10+
jobs:
11+
label:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Apply labels based on file paths
15+
uses: actions/labeler@v5
16+
with:
17+
repo-token: "${{ secrets.GITHUB_TOKEN }}"

Diff for: ‎.github/workflows/ossf_scorecard.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,6 @@ jobs:
5656

5757
# Upload the results to GitHub's code scanning dashboard.
5858
- name: Upload SARIF results to code scanning
59-
uses: github/codeql-action/upload-sarif@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
59+
uses: github/codeql-action/upload-sarif@6bb031afdd8eb862ea3fc1848194185e076637e5 # v3.28.11
6060
with:
6161
sarif_file: results.sarif

Diff for: ‎archetypes/concept.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ type: concept
1010
# Intended for internal catalogue and search, case sensitive:
1111
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
1212
product:
13-
# Intended for internal catalogue
14-
docs: "DOCS-000"
1513
---
1614

1715
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
@@ -71,4 +69,4 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
7169

7270
## See also
7371

74-
[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
72+
[//]: # "Link to related documents, such as concepts, reference material or similar use cases."

Diff for: ‎archetypes/default.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ type: how-to
1010
# Intended for internal catalogue and search, case sensitive:
1111
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
1212
product:
13-
# Intended for internal catalogue
14-
docs: "DOCS-000"
1513
---
1614

1715
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
@@ -87,4 +85,4 @@ To complete this guide, you will need the following prerequisites:
8785

8886
## See also
8987

90-
[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
88+
[//]: # "Link to related documents, such as concepts, reference material or similar use cases."

Diff for: ‎archetypes/tutorial.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ type: tutorial
1010
# Intended for internal catalogue and search, case sensitive:
1111
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
1212
product:
13-
# Intended for internal catalogue
14-
docs: "DOCS-000"
1513
---
1614

1715
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
@@ -119,4 +117,4 @@ To verify the creation of <component>, you can also inspect information about it
119117

120118
## See also
121119

122-
[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
120+
[//]: # "Link to related documents, such as concepts, reference material or similar use cases."

Diff for: ‎content/includes/nap-waf/config/common/anti-automation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ This is a list of the trusted bots that are currently part of the bot signatures
131131
|MojeekBot | [Mojeek search engine](https://www.mojeek.com/) |
132132
|Yahoo! Slurp | [Yahoo search engine](https://www.yahoo.com/) |
133133
|Yandex | [Yandex search engine](https://yandex.com/) |
134-
|YioopBot | [Yioop search engine](https://www.yioop.com/) |
134+
|YioopBot | Yioop search engine |
135135
{{</bootstrap-table>}}
136136

137137

Diff for: ‎content/includes/nginx-plus/install/copy-jwt-to-etc-nginx-dir.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,8 @@
22
docs:
33
---
44

5-
After downloading the JWT file, copy it to the **/etc/nginx/** directory and make sure it's named **license.jwt**:
5+
Copy the downloaded JWT file to the **/etc/nginx/** directory and make sure it is named **license.jwt**:
66

77
```shell
88
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
99
```
10-
11-
Replace `<downloaded-file-name>.jwt` with the actual name of your downloaded JWT file.

Diff for: ‎content/nginx/admin-guide/installing-nginx/installing-nginx-open-source.md

+31-33
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ NGINX, Inc. provides packages for the following CentOS, Oracle Linux, RHEL, Alm
4747

4848
|Version | Supported Platforms |
4949
| ---| --- |
50-
|7.4+ | x86_64, aarch64/arm64 |
51-
|8x | x86_64, aarch64/arm64, s390x |
52-
|9x | x86_64, aarch64/arm64, s390x |
50+
|8x | x86_64, aarch64/arm64 |
51+
|9x | x86_64, aarch64/arm64 |
5352

5453
{{</bootstrap-table>}}
5554

@@ -155,7 +154,7 @@ The package can be installed from:
155154
```shell
156155
curl -I 127.0.0.1
157156
HTTP/1.1 200 OK
158-
Server: nginx/1.27.0
157+
Server: nginx/1.27.4
159158
```
160159

161160
<span id="prebuilt_debian"></span>
@@ -284,7 +283,7 @@ The package can be installed from:
284283
```shell
285284
curl -I 127.0.0.1
286285
HTTP/1.1 200 OK
287-
Server: nginx/1.27.0
286+
Server: nginx/1.27.4
288287
```
289288

290289
<span id="prebuilt_ubuntu"></span>
@@ -299,8 +298,8 @@ NGINX provides packages for the following Ubuntu operating systems:
299298
| ---| ---| --- |
300299
|20.04 | focal | x86_64, aarch64/arm64, s390x |
301300
|22.04 | jammy | x86_64, aarch64/arm64, s390x |
302-
|22.10 | kinetic | x86_64, aarch64/arm64 |
303-
|23.04 | lunar | x86_64, aarch64/arm64 |
301+
|24.04 | noble | x86_64, aarch64/arm64 |
302+
|24.10 | oracular | x86_64, aarch64/arm64 |
304303

305304
{{</bootstrap-table>}}
306305

@@ -412,7 +411,7 @@ The package can be installed from:
412411
```shell
413412
curl -I 127.0.0.1
414413
HTTP/1.1 200 OK
415-
Server: nginx/1.27.0
414+
Server: nginx/1.27.4
416415
```
417416

418417
<span id="prebuilt_suse"></span>
@@ -425,7 +424,6 @@ NGINX provides packages for SUSE Linux Enterprise Server:
425424

426425
|Version | Supported Platforms |
427426
| ---| --- |
428-
|SLES 12 SP5+ | x86_64 |
429427
|SLES 15 SP2+ | x86_64 |
430428

431429
{{</bootstrap-table>}}
@@ -508,10 +506,10 @@ NGINX provides packages for the following Alpine Linux operating systems:
508506

509507
|Version | Supported Platforms |
510508
| ---| --- |
511-
|3.15 | x86_64, aarch64/arm64 |
512-
|3.16 | x86_64, aarch64/arm64 |
513-
|3.17 | x86_64, aarch64/arm64 |
514509
|3.18 | x86_64, aarch64/arm64 |
510+
|3.19 | x86_64, aarch64/arm64 |
511+
|3.20 | x86_64, aarch64/arm64 |
512+
|3.21 | x86_64, aarch64/arm64 |
515513

516514
{{</bootstrap-table>}}
517515

@@ -689,9 +687,9 @@ Prior to compiling NGINX Open Source from source, you need to install librarie
689687
- [PCRE](http://pcre.org/) – Supports regular expressions. Required by the NGINX [Core](https://nginx.org/en/docs/ngx_core_module.html) and [Rewrite](https://nginx.org/en/docs/http/ngx_http_rewrite_module.html) modules.
690688

691689
```shell
692-
wget github.com/PCRE2Project/pcre2/releases/download/pcre2-10.42/pcre2-10.42.tar.gz
693-
tar -zxf pcre2-10.42.tar.gz
694-
cd pcre2-10.42
690+
wget github.com/PCRE2Project/pcre2/releases/download/pcre2-10.43/pcre2-10.43.tar.gz
691+
tar -zxf pcre2-10.43.tar.gz
692+
cd pcre2-10.43
695693
./configure
696694
make
697695
sudo make install
@@ -700,9 +698,9 @@ Prior to compiling NGINX Open Source from source, you need to install librarie
700698
- [zlib](http://www.zlib.net/) – Supports header compression. Required by the NGINX [Gzip](https://nginx.org/en/docs/http/ngx_http_gzip_module.html) module.
701699

702700
```shell
703-
wget http://zlib.net/zlib-1.2.13.tar.gz
704-
tar -zxf zlib-1.2.13.tar.gz
705-
cd zlib-1.2.13
701+
wget http://zlib.net/zlib-1.3.1.tar.gz
702+
tar -zxf zlib-1.3.1.tar.gz
703+
cd zlib-1.3.1
706704
./configure
707705
make
708706
sudo make install
@@ -711,9 +709,9 @@ Prior to compiling NGINX Open Source from source, you need to install librarie
711709
- [OpenSSL](https://www.openssl.org/) – Supports the HTTPS protocol. Required by the NGINX [SSL](https://nginx.org/en/docs/http/ngx_http_ssl_module.html) module and others.
712710

713711
```shell
714-
wget http://www.openssl.org/source/openssl-1.1.1v.tar.gz
715-
tar -zxf openssl-1.1.1v.tar.gz
716-
cd openssl-1.1.1v
712+
wget http://www.openssl.org/source/openssl-3.0.13.tar.gz
713+
tar -zxf openssl-3.0.13.tar.gz
714+
cd openssl-3.0.13
717715
./Configure darwin64-x86_64-cc --prefix=/usr
718716
make
719717
sudo make install
@@ -727,17 +725,17 @@ Download the source files for both the stable and mainline versions from [**ngin
727725
To download and unpack the source for the latest _mainline_ version, run:
728726

729727
```shell
730-
wget https://nginx.org/download/nginx-1.27.0.tar.gz
731-
tar zxf nginx-1.27.0.tar.gz
732-
cd nginx-1.27.0
728+
wget https://nginx.org/download/nginx-1.27.4.tar.gz
729+
tar zxf nginx-1.27.4.tar.gz
730+
cd nginx-1.27.4
733731
```
734732

735733
To download and unpack source files for the latest _stable_ version, run:
736734

737735
```shell
738-
wget https://nginx.org/download/nginx-1.26.1.tar.gz
739-
tar zxf nginx-1.26.1.tar.gz
740-
cd nginx-1.26.1
736+
wget https://nginx.org/download/nginx-1.26.3.tar.gz
737+
tar zxf nginx-1.26.3.tar.gz
738+
cd nginx-1.26.3
741739
```
742740

743741
<span id="configure"></span>
@@ -752,8 +750,8 @@ An example of options to the `configure` script (should be typed as a single lin
752750
--sbin-path=/usr/local/nginx/nginx
753751
--conf-path=/usr/local/nginx/nginx.conf
754752
--pid-path=/usr/local/nginx/nginx.pid
755-
--with-pcre=../pcre2-10.42
756-
--with-zlib=../zlib-1.2.13
753+
--with-pcre=../pcre2-10.43
754+
--with-zlib=../zlib-1.3.1
757755
--with-http_ssl_module
758756
--with-stream
759757
--with-mail=dynamic
@@ -841,8 +839,8 @@ If you do not need a module that is built by default, you can disable it by nami
841839
--pid-path=/usr/local/nginx/nginx.pid
842840
--with-http_ssl_module
843841
--with-stream
844-
--with-pcre=../pcre2-10.42
845-
--with-zlib=../zlib-1.2.13
842+
--with-pcre=../pcre2-10.43
843+
--with-zlib=../zlib-1.3.1
846844
--without-http_empty_gif_module
847845
```
848846

@@ -896,8 +894,8 @@ An example of the `configure` command that includes nondefault modules (should b
896894
--sbin-path=/usr/local/nginx/nginx
897895
--conf-path=/usr/local/nginx/nginx.conf
898896
--pid-path=/usr/local/nginx/nginx.pid
899-
--with-pcre=../pcre2-10.42
900-
--with-zlib=../zlib-1.2.13
897+
--with-pcre=../pcre2-10.43
898+
--with-zlib=../zlib-1.3.1
901899
--with-http_ssl_module
902900
--with-stream
903901
--with-mail

0 commit comments

Comments
 (0)