Merge branch 'main' into nim-known-issues-updates

Author: travisamartin

.github/CODEOWNERS

@@ -29,6 +29,10 @@ content/nap-dos/*           @nginx/dos-docs-approvers
 content/nap-waf/*           @nginx/nap-docs-approvers
 data/nap-waf/*              @nginx/nap-docs-approvers
 
+# NGINXaaS for Azure 
+content/nginxaas-azure/*          @nginx/n4a-docs
+content/includes/nginxaas-azure/* @nginx/n4a-docs
+
 # NGINX Gateway Fabric
 content/ngf/*               @nginx/nginx-gateway-fabric
 content/includes/ngf/*      @nginx/nginx-gateway-fabric

.github/labeler.yml

@@ -0,0 +1,122 @@
+# Label PRs based on modified file paths (v5 format)
+# https://github.com/actions/labeler
+
+# General documentation
+
+documentation:
+  - changed-files:
+    - any-glob-to-any-file:
+      - 'content/**'
+      - 'assets/**'
+      - 'static/**'
+      - 'data/**'
+
+# Product labels
+
+product/agent:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/agent/**'
+          - 'content/includes/agent/**'
+
+product/amplify:
+  - changed-files:
+      - any-glob-to-any-file: 'content/amplify/**'
+
+product/controller:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/controller/**'
+          - 'content/includes/controller/**'
+
+product/mesh:
+  - changed-files:
+      - any-glob-to-any-file: 'content/mesh/**'
+
+product/modsec-waf:
+  - changed-files:
+      - any-glob-to-any-file: 'content/modsec-waf/**'
+
+product/nap-dos:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/nap-dos/**'
+          - 'content/includes/nap-dos/**'
+
+product/nap-waf:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/nap-waf/**'
+          - 'content/includes/nap-waf/**'
+
+product/ngf:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/ngf/**'
+          - 'content/includes/ngf/**'
+
+product/nginx-plus:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/nginx/**'
+          - 'content/includes/nginx-plus/**'
+
+product/nginx-one:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/nginx-one/**'
+          - 'content/includes/nginx-one/**'
+
+product/nginxaas:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/nginxaas-azure/**'
+          - 'content/includes/nginxaas-azure/**'
+
+product/nim:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/nim/**'
+          - 'content/includes/nim/**'
+
+product/nms:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/nms/**'
+          - 'content/includes/nms/**'
+
+product/unit:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'content/unit/**'
+          - 'content/includes/unit/**'
+
+# Other labels
+
+process documentation:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'templates/**'
+          - '*.md'
+          - 'LICENSE'
+
+tooling:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'layouts/**'
+          - '.github/**'
+          - '.cloudcannon/**'
+          - 'styles/**'
+          - 'layouts/**'
+          - 'config/**'
+          - 'archetypes/**'
+          - '*.yml'
+          - '*.yaml'
+          - '*.json'
+          - '*.ts'
+          - '*.sh'
+          - '*.js'
+          - 'Makefile'
+          - '.vale.ini'
+          - '.gitignore'
+          - '.gitattributes'

.github/workflows/labeler.yml

@@ -0,0 +1,17 @@
+name: PR Labeler
+
+on:
+- pull_request_target
+
+permissions:
+  contents: read  # Required to read the labeler.yml file
+  pull-requests: write  # Required to apply labels to PRs
+
+jobs:
+  label:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Apply labels based on file paths
+        uses: actions/labeler@v5
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/linkchecker.yml

@@ -104,7 +104,7 @@ jobs:
       # Run LinkChecker
       - name: Run LinkChecker on ${{ matrix.doc_paths }}
         continue-on-error: ${{ env.isProduction != 'true' }}
-        uses: nick-fields/retry@c97818ca39074beaea45180dba704f92496a0082 # v3.0.1
+        uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3.0.2
         with:
           timeout_minutes: 10
           max_attempts: 3

.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@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
+        uses: github/codeql-action/upload-sarif@6bb031afdd8eb862ea3fc1848194185e076637e5 # v3.28.11
         with:
           sarif_file: results.sarif

CONTRIBUTING_DOCS.md

@@ -64,7 +64,7 @@ We have templates for the following types of documentation:
 
 ## How to format docs
 
-### Basic markdown formatting
+### Basic Markdown formatting
 
 There are multiple ways to format text: for consistency and clarity, these are our conventions:
 
@@ -133,12 +133,14 @@ Supported callouts:
 - `caution`
 - `warning`
 
-You can also create custom callouts using the `call-out` shortcode `{{< call-out "type" "header" "font-awesome icon >}}`. For example:
+You can also create custom callouts using the `call-out` shortcode `{{< call-out "type position" "header" "font-awesome icon >}}`. For example:
 
 ```md
-{{<call-out "important" "JWT file required for upgrade" "fa fa-exclamation-triangle">}}
+{{<call-out "important side-callout" "JWT file required for upgrade" "fa fa-exclamation-triangle">}}
 ```
 
+By default, all custom callouts are included inline, unless you add `side-callout` which places the callout to the right of the content.
+
 Here are some other shortcodes:
 
 - `fa`: Inserts a Font Awesome icon
@@ -152,6 +154,25 @@ Here are some other shortcodes:
 - `readfile`: Include the content of another file in the current file, which can be in an arbitrary location.
 - `bootstrap-table`: formats a table using Bootstrap classes; accepts any bootstrap table classes as additional arguments, e.g. `{{< bootstrap-table "table-bordered table-hover" }}`
 
+### How to use Hugo includes
+
+As mentioned above, [Hugo includes](https://gohugo.io/contribute/documentation/#include) are a custom shortcode that allows you to reference reusable content stored in the [`/content/includes` directory](https://github.com/nginx/documentation/tree/main/content/includes).
+
+For example, if the [`controller/add-existing-instance.md`](https://github.com/nginx/documentation/blob/main/content/includes/controller/add-existing-instance.md) file contains instructions on adding an instance to the NGINX Controller, you can reuse it on multiple pages by adding:
+
+```md
+{{< include "controller/add-existing-instance.md" >}}
+```
+
+The `controller/add-existing-instance.md` file is included in the following pages on the NGINX Docs Site:
+
+- [Add an NGINX App Protect Instance](https://github.com/nginx/documentation/blob/main/content/controller/infrastructure/instances/add-nap-instance.md?plain=1#L35)
+- [Manage Your NGINX Instances](https://github.com/nginx/documentation/blob/main/content/controller/infrastructure/instances/manage-instances.md?plain=1#L29)
+- [Trial NGINX Controller with NGINX Plus](https://github.com/nginx/documentation/blob/main/content/controller/admin-guides/install/try-nginx-controller.md?plain=1#L277)
+- [Trial NGINX Controller with App Security](https://github.com/nginx/documentation/blob/main/content/controller/admin-guides/install/try-nginx-controller-app-sec.md?plain=1#L290)
+
+This ensures that content is defined once and referenced in multiple places without duplication.
+
 ## Linting
 
 To run the markdownlint check, run the following command, which uses the .markdownlint.yaml file to specify rules. For `<content>`, specify the path to your Markdown files:

archetypes/concept.md

@@ -10,8 +10,6 @@ type: concept
 # Intended for internal catalogue and search, case sensitive:
 # Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
 product:
-# Intended for internal catalogue
-docs: "DOCS-000"
 ---
 
 [//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
@@ -71,4 +69,4 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
 
 ## See also
 
-[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
+[//]: # "Link to related documents, such as concepts, reference material or similar use cases."

archetypes/default.md

@@ -10,8 +10,6 @@ type: how-to
 # Intended for internal catalogue and search, case sensitive:
 # Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
 product:
-# Intended for internal catalogue
-docs: "DOCS-000"
 ---
 
 [//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
@@ -87,4 +85,4 @@ To complete this guide, you will need the following prerequisites:
 
 ## See also
 
-[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
+[//]: # "Link to related documents, such as concepts, reference material or similar use cases."

archetypes/tutorial.md

@@ -10,8 +10,6 @@ type: tutorial
 # Intended for internal catalogue and search, case sensitive:
 # Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
 product:
-# Intended for internal catalogue
-docs: "DOCS-000"
 ---
 
 [//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
@@ -119,4 +117,4 @@ To verify the creation of <component>, you can also inspect information about it
 
 ## See also
 
-[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
+[//]: # "Link to related documents, such as concepts, reference material or similar use cases."

content/includes/nap-waf/config/common/anti-automation.md

@@ -131,7 +131,7 @@ This is a list of the trusted bots that are currently part of the bot signatures
 |MojeekBot | [Mojeek search engine](https://www.mojeek.com/) |
 |Yahoo! Slurp | [Yahoo search engine](https://www.yahoo.com/) |
 |Yandex | [Yandex search engine](https://yandex.com/) |
-|YioopBot | [Yioop search engine](https://www.yioop.com/) |
+|YioopBot | Yioop search engine |
 {{</bootstrap-table>}}