Merge branch 'main' into Update-docs-issue147

Author: ADubhlaoich

.github/pull_request_template.md

@@ -1,35 +1,31 @@
 ### Proposed changes
 
-Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
-following format:
+[//]: # "Write a clear and concise description of what the pull request changes."
+[//]: # "You can use our Commit messages guidance for this."
+[//]: # "https://github.com/nginx/documentation/blob/main/documentation/git-conventions.md#commit-messages"
 
-Problem: Give a brief overview of the problem or feature being addressed.
+[//]: # "First, explain what was changed, and why. This should be most of the detail."
+[//]: # "Then how the changes were made, such as referring to existing styles and conventions."
+[//]: # "Finish by noting anything beyond the scope of the PR changes that may be affected."
 
-Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
-considerations.
+[//]: # "Include information on testing if relevant and non-obvious from the deployment preview."
+[//]: # "For expediency, you can use screenshots to show small before and after examples."
 
-Testing: Describe any testing that you did.
+[//]: # "If the changes were defined by a GitHub issue, reference it using keywords."
+[//]: # "https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests"
 
-Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
-specific feedback, add them here.
-
-If this PR addresses an [issue](https://github.com/nginx/documentation/issues) on GitHub, ensure that you link to it here:
-
-Closes #ISSUE
+[//]: # "Do not like to any internal, non-public resources. This includes internal repository issues or anything in an intranet."
+[//]: # "You can make reference to internal discussions without linking to them: see 'Referencing internal information'."
+[//]: # "https://github.com/nginx/documentation/blob/main/documentation/closed-contributions.md#referencing-internal-information"
 
 ### Checklist
 
-Before merging a pull request, run through this checklist and mark each as complete.
+Before sharing this pull request, I completed the following checklist:
 
-- [ ] I have read the [contributing guidelines](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md)
-- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)
-- [ ] I have rebased my branch onto main
-- [ ] I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
-- [ ] I have ensured that the commit messages adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
-- [ ] I have ensured that documentation content adheres to [the style guide](/documentation/style-guide.md)
-- [ ] If the change involves potentially sensitive changes[^1], I have assessed the possible impact
-- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
-- [ ] I have ensured that existing tests pass after adding my changes
-- [ ] If applicable, I have updated [`README.md`](/README.md)
+- [ ] I read the [Contributing guidelines](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md)
+- [ ] My branch adheres to the [Git conventions](https://github.com/nginx/documentation/blob/main/documentation/git-conventions.md)
+- [ ] My content changes adhere to the [F5 NGINX Documentation style guide](https://github.com/nginx/documentation/blob/main/documentation/style-guide.md)
+- [ ] If my changes involve potentially sensitive information[^1], I have assessed the possible impact
+- [ ] I have waited to ensure my changes pass tests, and addressed any discovered issues
 
-[^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.
+[^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/build-push.yml

@@ -101,6 +101,11 @@ jobs:
                     value: `${{ github.event.client_payload.author }}`,
                     short: true
                   },
+                  {
+                    title: 'Description',
+                    value: `${{ github.event.client_payload.description }}`,
+                    short: false
+                  },
                   {
                     title: 'Preview URL',
                     value: `${{ env.PREVIEW_URL }}`,

.github/workflows/ossf_scorecard.yml

@@ -56,6 +56,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: Upload SARIF results to code scanning
-        uses: github/codeql-action/upload-sarif@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
+        uses: github/codeql-action/upload-sarif@51f77329afa6477de8c49fc9c7046c15b9a4e79d # v3.29.5
         with:
           sarif_file: results.sarif

CONTRIBUTING.md

@@ -41,6 +41,7 @@ To understand how we use Git in this repository, read our [Git conventions](/doc
 The broad workflow is as follows:
 
 - Fork the NGINX repository
+  - If you're an F5/NGINX user, you can work from a clone
 - Create a branch
 - Implement your changes in your branch
 - Submit a pull request (PR) when your changes are ready for review

_banners/agent-v3-release.md

@@ -1,7 +1,8 @@
 {{< banner "notice" "NGINX Agent 3.0 is now available" >}}
 
+The documentation in this section is for **NGINX Agent version 2.x**. For NGINX Agent 3.x content visit the [NGINX One Console documentation]({{< ref "/nginx-one/agent/" >}})
 
-F5 NGINX Instance Manager (NIM) does not currently support Agent 3.x. NGINX Instance Manager customers can upgrade to the latest Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
+F5 NGINX Instance Manager (NIM) does not currently support NGINX Agent 3.x. NGINX Instance Manager customers can upgrade to the latest NGINX Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
 
 Please see the [Technical specifications](/nginx-agent/technical-specifications/) for product compatibility.
 

_banners/eos-acm.md

@@ -0,0 +1,8 @@
+{{< banner "warning" "End of Sale Notice:" >}}
+  <br>
+  F5 NGINX is announcing the <strong>End of Sale (EoS)</strong> for NGINX Management Suite API Connectivity Manager Module, <strong>effective January 1, 2024</strong>.
+  <br><br>
+  F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing API Connectivity Manager Module customers can continue to use the product past the EoS date. <strong>License renewals are not available after September 30, 2024.</strong>
+  <br><br>
+  See our <a href="https://my.f5.com/manage/s/article/K000137989">End of Sale announcement</a> for more details.
+{{</ banner >}}

_banners/eos-mesh.md

@@ -1,8 +1,8 @@
 {{< banner "warning" "End of Sale Notice:" >}}
-  <br>
-  F5 NGINX is announcing the <strong>End of Sale (EoS)</strong> for NGINX Management Suite API Connectivity Manager Module, <strong>effective January 1, 2024</strong>.
-  <br><br>
-  F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing API Connectivity Manager Module customers can continue to use the product past the EoS date. <strong>License renewals are not available after September 30, 2024.</strong>
-  <br><br>
-  See our <a href="https://my.f5.com/manage/s/article/K000137989">End of Sale announcement</a> for more details.
+  <p>
+    Commercial support for NGINX Service Mesh is available to customers who currently have active NGINX Microservices Bundle subscriptions. F5 NGINX announced the End of Sale (EoS) for the NGINX Microservices Bundles as of <strong>July 1, 2023</strong>.
+  </p>
+  <p>
+    See our <a href="https://my.f5.com/manage/s/article/K000135468">End of Sale announcement</a> for more details.
+  </p>
 {{</ banner >}}

content/agent/_index.md

@@ -9,4 +9,50 @@ cascade:
     start-date: 2025-05-29
     end-date: 2025-09-09
     md: /_banners/agent-v3-release.md
+# The subtitle displays directly underneath the heading of a given page
+nd-subtitle:
+# Indicates that this is a custom landing page
+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:
+# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
+nd-product: Agent
 ---
+
+## About
+
+NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables remote management of NGINX
+configurations, collection and reporting of real-time NGINX performance and operating system metrics, and notifications of NGINX events.
+
+[//]: # "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."
+[//]: # "Name specific functionality it provides: avoid ambiguous descriptions such as 'enables efficiency', focus on what makes it unique."
+
+## Featured content
+[//]: # "You can add a maximum of three cards: any extra will not display."
+[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
+[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
+
+{{<card-layout>}}
+  {{<card-section showAsCards="true" isFeaturedSection="true">}}
+    {{<card title="About" titleUrl="/nginx-agent/about" icon="info">}}
+      Learn everything you need to know about NGINX Agent
+    {{</card>}}
+    <!-- The titleURL and icon are both optional -->
+    <!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
+    {{<card title="Getting started" titleUrl="/nginx-agent/installation-upgrade/getting-started" icon="unplug">}}
+      Install NGINX Agent and run a mock control plane
+    {{</card>}}
+  {{</card-section>}}
+{{</card-layout>}}
+
+{{<card-layout>}}
+  {{<card-section showAsCards="true" isFeaturedSection="true">}}
+    {{<card title="Upgrade" titleUrl="/nginx-agent/installation-upgrade/upgrade/" icon="circle-fading-arrow-up">}}
+    {{</card>}}
+    {{<card title="Configuration" titleUrl="/nginx-agent/configuration" icon="cog">}}
+    {{</card>}}
+    {{<card title="Support" titleUrl="/nginx-agent/support" icon="hand-helping">}}
+    {{</card>}}
+  {{</card-section>}}
+{{</card-layout>}}

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

@@ -116,7 +116,7 @@ docker run --name nginx-agent -d nginx-agent
 
 ### Enable the gRPC interface
 
-To connect your NGINX Agent container to your NGINX One or NGINX Instance Manager instance, you must enable the gRPC interface. To do this, you must edit the NGINX Agent configuration file, *nginx-agent.conf*. For example:
+To connect your NGINX Agent container to your NGINX One Console or NGINX Instance Manager instance, you must enable the gRPC interface. To do this, you must edit the NGINX Agent configuration file, *nginx-agent.conf*. For example:
 
 ```yaml
 server:

content/agent/installation-upgrade/installation-oss.md

@@ -50,10 +50,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     module_hotfixes=true
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo yum install nginx-agent
+    sudo yum install -y nginx-agent-2.42.0
     ```
 
     When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
@@ -105,11 +105,13 @@ Before you install NGINX Agent for the first time on your system, you need to se
       | sudo tee /etc/apt/sources.list.d/nginx-agent.list
     ```
 
-1. To install `nginx-agent`, run the following commands:
-
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
+   
+    Update your package index and install a specific version of the nginx-agent. Replace <VERSION_CODENAME> with your current Ubuntu codename (e.g., jammy, noble).
+   
     ```shell
     sudo apt update
-    sudo apt install nginx-agent
+    sudo apt install -y nginx-agent=2.42.0~<VERSION_CODENAME>
     ```
 
 1. Verify the installation:
@@ -166,12 +168,13 @@ Before you install NGINX Agent for the first time on your system, you need to se
       http://packages.nginx.org/nginx-agent/debian/ `lsb_release -cs` agent" \ | sudo tee /etc/apt/sources.list.d/nginx-agent.list
     ```
 
-1. To install `nginx-agent`, run the following commands:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
+    Update your package index and install a specific version of the nginx-agent. Replace <VERSION_CODENAME> with your current Debian codename (e.g., bullseye).
+    
     ```shell
     sudo apt update
-    sudo apt install nginx-agent
-    ```
+    sudo apt install -y nginx-agent=2.42.0~<VERSION_CODENAME>
 
 1. Verify the installation:
 
@@ -229,10 +232,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     sudo rpmkeys --import /tmp/nginx_signing.key
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo zypper install nginx-agent
+    sudo zypper install -y nginx-agent=2.42.0
     ```
 
 1. Verify the installation:
@@ -303,10 +306,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     sudo mv /tmp/nginx_signing.rsa.pub /etc/apk/keys/
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo apk add nginx-agent
+    sudo apk add nginx-agent=2.42.0
     ```
 
 1. Verify the installation:
@@ -334,10 +337,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     module_hotfixes=true
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo dnf install nginx-agent
+    sudo dnf install -y nginx-agent-2.42.0
     ```
 
 1. When prompted to accept the GPG key, verify that the fingerprint matches
@@ -370,10 +373,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     module_hotfixes=true
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo yum install nginx-agent
+    sudo yum install -y nginx-agent-2.42.0
     ```
 
 1. When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
@@ -396,10 +399,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     }
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo pkg install nginx-agent
+    sudo pkg install nginx-agent-2.42.0
     ```
 
 1. Verify the installation: