Add F5 prefix to first product mention on pages, clean frontmatter

nginx · Sep 26, 2024 · 99a18ca · 99a18ca
1 parent fba91c9
commit 99a18ca
Show file tree

Hide file tree

Showing 18 changed files with 31 additions and 40 deletions.
diff --git a/site/content/about.md b/site/content/about.md
@@ -5,7 +5,7 @@ toc: true
 docs: DOCS-000
 ---
 
-This page provides a brief overview of what NGINX Agent is, and how it works.
+This page provides a brief overview of what F5 NGINX Agent is, and how it works.
 
 ## Overview
 

diff --git a/site/content/contribute/community.md b/site/content/contribute/community.md
@@ -1,13 +1,12 @@
 ---
 title: "Community and contribution"
-draft: false
-weight: 100
 toc: true
-tags: [ "docs" ]
-categories: ["configuration"]
-doctypes: ["task"]
+weight: 100
+docs: DOCS-000
 ---
 
+This topic describes the various ways you can get involved with the F5 NGINX Agent project.
+
 # Community
 
 - Our [Slack channel #nginx-agent](https://nginxcommunity.slack.com/), is the go-to place to start asking questions and sharing your thoughts.

diff --git a/site/content/contribute/dev-environment-setup.md b/site/content/contribute/dev-environment-setup.md
@@ -7,7 +7,7 @@ docs: DOCS-000
 
 ## Overview
 
-This page describes how to configure a development environment for NGINX Agent.
+This page describes how to configure a development environment for F5 NGINX Agent.
 
 While most Linux or FreeBSD operating systems can be used to contribute to the NGINX Agent project, the following steps have been designed for Ubuntu. 
 

diff --git a/site/content/contribute/start-mock-interface.md b/site/content/contribute/start-mock-interface.md
@@ -5,7 +5,7 @@ weight: 300
 docs: DOCS-000
 ---
 
-This document describes how to configure and run NGINX Agent using a mock interface ("control plane") for NGINX Agent to report to. 
+This document describes how to configure and run F5 NGINX Agent using a mock interface ("control plane") for NGINX Agent to report to. 
 
 The mock interface is useful when developing NGINX Agent, as it allows you to view what metrics are being reported.
 

diff --git a/site/content/how-to/configuration-overview.md b/site/content/how-to/configuration-overview.md
@@ -2,10 +2,10 @@
 title: "Configuration overview"
 toc: true
 weight: 100
-docs: "DOCS-1229"
+docs: DOCS-1229
 ---
 
-This page describes how to configure NGINX Agent using configuration files, CLI (Command line interface) flags, and environment variables.
+This page describes how to configure F5 NGINX Agent using configuration files, CLI (Command line interface) flags, and environment variables.
 
 {{<note>}}
 

diff --git a/site/content/how-to/configure-agent-group.md b/site/content/how-to/configure-agent-group.md
@@ -5,7 +5,7 @@ weight: 400
 docs: DOCS-000
 ---
 
-This page describes how the NGINX Agent process interacts with the NGINX user on a system, and how to add users to the NGINX Agent group.
+This page describes how the F5 NGINX Agent process interacts with the NGINX user on a system, and how to add users to the NGINX Agent group.
 
 ## Overview
 

diff --git a/site/content/how-to/connect-management-plane.md b/site/content/how-to/connect-management-plane.md
@@ -7,7 +7,7 @@ docs: DOCS-000
 
 ## Overview
 
-To monitor and manage all your NGINX Agent instances from a central management plane server, you first need to connect your instances and the server. You can configure the connection by making the required changes to the NGINX Agent configuration file.
+To monitor and manage all your F5 NGINX Agent instances from a central management plane server, you first need to connect your instances and the server. You can configure the connection by making the required changes to the NGINX Agent configuration file.
 
 There are three types of connections you can establish between the NGINX Agent and the management plane server:
 

diff --git a/site/content/how-to/enable-interfaces.md b/site/content/how-to/enable-interfaces.md
@@ -5,7 +5,7 @@ weight: 200
 docs: DOCS-000 
 ---
 
-This document describes how to enable the gRPC and REST interfaces for NGINX Agent.
+This document describes how to enable the gRPC and REST interfaces for F5 NGINX Agent.
 
 ## Before you begin
 

diff --git a/site/content/how-to/encrypt-communication.md b/site/content/how-to/encrypt-communication.md
@@ -1,13 +1,13 @@
 ---
-title: Encrypt communication
+title: "Encrypt communication"
 toc: true
 weight: 500
 docs: DOCS-000
 ---
 
 ## Overview
 
-Follow the steps in this guide to encrypt communication between NGINX Agent and Instance Manager with TLS.
+Follow the steps in this guide to encrypt communication between F5 NGINX Agent and Instance Manager with TLS.
 
 ## Before You Begin
 

diff --git a/site/content/how-to/export-metrics.md b/site/content/how-to/export-metrics.md
@@ -4,6 +4,8 @@ weight: 300
 docs: DOCS-000
 ---
 
+This document describes how to export the metrics data from F5 NGINX Agent.
+
 [//]: # "These are Markdown comments to guide you through document structure."
 [//]: # "Remove them as you go, as well as unnecessary sections for this use case."
 

diff --git a/site/content/installation-upgrade/container-environments/docker-images.md b/site/content/installation-upgrade/container-environments/docker-images.md
@@ -1,22 +1,18 @@
 ---
 title: "Build container images"
-draft: false
-weight: 100
 toc: true
-tags: [ "docs" ]
-categories: ["configuration"]
-doctypes: ["task"]
+weight: 100
+docs: DOCS-000
 ---
 
 ## Overview
 
-NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances and must run in the same container to work. The NGINX Agent GitHub repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that you can use to build custom container images that bundle NGINX Agent with NGINX or NGINX Plus.
+F5 NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances and must run in the same container to work. The NGINX Agent GitHub repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that you can use to build custom container images that bundle NGINX Agent with NGINX or NGINX Plus.
 
 If you want to use NGINX Agent with NGINX Plus, you need to purchase an NGINX Plus license. Contact your F5 Sales representative for assistance.
 
 See the requirements and supported operating systems in the [NGINX Agent Technical Specifications]({{< relref "technical-specifications.md" >}}) topic.
 
-
 ## Set up your environment
 
 ### Install a container engine

diff --git a/site/content/installation-upgrade/container-environments/docker-support.md b/site/content/installation-upgrade/container-environments/docker-support.md
@@ -1,17 +1,13 @@
 ---
-title: Container support and troubleshooting
-categories:
-- installation
-draft: false
-tags:
-- docs
+title: "Container support and troubleshooting"
 toc: true
 weight: 200
+docs: DOCS-000
 ---
 
 ## Overview
 
-The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.
+The F5 NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.
 
 See the [Technical Specifications]({{< relref "/technical-specifications.md#container-support" >}}) for a list of supported operationg systems.
 

diff --git a/site/content/installation-upgrade/install.md b/site/content/installation-upgrade/install.md
@@ -5,7 +5,7 @@ weight: 100
 docs: DOCS-000
 ---
 
-This document describes the three main ways to install NGINX agent:
+This document describes the three main ways to install F5 NGINX agent:
 
 - Using the NGINX Open Source repository
 - Using the NGINX Plus repository

diff --git a/site/content/installation-upgrade/migrate-v3.md b/site/content/installation-upgrade/migrate-v3.md
@@ -4,6 +4,8 @@ weight: 500
 docs: DOCS-000
 ---
 
+This topic describes how to migrate from F5 NGINX Agent v2 to NGINX Agent v3.
+
 [//]: # "These are Markdown comments to guide you through document structure."
 [//]: # "Remove them as you go, as well as unnecessary sections for this use case."
 

diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/installation-upgrade/uninstall.md
@@ -7,8 +7,7 @@ docs: DOCS-000
 
 ## Overview
 
-Learn how to uninstall NGINX Agent from your system.
-
+Learn how to uninstall F5 NGINX Agent from your system.
 
 ## Before you begin
 

diff --git a/site/content/installation-upgrade/upgrade.md b/site/content/installation-upgrade/upgrade.md
@@ -7,7 +7,7 @@ docs: DOCS-000
 
 ## Overview
 
-Learn how to upgrade NGINX Agent.
+Learn how to upgrade F5 NGINX Agent.
 
 ## Upgrade NGINX Agent from version v2.31.0 or greater
 

diff --git a/site/content/metrics.md b/site/content/metrics.md
@@ -1,5 +1,5 @@
 ---
 title: OpenTelemetry metrics
-docs: DOCS-000
 weight: 300
+docs: DOCS-000
 ---
diff --git a/site/content/technical-specifications.md b/site/content/technical-specifications.md
@@ -1,16 +1,13 @@
 ---
 title: "Technical specifications"
-draft: false
-weight: 200
 toc: true
-tags: [ "docs" ]
-categories: ["development"]
-doctypes: ["task"]
+weight: 200
+docs: DOCS-000
 ---
 
 ## Overview
 
-This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
+This document provides technical specifications for F5 NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
 
 ## Supported distributions