Merge pull request #114 from Boomatang/maintenance/docs

Maintenance/docs

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:
 

doc/development.md

@@ -1,23 +1,5 @@
 # Development Guide
 
-<!--ts-->
-   * [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)
-
-<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-
-<!--te-->
-
 ## Technology stack required for development
 
 * [operator-sdk] version v1.28.1

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`

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.