Skip to content

docs: Revamp includes #1486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JTorreG merged 5 commits into from
Nov 25, 2025
Merged

docs: Revamp includes #1486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be93924
docs: move includes. add nd-product
JTorreG Nov 25, 2025
749d14b
docs: include cleanup
JTorreG Nov 25, 2025
137508d
fix: move include to nim folder
JTorreG Nov 25, 2025
ae79c01
feat: update archetypes
JTorreG Nov 25, 2025
fb7b86a
feat: update nd-product metadata to new convention
JTorreG Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion archetypes/concept.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc: false
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
nd-content-type: concept
# Intended for internal catalogue and search, case sensitive:
# AGE, DOS, NAZ, NGC, NGF, NIC, NIM, NGF, ONE, NOS, NPL, SOL, WAF
# NAGENT, NAZURE, NGOOGL, FABRIC, INGRESS, NIMNGR, NONECO, NGPLUS, SOLUTI, F5WAFN, F5DOSN, MISCEL
nd-product:
---

Expand Down
2 changes: 1 addition & 1 deletion archetypes/default.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc: false
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
nd-content-type: how-to
# Intended for internal catalogue and search, case sensitive:
# AGE, DOS, NAZ, NGC, NGF, NIC, NIM, NGF, ONE, NOS, NPL, SOL, WAF
# NAGENT, NAZURE, NGOOGL, FABRIC, INGRESS, NIMNGR, NONECO, NGPLUS, SOLUTI, F5WAFN, F5DOSN, MISCEL
nd-product:
---

Expand Down
2 changes: 1 addition & 1 deletion archetypes/landing-page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ nd-landing-page: true
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
nd-content-type: landing-page
# Intended for internal catalogue and search, case sensitive:
# AGE, DOS, NAZ, NGC, NGF, NIC, NIM, NGF, ONE, NOS, NPL, SOL, WAF
# NAGENT, NAZURE, NGOOGL, FABRIC, INGRESS, NIMNGR, NONECO, NGPLUS, SOLUTI, F5WAFN, F5DOSN, MISCEL
nd-product:
---

Expand Down
2 changes: 1 addition & 1 deletion archetypes/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc: false
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
nd-content-type: tutorial
# Intended for internal catalogue and search, case sensitive:
# AGE, DOS, NAZ, NGC, NGF, NIC, NIM, NGF, ONE, NOS, NPL, SOL, WAF
# NAGENT, NAZURE, NGOOGL, FABRIC, INGRESS, NIMNGR, NONECO, NGPLUS, SOLUTI, F5WAFN, F5DOSN, MISCEL
nd-product:
---

Expand Down
2 changes: 1 addition & 1 deletion content/agent/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ nd-landing-page: true
nd-content-type: landing-page
# Intended for internal catalogue and search, case sensitive:
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
nd-product: Agent
nd-product: NGAGENT
---

## About
Expand Down
2 changes: 1 addition & 1 deletion content/agent/configuration/configuration-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ draft: false
weight: 100
toc: true
nd-content-type: how-to
nd-product: Agent
nd-product: NGAGENT
nd-docs: DOCS-1229
---

Expand Down
2 changes: 1 addition & 1 deletion content/agent/installation-upgrade/installation-unprivileged.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 450
toc: true
nd-content-type:
- how-to
product: Agent
nd-product: NAGENT
nd-docs: DOCS-1781
---

Expand Down
2 changes: 1 addition & 1 deletion content/agent/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Support
weight: 800
toc: false
nd-content-type: reference
product: Agent
nd-product: NAGENT
nd-docs: DOCS-1883
---

Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/about.md
- content/nginx-one-console/agent/overview/about.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/overview/about.md
---

F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX One and enable remote management of NGINX instances. It also gathers performance metrics from NGINX and transmits them to the NGINX One Console for enhanced monitoring and control.
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/about.md
- content/nginx-one-console/agent/overview/about.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/overview/about.md
---

The figure shows:
Expand Down
5 changes: 3 additions & 2 deletions content/includes/agent/installation/install-agent-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
nd-docs: DOCS-1031
files:
- content/nim/waf-integration/configuration/setup-waf-config-management.md
nd-files:
- content/nim/security-monitoring/set-up-app-protect-instances.md
- content/nim/waf-integration/configuration/onboard-instances/install-nginx-agent.md
---

{{< call-out "note" >}}Make sure `gpg` is installed on your system before continuing. You can install NGINX Agent using command-line tools like `curl` or `wget`.{{< /call-out >}}
Expand Down
9 changes: 5 additions & 4 deletions content/includes/agent/installation/manually-connect-to-console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
files:
- content/nginx-one-console/agent/install-upgrade/install-from-github.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-github.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

If you have installed NGINX Agent manually, you will need to connect it to the
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/oss/oss-alpine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/oss/oss-amazon-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/oss/oss-debian.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
22 changes: 0 additions & 22 deletions content/includes/agent/installation/oss/oss-freebsd.md
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions content/includes/agent/installation/oss/oss-rhel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/oss/oss-sles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/oss/oss-ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/plus/plus-alpine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/plus/plus-amazon-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/plus/plus-debian.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
51 changes: 0 additions & 51 deletions content/includes/agent/installation/plus/plus-freebsd.md
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions content/includes/agent/installation/plus/plus-rhel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/plus/plus-sles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/plus/plus-ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
11 changes: 5 additions & 6 deletions content/includes/agent/installation/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
files:
- content/agent/install-upgrade/install-from-github.md
- content/agent/install-upgrade/install-from-oss-repo.md
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-github.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

- You must use one of the [supported operating system and architectures]({{< ref "/nginx-one-console/agent/overview/tech-specs.md#supported-distributions" >}})
Expand Down
11 changes: 5 additions & 6 deletions content/includes/agent/installation/start-stop-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
files:
- content/agent/install-upgrade/install-from-github.md
- content/agent/install-upgrade/install-from-oss-repo.md
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/install-from-github.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

To start NGINX Agent on `systemd` systems, run the following command:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/uninstall/uninstall-alpine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX agent:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/uninstall/uninstall-amazon-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX agent:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/uninstall/uninstall-debian.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
nd-product: NAGENT
nd-files:
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX Agent:
Expand Down
Loading
Loading