update with new link paths

Signed-off-by: R-Lawton <[email protected]>
Kuadrant · Dec 5, 2024 · c06ae3a · c06ae3a
1 parent 7393024
commit c06ae3a
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 60 deletions.
diff --git a/docs/getting-started-multi-cluster.md b/docs/getting-started-multi-cluster.md
@@ -37,4 +37,4 @@ To ensure that any DNS records are removed, you should remove any `DNSPolicy` an
 
 The next step is to setup and use the policies provided by Kuadrant. 
 
-[Secure, Protect and Connect your Gateway](kuadrant-operator/doc/user-guides/secure-protect-connect.md)
+[Secure, Protect and Connect your Gateway](kuadrant-operator/doc/user-guides/full-walkthrough/secure-protect-connect-k8s.md)
diff --git a/docs/getting-started-single-cluster.md b/docs/getting-started-single-cluster.md
@@ -72,6 +72,6 @@ To ensure that any DNS records are removed, you should remove any `DNSPolicy` an
 
 The next step is to setup and use the policies provided by Kuadrant. 
 
-[Secure, Protect and Connect your Gateway](kuadrant-operator/doc/user-guides/secure-protect-connect.md)
+[Secure, Protect and Connect your Gateway](kuadrant-operator/doc/user-guides/full-walkthrough/secure-protect-connect-k8s.md)
 
 
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
 # Overview
 
