From fd41dfc71a81341a043cb25275472920b3f0e3dc Mon Sep 17 00:00:00 2001 From: R-Lawton Date: Tue, 26 Nov 2024 15:47:37 +0000 Subject: [PATCH] WIP --- mkdocs.yml | 54 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 30 insertions(+), 24 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 5f704e18..56890579 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: Kuadrant Documentation site_url: https://docs.kuadrant.io/ -repo_url: https://github.com/R-Lawton/docs.kuadrant.io +repo_url: https://github.com/kuadrant/docs.kuadrant.io edit_uri: edit/main/docs/ extra: version: @@ -65,18 +65,18 @@ plugins: - /config/samples/* - /examples/* - name: authorino - import_url: "https://github.com/R-Lawton/authorino?edit_uri=/blob/main/&branch=doc-updates" + import_url: "https://github.com/kuadrant/authorino?edit_uri=/blob/main/&branch=main" imports: - /README.md - /docs/* - /docs/user-guides/* - /install/crd/* - name: authorino-operator - import_url: "https://github.com/R-Lawton/authorino-operator?edit_uri=/blob/main/&branch=doc-updates" + import_url: "https://github.com/kuadrant/authorino-operator?edit_uri=/blob/main/&branch=main" imports: - /README.md - name: limitador - import_url: "https://github.com/R-Lawton/limitador?edit_uri=/blob/main/&branch=doc-updates" + import_url: "https://github.com/kuadrant/limitador?edit_uri=/blob/main/&branch=main" imports: - /README.md - /doc/* @@ -87,27 +87,27 @@ plugins: - /limitador-server/sandbox/* - /LICENSE - name: limitador-operator - import_url: "https://github.com/R-Lawton/limitador-operator?edit_uri=/blob/main/&branch=doc-updates" + import_url: "https://github.com/kuadrant/limitador-operator?edit_uri=/blob/main/&branch=main" imports: - /README.md - /doc/* - name: architecture - import_url: "https://github.com/R-Lawton/architecture?edit_uri=/blob/main/&branch=doc-updates" + import_url: "https://github.com/kuadrant/architecture?edit_uri=/blob/main/&branch=main" imports: - /rfcs/* - /docs/* - name: api-quickstart - import_url: "https://github.com/R-Lawton/api-quickstart?edit_uri=/blob/main/&branch=doc-updates" + import_url: "https://github.com/kuadrant/api-quickstart?edit_uri=/blob/main/&branch=main" imports: - /README.md - /images/* - name: kuadrantctl - import_url: "https://github.com/R-Lawton/kuadrantctl?edit_uri=/blob/main/&branch=doc-updates" + import_url: "https://github.com/kuadrant/kuadrantctl?edit_uri=/blob/main/&branch=main" imports: - /README.md - /doc/* - name: dns-operator - import_url: "https://github.com/R-Lawton/dns-operator?edit_uri=/blob/main/&branch=doc-updates" + import_url: "https://github.com/kuadrant/dns-operator?edit_uri=/blob/main/&branch=main" imports: - /README.md - /docs/* @@ -122,31 +122,36 @@ nav: - "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/dns.md + - "Overview": kuadrant-operator/doc/overviews/dns.md - "Reference": kuadrant-operator/doc/reference/dnspolicy.md - "TLSPolicy": - - "Overview": kuadrant-operator/doc/tls.md + - "Overview": kuadrant-operator/doc/overviews/tls.md - "Reference": kuadrant-operator/doc/reference/tlspolicy.md - "AuthPolicy": - - "Overview": kuadrant-operator/doc/auth.md + - "Overview": kuadrant-operator/doc/overviews/auth.md - "Reference": kuadrant-operator/doc/reference/authpolicy.md - "RateLimitPolicy": - - "Overview": kuadrant-operator/doc/rate-limiting.md + - "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/secure-protect-connect.md - - "OpenShift": kuadrant-operator/doc/user-guides/secure-protect-connect-single-multi-cluster.md + - "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 - "DNS configuration": - - "Gateway DNS for Cluster Operators": kuadrant-operator/doc/user-guides/gateway-dns.md + - "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 - "TLS configuration": - - "Gateway TLS for Cluster Operators": kuadrant-operator/doc/user-guides/gateway-tls.md + - "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-for-app-devs-and-platform-engineers.md + - "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 @@ -179,8 +184,8 @@ nav: - "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-developers.md - - kuadrant-operator/doc/user-guides/authenticated-rl-with-jwt-and-k8s-authnz.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": - "Metrics": kuadrant-operator/doc/observability/metrics.md - "Dashboards and Alerts": kuadrant-operator/doc/observability/examples.md @@ -202,7 +207,8 @@ 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/R-Lawton/docs.kuadrant.io - - "Authorino": https://github.com/R-Lawton/docs.kuadrant.io - - "Limitador": https://github.com/R-Lawton/docs.kuadrant.io - - "kuadrantctl": https://github.com/R-Lawton/docs.kuadrant.io + - "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 +