From 4b7fad418313d9849b510bf9ef7a78ba7385974c Mon Sep 17 00:00:00 2001 From: Jim Fitzpatrick Date: Wed, 8 Nov 2023 09:43:55 +0000 Subject: [PATCH 1/4] docs maintenance All updates are to fix issue found when renedered with mkdocs on docs.kuadrant.io --- doc/logging.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/logging.md b/doc/logging.md index 9cb43c4b..d2260b1d 100644 --- a/doc/logging.md +++ b/doc/logging.md @@ -1,6 +1,7 @@ # Logging The limitador operator outputs 3 levels of log messages: (from lowest to highest level) + 1. `debug` 2. `info` (default) 3. `error` From e8af58a66a698de85d5c891905964c6105fa1c68 Mon Sep 17 00:00:00 2001 From: Jim Fitzpatrick Date: Wed, 8 Nov 2023 09:54:29 +0000 Subject: [PATCH 2/4] Remove table of contents The table has being removed to favour the table of contents that is generated by mkdocs on docs.kuadrant.io --- doc/development.md | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/doc/development.md b/doc/development.md index 738d912c..19eb7b6f 100644 --- a/doc/development.md +++ b/doc/development.md @@ -1,23 +1,5 @@ # Development Guide - - * [Technology stack required for development](#technology-stack-required-for-development) - * [Build](#build) - * [Run locally](#run-locally) - * [Deploy the operator in a deployment object](#deploy-the-operator-in-a-deployment-object) - * [Deploy the operator using OLM](#deploy-the-operator-using-olm) - * [Build custom OLM catalog](#build-custom-olm-catalog) - * [Build operator bundle image](#build-operator-bundle-image) - * [Build custom catalog](#build-custom-catalog) - * [Cleaning up](#cleaning-up) - * [Run tests](#run-tests) - * [Lint tests](#lint-tests) - * [(Un)Install Limitador CRD](#uninstall-limitador-crd) - - - - - ## Technology stack required for development * [operator-sdk] version v1.28.1 From 97e26efd9468998f8da0282a48015fcfbe1815ac Mon Sep 17 00:00:00 2001 From: Jim Fitzpatrick Date: Wed, 8 Nov 2023 10:05:27 +0000 Subject: [PATCH 3/4] fix list render --- doc/rate-limit-headers.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/rate-limit-headers.md b/doc/rate-limit-headers.md index 1fbf2b0c..06e89f86 100644 --- a/doc/rate-limit-headers.md +++ b/doc/rate-limit-headers.md @@ -13,8 +13,10 @@ spec: ``` Current valid values are: -* *DRAFT_VERSION_03* (ref: https://datatracker.ietf.org/doc/id/draft-polli-ratelimit-headers-03.html) -* *NONE* + +- *DRAFT_VERSION_03* (ref: +[Rate Limit Headers Draft](https://datatracker.ietf.org/doc/id/draft-polli-ratelimit-headers-03.html)) +- *NONE* By default, when `spec.rateLimitHeaders` is *null*, `--rate-limit-headers` command line arg is not included in the limitador's deployment. From ebad553786e801aea96f73df7c7a95154548526a Mon Sep 17 00:00:00 2001 From: Jim Fitzpatrick Date: Wed, 8 Nov 2023 10:44:39 +0000 Subject: [PATCH 4/4] Updating links for display on docs.kuadrant.io --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ce773ef..b36aa6db 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ The Operator to manage [Limitador](https://github.com/Kuadrant/limitador) deploy ### Limitador CRD -[Limitador v1alpha1 API reference](./api/v1alpha1/limitador_types.go) +[Limitador v1alpha1 API reference](https://github.com/Kuadrant/limitador-operator/tree/main/api/v1alpha1/limitador_types.go) Example: