Merge branch 'main' into patch-13

Author: ADubhlaoich

.github/workflows/build-push.yml

@@ -1,5 +1,7 @@
 name: Build and deploy (docs)
 on:
+  repository_dispatch:
+    types: [trigger-preview-build]
   workflow_call:
     inputs:
       environment:
@@ -31,22 +33,22 @@ on:
         type: string
   pull_request:
     branches:
-      - "*"
+      - "**"
   push:
     branches:
       - "main"
 
 env:
   FRONT_DOOR_USERNAME: ${{ secrets.FRONT_DOOR_USERNAME }}
   FRONT_DOOR_PASSWORD: ${{ secrets.FRONT_DOOR_PASSWORD }}
-  GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}     
+  GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}    
 jobs:
   prod-check-branch:
     runs-on: ubuntu-24.04
     steps:
       - name: Output variables
         run: |
-          echo "Environment: ${{ inputs.environment }}"
+          echo "Environment: ${{ inputs.environment || github.event.client_payload.environment }}"
           echo "Branch: ${{ github.ref }}"
       - name: Checks to see that main branch is selected if deploying to prod
         if: ${{ inputs.environment == 'prod' && github.ref != 'refs/heads/main' }}
@@ -63,14 +65,33 @@ jobs:
       docs_source_path: "public"
       docs_build_path: "./"
       doc_type: "hugo"
-      environment: ${{inputs.environment}}
+      environment: ${{ inputs.environment || github.event.client_payload.environment }}
       force_hugo_theme_version: ${{inputs.hugo_theme_override}}
       auto_deploy_branch: "main"
       auto_deploy_env: "prod"
     secrets:
       AZURE_CREDENTIALS: ${{secrets.AZURE_CREDENTIALS_DOCS}}
       AZURE_KEY_VAULT: ${{secrets.AZURE_KEY_VAULT_DOCS}}
 
+  trigger-theme-slack-notification:
+    if: github.event_name == 'repository_dispatch'
+    needs: call-docs-build-push
+    runs-on: ubuntu-latest
+    permissions: read-all
+    steps:
+      - name: Trigger 'Slack notification for new theme release' workflow in 'nginx-hugo-theme' repo.
+        run: |
+           curl -L \
+              -X POST \
+              -H "Accept: application/vnd.github+json" \
+              -H "Authorization: Bearer ${{ secrets.THEME_SLACK_FLOW_PAT }}" \
+              -H "X-GitHub-Api-Version: 2022-11-28" \
+              "https://api.github.com/repos/${{ secrets.OWNER }}/${{ secrets.REPO }}/dispatches" \
+              -d "{\"event_type\": \"trigger-slack-notification\", \"client_payload\": {\"previewURL\": \"${{ env.PREVIEW_URL }}\",  \"author\": \"${{ github.event.client_payload.author}}\", \"tag_name\": \"${{ github.event.client_payload.tag_name }}\", \"release_name\": \"${{ github.event.client_payload.release_name }}\"}}"
+    env:
+      PREVIEW_URL: ${{ needs.call-docs-build-push.outputs.PREVIEW_URL }}
+
+
   lighthouseci:
     if: github.event.pull_request
     needs: call-docs-build-push

.github/workflows/ossf_scorecard.yml

@@ -34,7 +34,7 @@ jobs:
           persist-credentials: false
 
       - name: Run analysis
-        uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
+        uses: ossf/scorecard-action@05b42c624433fc40578a4040d5cf5e36ddca8cde # v2.4.2
         with:
           results_file: results.sarif
           results_format: sarif
@@ -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@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
+        uses: github/codeql-action/upload-sarif@fca7ace96b7d713c7035871441bd52efbe39e27e # v3.28.19
         with:
           sarif_file: results.sarif

CLOSED_CONTRIBUTIONS.md

@@ -33,7 +33,7 @@ To create closed content, add the closed repository as a remote to the main repo
 ```shell
 cd documentation
 git remote add internal [email protected]:<closed-url>.git
-git fetch
+git fetch --all
 ```
 
 Check out the remote `main` branch, and use it to create a feature branch. **Ensure that you prefix all branch names with `internal/`**
@@ -64,4 +64,4 @@ git merge internal/internal/feature
 git push origin
 ```
 
-Once the content changes have been merged in the open repository, they will synchronize back to the closed repository.
+Once the content changes have been merged in the open repository, they will synchronize back to the closed repository.

_banners/agent-v3-release.md

@@ -0,0 +1,9 @@
+{{< banner "notice" "NGINX Agent 3.0 is now available" >}}
+
+
+F5 NGINX One Console does not currently support Agent 3.x. If you are using NGINX One Console in your environment, upgrade to the latest 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.
+
+
+{{< /banner >}}

_banners/eos-cltr.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 Controller Application Delivery 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 NGINX Controller Application Delivery 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/K000137993">End of Sale announcement</a> for more details
+{{</ banner >}}

_banners/eos-mesh.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/ngf-2.0-release.md

@@ -0,0 +1,7 @@
+{{< banner "notice" "NGINX Gateway Fabric 2.0 is now available" >}}
+
+NGINX Gateway Fabric 2.0 has released! Follow [these instructions]({{< ref "/ngf/install/upgrade-version.md#upgrade-from-v1x-to-v2x" >}}) to upgrade from 1.x to 2.0.
+
+For 1.x, checkout [an older version]({{< ref "/ngf/install/upgrade-version.md#access-nginx-gateway-fabric-1x-documentation" >}}) of documentation.
+
+{{< /banner >}}

_banners/upgrade-r33.md

@@ -0,0 +1,5 @@
+{{< banner "caution" "NGINX Plus R33 requires NGINX Instance Manager 2.18 or later" >}}
+  If your NGINX data plane instances are running NGINX Plus R33 or later, you must upgrade to NGINX Instance Manager 2.18 or later to support usage reporting. NGINX Plus R33 instances must report usage data to the F5 licensing endpoint or NGINX Instance Manager. Otherwise, they will stop processing traffic. 
+  <br><br>
+  For more details about usage reporting and enforcement, see [About solution licenses]({{< ref "/solutions/about-subscription-licenses.md" >}})
+{{</ banner >}}

archetypes/concept.md

@@ -22,15 +22,11 @@ This guide provides an overview of <concept>, which is used <for/in> <action 1>,
 
 It is an example of a <other concept>, and is closely related to <third concept>.
 
----
-
 ## Background
 
 [//]: # "Explain what the concept is. If possible, relate it to another commonly known concept or software."
 [//]: # "This relates the new idea to the reader using their existing knowledge, helping their understanding of it and thus what its purpose is in context."
 
----
-
 ## Use cases
 
 [//]: # "Name the individual use case sections after the actual use case itself, e.g 'Route traffic between applications'"
@@ -56,7 +52,6 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
 
 ### Use case 2
 
----
 
 ## Conclusion
 
@@ -65,8 +60,6 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
 [//]: # "Since each use case provides links to additional documents, you may not need to link to more,"
 [//]: # "or even include the final 'See also' section."
 
----
-
 ## See also
 
-[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
+[//]: # "Link to related documents, such as reference material or task instructions."

archetypes/default.md

@@ -20,8 +20,6 @@ nd-product:
 
 This guide explains how to <X> with <Y>. In involves the use of <A>, <B> and <C>, demonstrating how <X> works with an example <Z>.
 
----
-
 ## Before you begin
 
 [//]: # "List everything someone will need installed or configured before it's required. Link directly to installation guides where possible."
@@ -34,8 +32,6 @@ To complete this guide, you will need the following prerequisites:
 
 [//]: # "Note the style of link for requirement two: keep the markdown extension. Links are resolved from the root of the documentation folder, often /site."
 
----
-
 ## Step 1
 
 [//]: # "Explain the initial step: this is usually creating or configuring a resource. Sub-steps may not be necessary, depending on complexity."
@@ -51,38 +47,29 @@ To complete this guide, you will need the following prerequisites:
 
 [//]: # "Sub-steps are ways of breaking steps into even smaller sections. Each step or sub-step should focus on one thing at a time: a user should be able to stop at the end of section and come back afterwards without leaving their software in a non-functional state."
 
----
-
 ### Sub-step 2
 
 [//]: # "A useful final sub-step for a given section is some kind of verification or testing, so the reader is confident the steps have been successful."
 
----
-
 ## Step 2
 
 [//]: # "Explain any additional steps required. If the how-to guide involves multiple components, each component can have its own step for delineation."
 
 ### Sub-step 1
 
----
 
 ### Sub-step 2
 
----
 
 ## Step 3
 
 [//]: # "The final step of a how-to guide is usually a final test, and summarizes all of the previous steps taken to accomplish the purpose of the guide."
 
 ### Sub-step 1
 
----
 
 ### Sub-step 2
 
----
-
-## See also
+## Next steps
 
-[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
+[//]: # "Link to the most common use cases after this specific instruction. For example. configuration usually follows installation."