diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 4dc411da..518f794c 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -23,4 +23,4 @@ jobs:
restore-keys: |
mkdocs-material-
- run: pip install -r requirements.txt
- - run: mkdocs gh-deploy --force
+ - run: mkdocs gh-deploy --force # TODO: add -s (strict) switch
diff --git a/docs/index.md b/docs/index.md
index d76b6f06..65eb6135 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -31,11 +31,11 @@ In the multi-cluster environment[^2], you can utilize Kuadrant to manage DNS-bas
## Component Documentation
-* [Kuadrant Operator](/kuadrant-operator)
+* [Kuadrant Operator](kuadrant-operator/README.md)
Install and manage the lifecycle of the Kuadrant deployments and core Kuadrant policies for the data plane.
-* [Authorino](/authorino)
+* [Authorino](authorino/README.md)
Flexible, cloud-native, and lightweight external authorization server to implement identity verification (Kubernetes TokenReview, OIDC, OAuth2, API key, mTLS) and authorization policy rules (Kuberentes SubjectAccessReview, JWT claims, OPA, request pattern-matching, resource metadata, RBAC, ReBAC, ABAC, etc).
-* [Limitador](/limitador)
+* [Limitador](limitador/README.md)
Fast rate-limiter implemented in Rust, that can be used as a library, or as a service plugged in to the API gateway.
-* [Multicluster Gateway Controller](/multicluster-gateway-controller)
+* [Multicluster Gateway Controller](multicluster-gateway-controller/README.md)
Manage multi-cluster gateways, integrate with DNS providers, TLS providers and OCM (Open Cluster Management).
diff --git a/mkdocs.yml b/mkdocs.yml
index 2448f168..f75d2adf 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -11,7 +11,7 @@ theme:
extra_css:
- assets/stylesheets/extra.css
watch:
- - overrides
+ - overrides
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
@@ -23,8 +23,8 @@ markdown_extensions:
- attr_list
- md_in_html
- pymdownx.emoji:
- emoji_index: !!python/name:materialx.emoji.twemoji
- emoji_generator: !!python/name:materialx.emoji.to_svg
+ emoji_index: !!python/name:material.extensions.emoji.twemoji
+ emoji_generator: !!python/name:material.extensions.emoji.to_svg
- footnotes
plugins:
- search
@@ -33,22 +33,23 @@ plugins:
keep_docs_dir: true
nav_repos:
- name: kuadrant-operator
- import_url: 'https://github.com/kuadrant/kuadrant-operator?edit_uri=/blob/main/&branch=v0.6.0'
+ import_url: 'https://github.com/jasonmadigan/kuadrant-operator?edit_uri=/blob/main/&branch=fix-links'
imports:
- /README.md
- /doc/*
- name: authorino
- import_url: 'https://github.com/kuadrant/authorino?edit_uri=/blob/main/&branch=v0.16.0'
+ import_url: 'https://github.com/jasonmadigan/authorino?edit_uri=/blob/main/&branch=fix-links'
imports:
- /README.md
- /docs/*
- /docs/user-guides/*
+ - /install/crd/*
- name: authorino-operator
import_url: 'https://github.com/kuadrant/authorino-operator?edit_uri=/blob/main/&branch=v0.10.0'
imports:
- /README.md
- name: limitador
- import_url: 'https://github.com/kuadrant/limitador?edit_uri=/blob/main/&branch=v1.3.0'
+ import_url: 'https://github.com/jasonmadigan/limitador?edit_uri=/blob/main/&branch=fix-links'
imports:
- /README.md
- /doc/*
@@ -56,18 +57,20 @@ plugins:
- /limitador-server/docs/*
- /limitador/README.md
- /limitador-server/kubernetes/*
+ - /limitador-server/sandbox/*
+ - /LICENSE
- name: limitador-operator
- import_url: 'https://github.com/kuadrant/limitador-operator?edit_uri=/blob/main/&branch=v0.7.0'
+ import_url: 'https://github.com/jasonmadigan/limitador-operator?edit_uri=/blob/main/&branch=fix-links'
imports:
- /README.md
- /doc/*
- name: multicluster-gateway-controller
- import_url: 'https://github.com/kuadrant/multicluster-gateway-controller?edit_uri=/blob/main/&branch=release-0.3'
+ import_url: 'https://github.com/jasonmadigan/multicluster-gateway-controller?edit_uri=/blob/main/&branch=fix-links'
imports:
- /README.md
- /docs/*
- name: architecture
- import_url: 'https://github.com/kuadrant/architecture?edit_uri=/blob/main/&branch=main'
+ import_url: 'https://github.com/jasonmadigan/architecture?edit_uri=/blob/main/&branch=fix-links'
imports:
- /rfcs/*
- /docs/*
@@ -159,7 +162,11 @@ nav:
- 'RFC 0006: Configuration of Kuadrant Sub Components': architecture/rfcs/0006-kuadrant_sub_components_configurations.md
- 'RFC 0007: Policy Sync': architecture/rfcs/0007-policy-sync-v1.md
- 'Multicluster Gateway Controller':
- - 'Multiple DNS Provider Support': multicluster-gateway-controller/docs/proposals/multiple-dns-provider-support.md
+ - 'Multiple DNS Provider Support':
+ - 'Overview': multicluster-gateway-controller/docs/proposals/multiple-dns-provider-support.md
+ - 'Google DNS': multicluster-gateway-controller/docs/proposals/assets/multiple-dns-provider-support/google/google.md
+ - 'AWS DNS': multicluster-gateway-controller/docs/proposals/assets/multiple-dns-provider-support/aws/aws.md
+ - 'Azure DNS': multicluster-gateway-controller/docs/proposals/assets/multiple-dns-provider-support/azure/azure.md
- 'Aggregation of Status Conditions': multicluster-gateway-controller/docs/proposals/status-aggregation.md
- 'Components':
- 'Kuadrant Operator':
@@ -184,7 +191,7 @@ nav:
- 'Server':
- 'Overview': limitador/limitador-server/README.md
- 'Kubernetes': limitador/limitador-server/kubernetes/README.md
- - 'Sandbox': limitador/limitador-server/docs/sandbox.md
+ - 'Sandbox': limitador/limitador-server/sandbox/README.md
- 'Crate': limitador/limitador/README.md
- 'Limitador Operator':
- 'Overview': limitador-operator/README.md
diff --git a/requirements.txt b/requirements.txt
index c3045089..c95e3fea 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,2 +1,2 @@
-mkdocs-multirepo-plugin==0.6.1
-mkdocs-material==9.1.17
\ No newline at end of file
+mkdocs-multirepo-plugin==0.7.0
+mkdocs-material==9.5.6
\ No newline at end of file