Skip to content

Commit bd9ada1

Browse files
committed
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
2 parents 8c8580e + 8487abf commit bd9ada1

File tree

14 files changed

+248
-42
lines changed

14 files changed

+248
-42
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Contributing guidelines
22

3-
The following is a set of guidelines for community contributions to this
4-
project. We really appreciate your desire to contribute!
3+
The following is a set of guidelines for community contributions to this project.
54

6-
If you are an F5 employee, see the following additional guidance [For F5 Employees](./F5-NGINX-team-notes.md).
5+
We really appreciate your desire to contribute!
6+
7+
If you are an F5 employee, see the following additional guidance on [Maintainers etiquette](/documentation/maintainers-etiquette.md).
78

89
## Table of contents
910

@@ -12,8 +13,8 @@ If you are an F5 employee, see the following additional guidance [For F5 Employe
1213
- [Open a Discussion](#open-a-discussion)
1314
- [Submit a Pull Request](#submit-a-pull-request)
1415
- Review our [Git style guide](#git-style-guide)
15-
- Review our Documentation [style guide](./templates/style-guide.md)
16-
- Review our [Contributing guidelines for writers](./CONTRIBUTING_DOCS.md)
16+
- Review the [Writing style guide](/documentation/style-guide.md)
17+
- Review [Managing content with Hugo](/documentation/writing-hugo.md)
1718
- [Issue Lifecycle](#issue-lifecycle)
1819
- [Additional NGINX documentation](#additional-nginx-documentation)
1920
- [F5 Contributor License Agreement (CLA)](#f5-contributor-license-agreement)
@@ -51,6 +52,7 @@ our documentation as described in our [support](./SUPPORT.md) page.
5152
### Git style guide
5253

5354
- Keep a clean, concise and meaningful Git commit history on your branch, rebasing locally and squashing before you submit a PR
55+
- We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) formatting.
5456
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
5557
and summarized in the next few points:
5658

archetypes/landing-page.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
# The title is the product name
3+
title:
4+
# The URL is the base of the deployed path, becoming "docs.nginx.com/<url>/<other-pages>"
5+
url:
6+
# The cascade directive applies its nested parameters down the page tree until overwritten
7+
cascade:
8+
# The logo file is resolved from the theme, in the folder /static/images/icons/
9+
logo:
10+
# The subtitle displays directly underneath the heading of a given page
11+
nd-subtitle:
12+
# Indicates that this is a custom landing page
13+
nd-landing-page: true
14+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
15+
nd-content-type: landing-page
16+
# Intended for internal catalogue and search, case sensitive:
17+
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
18+
nd-product:
19+
---
20+
21+
## About
22+
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
23+
[//]: # "Use underscores for _italics_, and double asterisks for **bold**."
24+
[//]: # "Backticks are for `monospace`, used sparingly and reserved mostly for executable names - they can cause formatting problems. Avoid them in tables: use italics instead."
25+
26+
[//]: # "This initial section introduces the product to a reader: give a short 1-2 sentence summary of what the product does and its value to the reader."
27+
[//]: # "Name specific functionality it provides: avoid ambiguous descriptions such as 'enables efficiency', focus on what makes it unique."
28+
29+
## Featured content
30+
[//]: # "You can add a maximum of three cards: any extra will not display."
31+
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
32+
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
33+
34+
{{<card-layout>}}
35+
{{<card-section showAsCards="true" isFeaturedSection="true">}}
36+
{{<card title="<some-title>">}}
37+
<!-- Each description should be roughly 10 words or less. -->
38+
{{</card>}}
39+
<!-- The titleURL and icon are both optional -->
40+
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
41+
{{<card title="<some-title>" titleUrl="<some-url>" icon="<some-lucide-icon>">}}
42+
<!-- Each description should be roughly 10 words or less. -->
43+
{{</card>}}
44+
{{</card-section>}}
45+
{{</card-layout>}}
46+
47+
## Other content
48+
49+
[//]: # "You can add any extra content for the page here, such as additional cards, diagrams or text."

content/agent/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: NGINX Agent
33
url: /nginx-agent/
44
cascade:
55
logo: NGINX-product-icon.png
6-
banner:
6+
nd-banner:
77
enabled: true
88
type: deprecation
99
start-date: 2025-05-29

content/controller/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 2100
66
cascade:
77
logo: "NGINX-Controller-product-icon-RGB.svg"
88
noindex: true
9-
banner:
9+
nd-banner:
1010
enabled: true
1111
type: deprecation
1212
md: _banners/eos-cltr.md

content/includes/use-cases/monitoring/enable-nginx-plus-api.md

Lines changed: 47 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,59 @@ files:
55
- content/nginx-one/getting-started.md
66
---
77
<!-- include in content/nginx-one/getting-started.md disabled, hopefully temporarily -->
8-
To collect comprehensive metrics for NGINX Plus--including bytes streamed, information about upstream systems and caches, and counts of all HTTP status codes--add the following to your NGINX Plus configuration file (for example, `/etc/nginx/nginx.conf` or an included file):
8+
To collect comprehensive metrics for NGINX Plus -- including bytes streamed, information about upstream systems and caches, and counts of all HTTP status codes -- add the following to your NGINX Plus configuration file (for example, `/etc/nginx/nginx.conf` or an included file):
99

1010
```nginx
11-
# Enable the /api/ location with appropriate access control
12-
# to use the NGINX Plus API.
13-
#
14-
location /api/ {
15-
api write=on;
16-
allow 127.0.0.1;
17-
deny all;
18-
}
19-
```
11+
# This block:
12+
# - Enables the read-write NGINX Plus API under /api/
13+
# - Serves the built-in dashboard at /dashboard.html
14+
# - Restricts write methods (POST, PATCH, DELETE) to authenticated users
15+
# and a specified IP range
16+
# Change the listen port if 9000 conflicts; 8080 is the conventional API port.
17+
server {
18+
# Listen on port 9000 for API and dashboard traffic
19+
listen 9000 default_server;
20+
21+
# Handle API calls under /api/
22+
location /api/ {
23+
# Enable write operations (POST, PATCH, DELETE)
24+
api write=on;
25+
26+
# Allow GET requests from any IP
27+
allow 0.0.0.0/0;
28+
# Deny all other requests by default
29+
deny all;
2030
21-
This configuration:
31+
# For methods other than GET, require auth and restrict to a network
32+
limit_except GET {
33+
# Prompt for credentials with this realm
34+
auth_basic "NGINX Plus API";
35+
# Path to the file with usernames and passwords
36+
auth_basic_user_file /path/to/passwd/file;
2237
23-
- Enables the NGINX Plus API.
24-
- Allows requests only from `127.0.0.1` (localhost).
25-
- Blocks all other requests for security.
38+
# Allow only this IP range (replace with your own)
39+
allow 192.0.2.0/24;
40+
# Deny all other IPs
41+
deny all;
42+
}
43+
}
44+
45+
# Serve the dashboard page at /dashboard.html
46+
location = /dashboard.html {
47+
# Files are located under this directory
48+
root /usr/share/nginx/html;
49+
}
50+
51+
# Redirect any request for / to the dashboard
52+
location / {
53+
return 301 /dashboard.html;
54+
}
55+
}
56+
```
2657

27-
For more details, see the [NGINX Plus API module documentation](https://nginx.org/en/docs/http/ngx_http_api_module.html).
58+
For more details, see the [NGINX Plus API module documentation](https://nginx.org/en/docs/http/ngx_http_api_module.html) and [Configuring the NGINX Plus API]({{< ref "nginx/admin-guide/monitoring/live-activity-monitoring.md#configuring-the-api" >}}).
2859

29-
After saving the changes, reload NGINX to apply the new configuration:
60+
After saving the changes, reload NGINX:
3061

3162
```shell
3263
nginx -s reload

content/mesh/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: 'NGINX Service Mesh is a fully integrated lightweight service mesh
88
url: /nginx-service-mesh/
99
cascade:
1010
noindex: true
11-
banner:
11+
nd-banner:
1212
enabled: true
1313
type: deprecation
1414
md: _banners/eos-mesh.md

content/ngf/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: NGINX Gateway Fabric
33
url: /nginx-gateway-fabric/
44
cascade:
55
logo: NGINX-Gateway-Fabric-product-icon.png
6-
banner:
6+
nd-banner:
77
enabled: true
88
type: deprecation
99
start-date: 2025-05-30

content/nim/deploy/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description:
44
weight: 20
55
url: /nginx-instance-manager/deploy/
66
cascade:
7-
banner:
7+
nd-banner:
88
enabled: true
99
type: deprecation
1010
md: _banners/upgrade-r33.md

documentation/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This directory contains the documentation for the NGINX Documentation repository.
44

5-
It's used by the DocOps team to record how we configure our tools and instructions for certain precise tasks.
5+
It's used by the DocOps team to record how we use our tools and instructions for common tasks.
66

77
There's also documentation around our ways of working, and ideas of significance wider than the scope of an issue or pull request.
88

@@ -12,4 +12,9 @@ If you're interested in contributing to the [NGINX documentation website](https:
1212

1313
## Topics
1414

15+
- [Contributing closed content](/documentation/closed-contributions.md)
16+
- [Information architecture heuristics](/documentation/ia-heuristics.md)
17+
- [Maintainers etiquette](/documentation/maintainers-etiquette.md)
18+
- [Managing content with Hugo](/documentation/writing-hugo.md)
1519
- [Proposals](/documentation/proposals/README.md)
20+
- [Writing style guide](/documentation/style-guide.md)

CLOSED_CONTRIBUTIONS.md renamed to documentation/closed-contributions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing guidelines for closed content
1+
# Contributing closed content
22

33
This document describes the process for authoring "closed content", which is content of a sensitive nature that cannot be publicised before release.
44

0 commit comments

Comments
 (0)