From 10f0f503ce4f2ba6c6be7aa32e7e33279e367d94 Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Wed, 21 Feb 2024 15:48:41 +0000 Subject: [PATCH 1/2] chore: add catalog entry numbers. fix dupes. --- docs/content/community.md | 4 ++-- docs/content/glossary.md | 3 ++- docs/content/includes/installation/create-common-resources.md | 2 +- docs/content/includes/installation/create-custom-resources.md | 4 ++++ docs/content/includes/installation/deploy-controller.md | 2 +- docs/content/includes/installation/manifests/daemonset.md | 2 +- docs/content/includes/installation/manifests/deployment.md | 2 +- .../installation/manifests/verify-pods-are-running.md | 2 +- docs/content/includes/rbac/set-up-rbac.md | 2 +- docs/content/installation/ingress-nginx.md | 2 +- .../installation/nic-images/using-gcp-marketplace-package.md | 4 ++-- .../nic-images/using-the-jwt-token-docker-secret.md | 3 ++- docs/content/troubleshooting/troubleshoot-common.md | 1 + docs/content/troubleshooting/troubleshoot-configmap-policy.md | 3 ++- docs/content/troubleshooting/troubleshoot-ingress.md | 3 ++- docs/content/troubleshooting/troubleshoot-virtualserver.md | 3 ++- .../troubleshooting/troubleshooting-app-protect-dos.md | 3 ++- .../troubleshooting/troubleshooting-app-protect-waf.md | 3 ++- docs/content/tutorials/ingress-path-regex-annotation.md | 3 ++- docs/content/tutorials/nginx-ingress-linkerd.md | 3 ++- docs/content/tutorials/oidc-custom-configuration.md | 3 ++- .../tutorials/virtual-server-with-custom-listener-ports.md | 3 ++- docs/content/usage-reporting.md | 3 ++- 23 files changed, 40 insertions(+), 23 deletions(-) diff --git a/docs/content/community.md b/docs/content/community.md index 4d357575e7..28c3e0f7d8 100644 --- a/docs/content/community.md +++ b/docs/content/community.md @@ -1,10 +1,10 @@ --- -title: Community and Contribution +title: "Community and Contribution" description: "Learn about the NGINX Ingress Controller community and contribute to the project." weight: 2200 toc: true -docs: "DOCS-584" +docs: "DOCS-1447" --- diff --git a/docs/content/glossary.md b/docs/content/glossary.md index c9ca266b26..d620b29853 100644 --- a/docs/content/glossary.md +++ b/docs/content/glossary.md @@ -1,10 +1,11 @@ --- -title: Glossary +title: "Glossary" description: weight: 10000 menu: docs: parent: NGINX Ingress Controller +docs: "DOCS-1446" --- {{}} diff --git a/docs/content/includes/installation/create-common-resources.md b/docs/content/includes/installation/create-common-resources.md index b22e876303..a04537c5a7 100644 --- a/docs/content/includes/installation/create-common-resources.md +++ b/docs/content/includes/installation/create-common-resources.md @@ -1,5 +1,5 @@ --- -docs: +docs: "DOCS-1464" --- In this section, you'll create resources that most NGINX Ingress Controller installations require: diff --git a/docs/content/includes/installation/create-custom-resources.md b/docs/content/includes/installation/create-custom-resources.md index 20dbf6c54f..23c611a96b 100644 --- a/docs/content/includes/installation/create-custom-resources.md +++ b/docs/content/includes/installation/create-custom-resources.md @@ -1,3 +1,7 @@ +--- +docs: "DOCS-1463" +--- + To make sure your NGINX Ingress Controller pods reach the `Ready` state, you'll need to create custom resource definitions (CRDs) for various components. Alternatively, you can disable this requirement by setting the `-enable-custom-resources` command-line argument to `false`. diff --git a/docs/content/includes/installation/deploy-controller.md b/docs/content/includes/installation/deploy-controller.md index d1d86c3260..fd9cb652c2 100644 --- a/docs/content/includes/installation/deploy-controller.md +++ b/docs/content/includes/installation/deploy-controller.md @@ -1,5 +1,5 @@ --- -docs: +docs: "DOCS-1462" --- You have two options for deploying NGINX Ingress Controller: diff --git a/docs/content/includes/installation/manifests/daemonset.md b/docs/content/includes/installation/manifests/daemonset.md index 4fafb434b3..ca14008149 100644 --- a/docs/content/includes/installation/manifests/daemonset.md +++ b/docs/content/includes/installation/manifests/daemonset.md @@ -1,5 +1,5 @@ --- -docs: +docs: "DOCS-1465" --- For additional context on managing containers using Kubernetes DaemonSets, refer to the official Kubernetes [DaemonSets](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) documentation. diff --git a/docs/content/includes/installation/manifests/deployment.md b/docs/content/includes/installation/manifests/deployment.md index 9a56ab7dc5..6dd305e299 100644 --- a/docs/content/includes/installation/manifests/deployment.md +++ b/docs/content/includes/installation/manifests/deployment.md @@ -1,5 +1,5 @@ --- -docs: +docs: "DOCS-1467" --- For additional context on managing containers using Kubernetes Deployments, refer to the official Kubernetes [Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) documentation. diff --git a/docs/content/includes/installation/manifests/verify-pods-are-running.md b/docs/content/includes/installation/manifests/verify-pods-are-running.md index e3edf4e1f5..24ab04fa56 100644 --- a/docs/content/includes/installation/manifests/verify-pods-are-running.md +++ b/docs/content/includes/installation/manifests/verify-pods-are-running.md @@ -1,5 +1,5 @@ --- -docs: +docs: "DOCS-1466" --- To confirm the NGINX Ingress Controller pods are operational, run: diff --git a/docs/content/includes/rbac/set-up-rbac.md b/docs/content/includes/rbac/set-up-rbac.md index 2a0e156ba1..4a41b4107e 100644 --- a/docs/content/includes/rbac/set-up-rbac.md +++ b/docs/content/includes/rbac/set-up-rbac.md @@ -1,5 +1,5 @@ --- -docs: +docs: "DOCS-1468" --- {{}}To complete these steps you need admin access to your cluster. Refer to to your Kubernetes platform's documentation to set up admin access. For Google Kubernetes Engine (GKE), you can refer to their [Role-Based Access Control guide](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).{{}} diff --git a/docs/content/installation/ingress-nginx.md b/docs/content/installation/ingress-nginx.md index 8501f2b82f..21d40bdce8 100644 --- a/docs/content/installation/ingress-nginx.md +++ b/docs/content/installation/ingress-nginx.md @@ -5,7 +5,7 @@ description: "This document describes how to migrate from the community-maintain weight: 500 toc: true tags: [ "docs" ] -docs: "DOCS-000" +docs: "DOCS-1469" categories: ["installation", "platform management"] doctypes: ["tutorial"] journeys: ["getting started"] diff --git a/docs/content/installation/nic-images/using-gcp-marketplace-package.md b/docs/content/installation/nic-images/using-gcp-marketplace-package.md index 3f61dd40b2..26eeae8e5d 100644 --- a/docs/content/installation/nic-images/using-gcp-marketplace-package.md +++ b/docs/content/installation/nic-images/using-gcp-marketplace-package.md @@ -1,10 +1,10 @@ --- -title: Using the GCP Marketplace NGINX Ingress Controller Image +title: "Using the GCP Marketplace NGINX Ingress Controller Image" description: "Follow these steps to deploy F5 NGINX Ingress Controller through the GCP Marketplace." weight: 300 doctypes: [""] toc: true -docs: "DOCS-000" +docs: "DOCS-1455" --- ## Overview diff --git a/docs/content/installation/nic-images/using-the-jwt-token-docker-secret.md b/docs/content/installation/nic-images/using-the-jwt-token-docker-secret.md index fbf21a9da8..5463317803 100644 --- a/docs/content/installation/nic-images/using-the-jwt-token-docker-secret.md +++ b/docs/content/installation/nic-images/using-the-jwt-token-docker-secret.md @@ -1,9 +1,10 @@ --- -title: Getting the NGINX Ingress Controller Image with JWT +title: "Getting the NGINX Ingress Controller Image with JWT" description: "Use your NGINX Ingress Controller subscription JWT token to get the NGINX Plus Ingress Controller image from the F5 Docker registry." weight: 150 doctypes: [""] toc: true +docs: "DOCS-1454" --- {{}} diff --git a/docs/content/troubleshooting/troubleshoot-common.md b/docs/content/troubleshooting/troubleshoot-common.md index 516676f0c4..31da191261 100644 --- a/docs/content/troubleshooting/troubleshoot-common.md +++ b/docs/content/troubleshooting/troubleshoot-common.md @@ -9,6 +9,7 @@ tags: [ "docs" ] doctypes: ["troubleshooting"] aliases: - /content/troubleshooting/troubleshoot-ingress-controller +docs: "DOCS-1459" --- ## Common Problems diff --git a/docs/content/troubleshooting/troubleshoot-configmap-policy.md b/docs/content/troubleshooting/troubleshoot-configmap-policy.md index 7c48f544c7..841635ee82 100644 --- a/docs/content/troubleshooting/troubleshoot-configmap-policy.md +++ b/docs/content/troubleshooting/troubleshoot-configmap-policy.md @@ -1,9 +1,10 @@ --- -title: Troubleshooting Policy Resources +title: "Troubleshooting Policy Resources" description: "This page describes how to troubleshoot NGINX Ingress Controller Policy Resources." weight: 200 doctypes: [""] toc: true +docs: "DOCS-1457" --- ## Policy Resources diff --git a/docs/content/troubleshooting/troubleshoot-ingress.md b/docs/content/troubleshooting/troubleshoot-ingress.md index fb4b49e451..d4007ea3b5 100644 --- a/docs/content/troubleshooting/troubleshoot-ingress.md +++ b/docs/content/troubleshooting/troubleshoot-ingress.md @@ -1,9 +1,10 @@ --- -title: Troubleshooting Ingress Resources +title: "Troubleshooting Ingress Resources" description: "This page describes how to troubleshoot NGINX Ingress Controller Policy Resources." weight: 300 doctypes: [""] toc: true +docs: "DOCS-1458" --- ## Ingress Resources diff --git a/docs/content/troubleshooting/troubleshoot-virtualserver.md b/docs/content/troubleshooting/troubleshoot-virtualserver.md index a1fedb40ca..31cfe6b913 100644 --- a/docs/content/troubleshooting/troubleshoot-virtualserver.md +++ b/docs/content/troubleshooting/troubleshoot-virtualserver.md @@ -1,11 +1,12 @@ --- -title: Troubleshooting VirtualServer Resources +title: "Troubleshooting VirtualServer Resources" description: "This page describes how to troubleshoot VirtualServer and VirtualServer Resource Events." weight: 500 doctypes: [""] toc: true aliases: - /content/troubleshooting/virtualserver-virtualserverroute +docs: "DOCS-1461" --- ## Inspecting VirtualServer and VirtualServerRoute Resource Events diff --git a/docs/content/troubleshooting/troubleshooting-app-protect-dos.md b/docs/content/troubleshooting/troubleshooting-app-protect-dos.md index f4a26f595a..51afa5eca6 100644 --- a/docs/content/troubleshooting/troubleshooting-app-protect-dos.md +++ b/docs/content/troubleshooting/troubleshooting-app-protect-dos.md @@ -1,9 +1,10 @@ --- -title: Troubleshooting with NGINX App Protect DoS +title: "Troubleshooting with NGINX App Protect DoS" description: "This document describes how to troubleshoot problems when using NGINX Ingress Controller and the App Protect DoS module." weight: 600 doctypes: [""] toc: true +docs: "DOCS-1456" aliases: - /content/troubleshooting/troubleshooting-with-app-protect-dos --- diff --git a/docs/content/troubleshooting/troubleshooting-app-protect-waf.md b/docs/content/troubleshooting/troubleshooting-app-protect-waf.md index 3066b3936e..085cfc8e9b 100644 --- a/docs/content/troubleshooting/troubleshooting-app-protect-waf.md +++ b/docs/content/troubleshooting/troubleshooting-app-protect-waf.md @@ -1,7 +1,8 @@ --- -title: Troubleshooting with NGINX App Protect WAF +title: "Troubleshooting with NGINX App Protect WAF" description: "This document describes how to troubleshoot problems when using NGINX Ingress Controller and the NGINX App Protect WAF module." weight: 700 +docs: "DOCS-1460" doctypes: [""] toc: true aliases: diff --git a/docs/content/tutorials/ingress-path-regex-annotation.md b/docs/content/tutorials/ingress-path-regex-annotation.md index 4b951fdc6c..2867ee033c 100644 --- a/docs/content/tutorials/ingress-path-regex-annotation.md +++ b/docs/content/tutorials/ingress-path-regex-annotation.md @@ -1,5 +1,6 @@ --- -title: Ingresses Path Matching Using Path-Regex Annotation +title: "Ingresses Path Matching Using Path-Regex Annotation" +docs: "DOCS-1451" description: | How to customize Ingress and Mergeable Ingress types with path-regex annotations. weight: 1800 diff --git a/docs/content/tutorials/nginx-ingress-linkerd.md b/docs/content/tutorials/nginx-ingress-linkerd.md index 3237319732..135462ebbf 100644 --- a/docs/content/tutorials/nginx-ingress-linkerd.md +++ b/docs/content/tutorials/nginx-ingress-linkerd.md @@ -1,8 +1,9 @@ --- -title: NGINX Ingress Controller and Linkerd +title: "NGINX Ingress Controller and Linkerd" description: | Using Linkerd with the F5 NGINX Ingress Controller. weight: 1800 +docs: "DOCS-1450" doctypes: ["concept"] toc: true --- diff --git a/docs/content/tutorials/oidc-custom-configuration.md b/docs/content/tutorials/oidc-custom-configuration.md index fade9f31ed..2b8c417638 100644 --- a/docs/content/tutorials/oidc-custom-configuration.md +++ b/docs/content/tutorials/oidc-custom-configuration.md @@ -1,5 +1,5 @@ --- -title: Customize OIDC Configuration with NGINX Ingress Controller +title: "Customize OIDC Configuration with NGINX Ingress Controller" description: | How to Customize the default OIDC Configuration with NGINX Ingress Controller weight: 1800 @@ -48,6 +48,7 @@ Annotations: Data ==== oidc.conf: +docs: "DOCS-1448" ---- # Advanced configuration START set $internal_error_message "NGINX / OpenID Connect login failure\n"; diff --git a/docs/content/tutorials/virtual-server-with-custom-listener-ports.md b/docs/content/tutorials/virtual-server-with-custom-listener-ports.md index 9c9d569eb6..3310f769fd 100644 --- a/docs/content/tutorials/virtual-server-with-custom-listener-ports.md +++ b/docs/content/tutorials/virtual-server-with-custom-listener-ports.md @@ -1,10 +1,11 @@ --- -title: Configuring VirtualServer with custom HTTP and HTTPS listener ports +title: "Configuring VirtualServer with custom HTTP and HTTPS listener ports" description: | This tutorial outlines how to configure and deploy a VirtualServer resource with custom HTTP and HTTPS listener ports. weight: 1800 doctypes: ["concept"] toc: true +docs: "DOCS-1452" --- ## Configuring a VirtualServer with custom HTTP and HTTPS listener ports. diff --git a/docs/content/usage-reporting.md b/docs/content/usage-reporting.md index 1220835dbc..ddc164c6b1 100644 --- a/docs/content/usage-reporting.md +++ b/docs/content/usage-reporting.md @@ -1,9 +1,10 @@ --- -title: Enabling Usage Reporting +title: "Enabling Usage Reporting" description: "This page outlines how to enable Usage Reporting for the NGINX Ingress Controller and how to view the usage data through the API." weight: 1800 doctypes: ["concept"] toc: true +docs: "DOCS-1445" --- ## Overview From 0913edf0946cdfa9def16b3ba53a70f202ac0ec5 Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Wed, 21 Feb 2024 16:24:55 +0000 Subject: [PATCH 2/2] chore: add 2 missing docs --- docs/content/installation/building-nginx-ingress-controller.md | 3 ++- docs/content/tutorials/custom-listen-ports.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/content/installation/building-nginx-ingress-controller.md b/docs/content/installation/building-nginx-ingress-controller.md index de453282c4..8af52a6d53 100644 --- a/docs/content/installation/building-nginx-ingress-controller.md +++ b/docs/content/installation/building-nginx-ingress-controller.md @@ -1,9 +1,10 @@ --- -title: Building NGINX Ingress Controller +title: "Building NGINX Ingress Controller" description: "Learn how to build an NGINX Ingress Controller image from source codes and upload it to a private Docker registry. You'll also find information on the Makefile targets and variables." weight: 200 doctypes: ["installation"] toc: true +docs: "DOCS-1453" --- {{}} diff --git a/docs/content/tutorials/custom-listen-ports.md b/docs/content/tutorials/custom-listen-ports.md index 0b9e421235..b8137ec09e 100644 --- a/docs/content/tutorials/custom-listen-ports.md +++ b/docs/content/tutorials/custom-listen-ports.md @@ -1,10 +1,11 @@ --- -title: Customizing NGINX Ingress Controller Ports +title: "Customizing NGINX Ingress Controller Ports" description: | How to customize F5 NGINX Ingress Controller ports. weight: 1800 doctypes: ["concept"] toc: true +docs: "DOCS-1449" --- ## Customizing NGINX Ingress Controller Ports