Skip to content

Commit 3804e02

Browse files
authored
Merge branch 'main' into newfield-nic-migration-update
2 parents 0cfaf0f + bef41ba commit 3804e02

File tree

579 files changed

+3703
-3299
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

579 files changed

+3703
-3299
lines changed

.cloudcannon/schemas/default.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To do xzy, take the following steps:
3939

4040
2. Format as numbered lists.
4141

42-
{{< note >}}Add notes like this.{{</note>}}
42+
{{< call-out "note" >}}Add notes like this.{{< /call-out >}}
4343

4444
3. If there is only one step, you don't need to format it as a numbered list.
4545

.cloudcannon/schemas/nms/policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The following table lists the configurable settings and their default values for
8181

8282
{{%tab name="API"%}}
8383

84-
{{<see-also>}}{{< include "acm/how-to/access-acm-api.md" >}}{{</see-also>}}
84+
{{< call-out "note" >}}{{< include "acm/how-to/access-acm-api.md" >}}{{< /call-out >}}
8585

8686
To create an XYZ policy using the REST API, send an HTTP `POST` request to the Add-Endpoint-Name-Here endpoint.
8787

.github/pull_request_template.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,31 @@
11
### Proposed changes
22

3-
Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
4-
following format:
3+
[//]: # "Write a clear and concise description of what the pull request changes."
4+
[//]: # "You can use our Commit messages guidance for this."
5+
[//]: # "https://github.com/nginx/documentation/blob/main/documentation/git-conventions.md#commit-messages"
56

6-
Problem: Give a brief overview of the problem or feature being addressed.
7+
[//]: # "First, explain what was changed, and why. This should be most of the detail."
8+
[//]: # "Then how the changes were made, such as referring to existing styles and conventions."
9+
[//]: # "Finish by noting anything beyond the scope of the PR changes that may be affected."
710

8-
Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
9-
considerations.
11+
[//]: # "Include information on testing if relevant and non-obvious from the deployment preview."
12+
[//]: # "For expediency, you can use screenshots to show small before and after examples."
1013

11-
Testing: Describe any testing that you did.
14+
[//]: # "If the changes were defined by a GitHub issue, reference it using keywords."
15+
[//]: # "https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests"
1216

13-
Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
14-
specific feedback, add them here.
15-
16-
If this PR addresses an [issue](https://github.com/nginx/documentation/issues) on GitHub, ensure that you link to it here:
17-
18-
Closes #ISSUE
17+
[//]: # "Do not like to any internal, non-public resources. This includes internal repository issues or anything in an intranet."
18+
[//]: # "You can make reference to internal discussions without linking to them: see 'Referencing internal information'."
19+
[//]: # "https://github.com/nginx/documentation/blob/main/documentation/closed-contributions.md#referencing-internal-information"
1920

2021
### Checklist
2122

22-
Before merging a pull request, run through this checklist and mark each as complete.
23+
Before sharing this pull request, I completed the following checklist:
2324

24-
- [ ] I have read the [contributing guidelines](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md)
25-
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)
26-
- [ ] I have rebased my branch onto main
27-
- [ ] I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
28-
- [ ] I have ensured that the commit messages adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
29-
- [ ] I have ensured that documentation content adheres to [the style guide](/documentation/style-guide.md)
30-
- [ ] If the change involves potentially sensitive changes[^1], I have assessed the possible impact
31-
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
32-
- [ ] I have ensured that existing tests pass after adding my changes
33-
- [ ] If applicable, I have updated [`README.md`](/README.md)
25+
- [ ] I read the [Contributing guidelines](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md)
26+
- [ ] My branch adheres to the [Git conventions](https://github.com/nginx/documentation/blob/main/documentation/git-conventions.md)
27+
- [ ] My content changes adhere to the [F5 NGINX Documentation style guide](https://github.com/nginx/documentation/blob/main/documentation/style-guide.md)
28+
- [ ] If my changes involve potentially sensitive information[^1], I have assessed the possible impact
29+
- [ ] I have waited to ensure my changes pass tests, and addressed any discovered issues
3430

35-
[^1]: Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to [our style guide](/documentation/style-guide.md) for guidance about placeholder content.
31+
[^1]: Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the [style guide](https://github.com/nginx/documentation/blob/main/documentation/style-guide.md) for guidance about placeholder content.

.github/workflows/coveo.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ jobs:
7272
needs: generate-coveo-search-token
7373
steps:
7474
- name: Download Coveo search token
75-
uses: actions/download-artifact@v4
75+
uses: actions/download-artifact@v5
7676

7777
- name: View files
7878
run: ls -R
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Detect changes in documentation within nginx/nginx.org
2+
3+
on:
4+
schedule:
5+
- cron: "0 */23 * * *"
6+
permissions:
7+
contents: write
8+
pull-requests: write
9+
issues: write
10+
11+
jobs:
12+
detect-changes:
13+
name: Detect changes in 'en' docs of nginx/nginx.org
14+
runs-on: ubuntu-latest
15+
outputs:
16+
IS_CHANGES_DETECTED: ${{ steps.check_changes.outputs.changed }}
17+
steps:
18+
- name: Checkout Repository
19+
uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 # v4.2.2
20+
with:
21+
fetch-depth: 0
22+
- name: Clone the nginx/nginx-org repository
23+
run: |
24+
git clone --depth=2 https://github.com/nginx/nginx.org.git dot-org-repo
25+
- name: Check for changes in xml/en folder
26+
id: check_changes
27+
run: |
28+
cd dot-org-repo
29+
30+
if git whatchanged --since="1 day ago" -- _xml/en/; then
31+
echo "Changes detected in /en"
32+
echo "changed=true" >> $GITHUB_OUTPUT
33+
else
34+
echo "No changes in /en"
35+
echo "changed=false" >> $GITHUB_OUTPUT
36+
fi
37+
- name: Execute make target 'make hugo-md' to generate markdown
38+
if: steps.check_changes.outputs.changed == 'true'
39+
run: |
40+
cd dot-org-repo
41+
make module-markdown
42+
- name: Create PR
43+
uses: peter-evans/create-pull-request@v7
44+
if: steps.check_changes.outputs.changed == 'true'
45+
with:
46+
commit-message: "chore: Update nginx plus module reference from detected changes in nginx/nginx.org"
47+
labels: product/nginx-plus, dependencies, module-reference
48+
base: main
49+
branch: update-nginx-module-ref
50+
title: 'NGINX Plus - Module Ref: Update content for content/nginx due to detected changes'
51+
add-paths: |
52+
dot-org-repo/libxslt-md/
53+
dot-org-repo/yaml/nginx_api.yaml
54+
body: |
55+
### Proposed Changes
56+
Updated NGINX Plus docs.

.github/workflows/linkchecker.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ env:
3232
--ignore-url ^https://oauth2.googleapis.com --ignore-url ^https://openidconnect.googleapis.com --ignore-url ^https://www.base64url.com/
3333
--ignore-url ^https://go.googlesource.com/ --ignore-url ^https://go.googlesource.com/sync --ignore-url ^https://linkerd.io/2.13/
3434
--ignore-url ^http://www.redirectpage.com/ --ignore-url ^https://www.gnu.org/ --ignore-url ^https://insert_your_tenant_name.console.ves.volterra.io/
35+
--ignore-url ^https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io
3536
--ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginx-ingress-controller/css
3637
--ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginxaas/azure/css
3738
--ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginx-gateway-fabric/css

.github/workflows/ossf_scorecard.yml

Lines changed: 1 addition & 1 deletion
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@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
59+
uses: github/codeql-action/upload-sarif@76621b61decf072c1cee8dd1ce2d2a82d33c17ed # v3.29.5
6060
with:
6161
sarif_file: results.sarif

content/agent/configuration/configuration-overview.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ nd-content-type: how-to
99

1010
The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.
1111

12-
{{<note>}}
12+
{{< call-out "note" >}}
1313

1414
- NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities:
1515

@@ -19,7 +19,7 @@ The following sections explain how to configure NGINX Agent using configuration
1919

2020
- You must open any required firewall ports or add SELinux/AppArmor rules for the ports and IPs you want to use.
2121

22-
{{</note>}}
22+
{{< /call-out >}}
2323

2424
## Configure with Config Files
2525

@@ -30,9 +30,9 @@ Examples of the configuration files are provided below:
3030
<details open>
3131
<summary>example nginx-agent.conf</summary>
3232

33-
{{<note>}}
33+
{{< call-out "note" >}}
3434
In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the control plane.
35-
{{</note>}}
35+
{{< /call-out >}}
3636

3737
```nginx {hl_lines=[13]}
3838
#
@@ -118,11 +118,11 @@ nginx_app_protect:
118118
<details open>
119119
<summary>example dynamic-agent.conf</summary>
120120

121-
{{<note>}}
121+
{{< call-out "note" >}}
122122
Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
123123

124124
Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
125-
{{</note>}}
125+
{{< /call-out >}}
126126

127127
```yaml
128128
# Dynamic configuration file for NGINX Agent.
@@ -169,13 +169,13 @@ nginx-agent
169169

170170
### CLI Flags and Environment Variables
171171

172-
{{< warning >}}
172+
{{< call-out "warning" >}}
173173

174174
Before version 2.35.0, the environment variables were prefixed with `NMS_` instead of `NGINX_AGENT_`.
175175

176176
If you are upgrading from an older version, update your configuration accordingly.
177177

178-
{{< /warning >}}
178+
{{< /call-out >}}
179179

180180
{{<bootstrap-table "table table-responsive table-bordered">}}
181181
| CLI flag | Environment variable | Description |
@@ -218,7 +218,7 @@ If you are upgrading from an older version, update your configuration accordingl
218218

219219
<br>
220220

221-
{{<note>}}
221+
{{< call-out "note" >}}
222222
Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane.
223223

224224
NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location.
@@ -227,15 +227,15 @@ NGINX Agent follows NGINX configuration directives to file paths outside the des
227227

228228
- [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate)
229229

230-
{{</note>}}
230+
{{< /call-out >}}
231231

232-
{{<note>}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
232+
{{< call-out "note" >}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
233233

234234
Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
235235

236236
Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
237237

238-
{{</note>}}
238+
{{< /call-out >}}
239239

240240
## Log Rotation
241241

content/agent/configuration/encrypt-communication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ NGINX_AGENT_TLS_ENABLE=true
9494

9595
## Enable Server-Side TLS With Self-Signed Certificate
9696

97-
{{< warning >}}These steps are not recommended for production environments.{{< /warning >}}
97+
{{< call-out "warning" >}}These steps are not recommended for production environments.{{< /call-out >}}
9898

9999
To enable server-side TLS with a self-signed certificate, you must have TLS enabled and set `skip_verify` to `true`, which disables hostname validation. Setting `skip_verify` can be done done only by updating the configuration file. See the following example:
100100

content/agent/installation-upgrade/container-environments/docker-images.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This guide provides instructions on how to build images with NGINX Agent and NGI
2727

2828
You can use [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation) to manage NGINX Agent container images. Follow the installation instructions for your preferred container engine and be sure the service is running before proceeding with the instructions in this document.
2929

30-
{{<note>}}The examples in this document primarily use Docker commands. You can adapt these using the appropriate [Podman commands](https://docs.podman.io/en/latest/Commands.html) if you're not using Docker.{{</note>}}
30+
{{< call-out "note" >}}The examples in this document primarily use Docker commands. You can adapt these using the appropriate [Podman commands](https://docs.podman.io/en/latest/Commands.html) if you're not using Docker.{{< /call-out >}}
3131

3232
### Install the GNU Make package
3333

@@ -112,7 +112,7 @@ docker tag docker-registry.nginx.com/nginx/agent:mainline nginx-agent
112112
docker run --name nginx-agent -d nginx-agent
113113
```
114114

115-
{{<note>}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< ref "/agent/configuration/configuration-overview" >}}).{{</note>}}
115+
{{< call-out "note" >}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< ref "/agent/configuration/configuration-overview" >}}).{{< /call-out >}}
116116

117117
### Enable the gRPC interface
118118

@@ -166,7 +166,7 @@ If the REST Interface is configured correctly, then you should see a JSON object
166166
167167
## Build the NGINX Agent images for specific OS targets
168168
169-
{{<important>}}The only **officially supported** base operating system is **Alpine**. The instructions below for other operating systems are provided for informational and **testing purposes only**.{{</important>}}
169+
{{< call-out "important" >}}The only **officially supported** base operating system is **Alpine**. The instructions below for other operating systems are provided for informational and **testing purposes only**.{{< /call-out >}}
170170
171171
The NGINX Agent GitHub repo has a set of Make commands that you can use to build a container image for an specific operating system and version:
172172
@@ -200,7 +200,7 @@ IMAGE_BUILD_TARGET=install-agent-repo NGINX_AGENT_VERSION=2.37.0~bullseye OS_REL
200200
201201
### Build NGINX Plus images
202202
203-
{{<important>}}You need a license to use NGINX Agent with NGINX Plus. You must complete the steps in the [Download the certificate and key files from MyF5](#myf5-download) section before proceeding.{{</important>}}
203+
{{< call-out "important" >}}You need a license to use NGINX Agent with NGINX Plus. You must complete the steps in the [Download the certificate and key files from MyF5](#myf5-download) section before proceeding.{{< /call-out >}}
204204
205205
Run the following `make` command to build the default image, which uses Ubuntu 24.04 (Noble) as the base image.
206206

0 commit comments

Comments
 (0)