-Kuadrant combines [Gateway API](https://gateway-api.sigs.k8s.io/) and [Istio](https://istio.io/latest/docs/tasks/traffic-management/ingress/gateway-api/)-based gateway controllers to enhance application connectivity. It enables platform engineers and application developers to easily connect, secure, and protect their services and infrastructure across multiple clusters with policies for [TLS](kuadrant-operator/doc/tls.md), [DNS](kuadrant-operator/doc/reference/dnspolicy.md), application [authentication & authorization](kuadrant-operator/doc/auth.md), and [rate limiting](kuadrant-operator/doc/rate-limiting.md). Additionally, Kuadrant offers [observability templates](kuadrant-operator/doc/observability/examples.md) to further support infrastructure management.
+Kuadrant combines [Gateway API](https://gateway-api.sigs.k8s.io/) and [Istio](https://istio.io/latest/docs/tasks/traffic-management/ingress/gateway-api/)-based gateway controllers to enhance application connectivity. It enables platform engineers and application developers to easily connect, secure, and protect their services and infrastructure across multiple clusters with policies for [TLS](kuadrant-operator/doc/overviews/tls.md), [DNS](kuadrant-operator/doc/reference/dnspolicy.md), application [authentication & authorization](kuadrant-operator/doc/overviews/auth.md), and [rate limiting](kuadrant-operator/doc/overviews/rate-limiting.md). Additionally, Kuadrant offers [observability templates](kuadrant-operator/doc/observability/examples.md) to further support infrastructure management.
 
 <iframe width="100%" height="400" src="https://www.youtube.com/embed/euWAMvQojP4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -58,7 +58,7 @@ plugins:
       keep_docs_dir: true
       nav_repos:
         - name: kuadrant-operator
-          import_url: 'https://github.com/R-Lawton/kuadrant-operator?edit_uri=/blob/main/&branch=doc-updates'
+          import_url: 'https://github.com/kuadrant/kuadrant-operator?edit_uri=/blob/main/&branch=main'
           imports:
             - /README.md
             - /doc/*
@@ -113,20 +113,20 @@ plugins:
             - /docs/*
             - /config/samples/*
 nav:
-  - 'Introduction':
-      - 'Overview': index.md
-      - 'Architecture': architecture/docs/design/architectural-overview-v1.md
+  - 'Overview': index.md
   - 'Getting Started':
       - 'Single-Cluster': getting-started-single-cluster.md
       - 'Multi-Cluster': getting-started-multi-cluster.md
+  - 'Architecture': architecture/docs/design/architectural-overview-v1.md
   - 'Installation':
       - 'Kubernetes': kuadrant-operator/doc/install/install-kubernetes.md
       - 'OpenShift': kuadrant-operator/doc/install/install-openshift.md
-      - 'From Source': kuadrant-operator/doc/install/install-make.md
   - 'Concepts and APIs':
       - 'DNSPolicy':
           - 'Overview': kuadrant-operator/doc/overviews/dns.md
           - 'Reference': kuadrant-operator/doc/reference/dnspolicy.md
+          - 'Gateway DNS for ingress Gateway': kuadrant-operator/doc/user-guides/dns/gateway-dns.md
+          - 'Configuring DNS Providers': dns-operator/docs/provider.md
       - 'TLSPolicy':
           - 'Overview': kuadrant-operator/doc/overviews/tls.md
           - 'Reference': kuadrant-operator/doc/reference/tlspolicy.md
@@ -137,56 +137,19 @@ nav:
           - 'Overview': kuadrant-operator/doc/overviews/rate-limiting.md
           - 'Reference': kuadrant-operator/doc/reference/ratelimitpolicy.md
   - 'How-to Guides':
-      - 'Secure, connect and protect (Full Walkthrough)':
-          - 'Kubernetes': kuadrant-operator/doc/user-guides/full-walkthrough/secure-protect-connect-k8s.md
-          - 'OpenShift': kuadrant-operator/doc/user-guides/full-walkthrough/secure-protect-connect-openshift.md
+      - 'Secure, connect and protect - Kubernetes': kuadrant-operator/doc/user-guides/full-walkthrough/secure-protect-connect-k8s.md
+      - 'Secure, connect and protect - OpenShift': kuadrant-operator/doc/user-guides/full-walkthrough/secure-protect-connect-openshift.md
       - 'DNS configuration':
-          - 'Gateway DNS for Cluster Operators': kuadrant-operator/doc/user-guides/dns/gateway-dns.md
-          - 'Configuring DNS Providers': dns-operator/docs/provider.md
-          - 'Basic DNS configuration': kuadrant-operator/doc/user-guides/dns/basic-dns-configuration.md
-          - 'DNS health checks': kuadrant-operator/doc/user-guides/dns/dnshealthchecks.md
-          - 'Orphaned DNS Records': kuadrant-operator/doc/user-guides/dns/orphaned-dns-records.md
-          - 'DNS excluding specific addresses': kuadrant-operator/doc/user-guides/dns/dns-excluding-specific-addresses.md
+          - 'DNS Providers': dns-operator/docs/provider.md
       - 'TLS configuration':
           - 'Gateway TLS for Cluster Operators': kuadrant-operator/doc/user-guides/tls/gateway-tls.md
-      - 'Authentication & Authorization configuration':
-          - 'Authentication':
-              - 'AuthPolicy for Application Developers and Platform Engineers': kuadrant-operator/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md
-              - 'Authentication with Kubernetes tokens (TokenReview API)': authorino/docs/user-guides/kubernetes-tokenreview.md
-              - 'Authentication with API keys': authorino/docs/user-guides/api-key-authentication.md
-              - 'Authentication with X.509 certificates and mTLS': authorino/docs/user-guides/mtls-authentication.md
-              - 'Authentication with HTTP "Basic"': authorino/docs/user-guides/http-basic-authentication.md
-              - 'Edge Authentication Architecture (EAA)': authorino/docs/user-guides/edge-authentication-architecture-festival-wristbands.md
-              - 'OIDC':
-                  - 'OpenID Connect Discovery and authentication with JWTs': authorino/docs/user-guides/oidc-jwt-authentication.md
-                  - 'OpenID Connect UserInfo': authorino/docs/user-guides/oidc-user-info.md
-                  - 'OpenID Connect (OIDC) and Role-Based Access Control (RBAC) with Keycloak': authorino/docs/user-guides/oidc-rbac.md
-          - 'Authorization':
-              - 'Passing credentials (`Authorization` header, cookie headers and others)': authorino/docs/user-guides/passing-credentials.md
-              - 'Resource-level authorization with User-Managed Access (UMA) resource registry': authorino/docs/user-guides/resource-level-authorization-uma.md
-              - 'Authorization with Keycloak Authorization Services': authorino/docs/user-guides/keycloak-authorization-services.md
-              - 'Simple pattern-matching authorization policies': authorino/docs/user-guides/json-pattern-matching-authorization.md
-              - 'Kubernetes RBAC for service authorization (SubjectAccessReview API)': authorino/docs/user-guides/kubernetes-subjectaccessreview.md
-              - 'Setting up Kuadrant authorization service as a Validating Webhook': authorino/docs/user-guides/validating-webhook.md
-              - 'OPA Rego':
-                  - 'Open Policy Agent (OPA) Rego policies': authorino/docs/user-guides/opa-authorization.md
-              - 'Envoy':
-                  - 'Emitting Envoy Dynamic Metadata': authorino/docs/user-guides/authenticated-rate-limiting-envoy-dynamic-metadata.md
-                  - 'Reusing Envoy built-in authentication filter result': authorino/docs/user-guides/envoy-jwt-authn-and-authorino.md
-          - 'Authorization Infrastructure and Management':
-              - 'Anonymous access': authorino/docs/user-guides/anonymous-access.md
-              - 'Token normalization': authorino/docs/user-guides/token-normalization.md
-              - 'Fetching auth metadata from external sources': authorino/docs/user-guides/external-metadata.md
-              - 'Integration with Authzed/SpiceDB': authorino/docs/user-guides/authzed.md
-              - 'Injecting data in the request': authorino/docs/user-guides/injecting-data.md
-              - 'Redirecting to a login page': authorino/docs/user-guides/deny-with-redirect-to-login.md
-              - 'Caching': authorino/docs/user-guides/caching.md
-              - 'OAuth 2.0 token introspection (RFC 7662)': authorino/docs/user-guides/oauth2-token-introspection.md
-      - 'Rate Limiting configuration':
-          - 'RateLimitPolicy for Platform Engineers': kuadrant-operator/doc/user-guides/gateway-rl-for-cluster-operators.md
-          - 'Authenticated Rate Limiting for Application Developers': kuadrant-operator/doc/user-guides/authenticated-rl-for-app.md
-          - 'Authenticated Rate Limiting with JWTs and Kubernetes RBAC': kuadrant-operator/doc/user-guides/authenticated-rl-with-jwt-and-k8s-authnz.md
-      - 'Observability configuration':
+      - 'Authentication & Authorization':
+          - 'AuthPolicy for Application Developers and Platform Engineers': kuadrant-operator/doc/user-guides/auth/auth-for-app-devs-and-platform-engineers.md
+      - 'Rate Limiting':
+          - 'RateLimitPolicy for Platform Engineers': kuadrant-operator/doc/user-guides/ratelimiting/gateway-rl-for-cluster-operators.md
+          - 'Authenticated Rate Limiting for Application Developers': kuadrant-operator/doc/user-guides/ratelimiting/authenticated-rl-for-app-developers.md
+          - kuadrant-operator/doc/user-guides/ratelimiting/authenticated-rl-with-jwt-and-k8s-authnz.md
+      - 'Observability':
           - 'Metrics': kuadrant-operator/doc/observability/metrics.md
           - 'Dashboards and Alerts': kuadrant-operator/doc/observability/examples.md
           - 'Tracing': kuadrant-operator/doc/observability/tracing.md
@@ -207,8 +170,69 @@ nav:
           - 'RFC 0010: Gateway API Metrics Exporter': architecture/rfcs/0010-gateway-api-metrics-exporter.md
           - 'RFC 0011: Policy Machinery for reconciliation': architecture/rfcs/0011-policy-machinery.md
   - 'Components':
-      - 'Kuadrant Operator': https://github.com/kuadrant/docs.kuadrant.io
-      - 'Authorino': https://github.com/kuadrant/docs.kuadrant.io
-      - 'Limitador': https://github.com/kuadrant/docs.kuadrant.io
-      - 'kuadrantctl': https://github.com/kuadrant/docs.kuadrant.io
-
+      - 'Kuadrant Operator':
+          - 'Overview': kuadrant-operator/README.md
+          - "Developer's Guide": kuadrant-operator/doc/overviews/development.md
+          - kuadrant-operator/doc/overviews/logging.md
+      - 'Authorino':
+          - 'Overview': authorino/README.md
+          - 'Authorino Operator': authorino-operator/README.md
+          - 'Getting Started': authorino/docs/getting-started.md
+          - 'Hello World': authorino/docs/user-guides/hello-world.md
+          - 'User Guides':
+            - 'Authentication with Kubernetes tokens (TokenReview API)': authorino/docs/user-guides/kubernetes-tokenreview.md
+            - 'Authentication with API keys': authorino/docs/user-guides/api-key-authentication.md
+            - 'Authentication with X.509 certificates and mTLS': authorino/docs/user-guides/mtls-authentication.md
+            - 'OpenID Connect Discovery and authentication with JWTs': authorino/docs/user-guides/oidc-jwt-authentication.md
+            - 'OAuth 2.0 token introspection (RFC 7662)': authorino/docs/user-guides/oauth2-token-introspection.md
+            - 'Passing credentials (`Authorization` header, cookie headers and others)': authorino/docs/user-guides/passing-credentials.md
+            - 'HTTP "Basic" Authentication (RFC 7235)': authorino/docs/user-guides/http-basic-authentication.md
+            - 'Anonymous access': authorino/docs/user-guides/anonymous-access.md
+            - 'Token normalization': authorino/docs/user-guides/token-normalization.md
+            - 'Edge Authentication Architecture (EAA)': authorino/docs/user-guides/edge-authentication-architecture-festival-wristbands.md
+            - 'Fetching auth metadata from external sources': authorino/docs/user-guides/external-metadata.md
+            - 'OpenID Connect UserInfo': authorino/docs/user-guides/oidc-user-info.md
+            - 'Resource-level authorization with User-Managed Access (UMA) resource registry': authorino/docs/user-guides/resource-level-authorization-uma.md
+            - 'Simple pattern-matching authorization policies': authorino/docs/user-guides/json-pattern-matching-authorization.md
+            - 'OpenID Connect (OIDC) and Role-Based Access Control (RBAC) with Keycloak': authorino/docs/user-guides/oidc-rbac.md
+            - 'Open Policy Agent (OPA) Rego policies': authorino/docs/user-guides/opa-authorization.md
+            - 'Kubernetes RBAC for service authorization (SubjectAccessReview API)': authorino/docs/user-guides/kubernetes-subjectaccessreview.md
+            - 'Authorization with Keycloak Authorization Services': authorino/docs/user-guides/keycloak-authorization-services.md
+            - 'Integration with Authzed/SpiceDB': authorino/docs/user-guides/authzed.md
+            - 'Injecting data in the request': authorino/docs/user-guides/injecting-data.md
+            - 'Emitting Envoy Dynamic Metadata': authorino/docs/user-guides/authenticated-rate-limiting-envoy-dynamic-metadata.md
+            - 'Redirecting to a login page': authorino/docs/user-guides/deny-with-redirect-to-login.md
+            - 'Reusing Envoy built-in authentication filter result': authorino/docs/user-guides/envoy-jwt-authn-and-authorino.md
+            - 'Setting up Kuadrant authorization service as a Validating Webhook': authorino/docs/user-guides/validating-webhook.md
+            - 'Caching': authorino/docs/user-guides/caching.md
+          - 'Architecture': authorino/docs/architecture.md
+          - 'Reference': authorino/docs/features.md
+          - 'Advanced features':
+              - 'Host override via context extension': authorino/docs/user-guides/host-override.md
+              - 'Reducing the operational space: sharding, noise and multi-tenancy': authorino/docs/user-guides/sharding.md
+          - "Developer's Guide": authorino/docs/contributing.md
+      - 'Limitador':
+          - 'Overview': limitador/README.md
+          - 'How it works': limitador/doc/how-it-works.md
+          - 'Topologies': limitador/doc/topologies.md
+          - 'Server':
+              - 'Overview': limitador/limitador-server/README.md
+              - 'Kubernetes': limitador/limitador-server/kubernetes/README.md
+              - 'Sandbox': limitador/limitador-server/sandbox/README.md
+          - 'Crate': limitador/limitador/README.md
+          - 'Limitador Operator':
+              - 'Overview': limitador-operator/README.md
+              - 'Storage': limitador-operator/doc/storage.md
+              - 'Rate limit headers': limitador-operator/doc/rate-limit-headers.md
+              - "Developer's Guide": limitador-operator/doc/development.md
+              - limitador-operator/doc/logging.md
+          - 'DNS Operator':
+              - 'Overview': dns-operator/README.md
+      - 'kuadrantctl':
+          - 'Getting Started': kuadrantctl/README.md
+          - 'Generating Gateway API HTTPRoutes': kuadrantctl/doc/generate-gateway-api-httproute.md
+          - 'Generating Kuadrant AuthPolicies': kuadrantctl/doc/generate-kuadrant-auth-policy.md
+          - 'Generating Kuadrant RateLimitPolicies': kuadrantctl/doc/generate-kuadrant-rate-limit-policy.md
+          - 'CI/CD with kuadrantctl & Tekton': kuadrantctl/doc/kuadrantctl-ci-cd.md
+          - 'Using Apicurio Studio with Kuadrant OAS extensions': kuadrantctl/doc/openapi-apicurio.md
+          - 'Using OpenShift Dev Spaces with Kuadrant OAS extensions': kuadrantctl/doc/openapi-openshift-dev-spaces.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ To ensure that any DNS records are removed, you should remove any `DNSPolicy` an

		The next step is to setup and use the policies provided by Kuadrant.

		[Secure, Protect and Connect your Gateway](kuadrant-operator/doc/user-guides/secure-protect-connect.md)
		[Secure, Protect and Connect your Gateway](kuadrant-operator/doc/user-guides/full-walkthrough/secure-protect-connect-k8s.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -72,6 +72,6 @@ To ensure that any DNS records are removed, you should remove any `DNSPolicy` an

		The next step is to setup and use the policies provided by Kuadrant.

		[Secure, Protect and Connect your Gateway](kuadrant-operator/doc/user-guides/secure-protect-connect.md)
		[Secure, Protect and Connect your Gateway](kuadrant-operator/doc/user-guides/full-walkthrough/secure-protect-connect-k8s.md)