Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maintenance/docs #114

Merged
merged 4 commits into from
Nov 20, 2023
Merged

Maintenance/docs #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4b7fad4
docs maintenance
Boomatang Nov 8, 2023
e8af58a
Remove table of contents
Boomatang Nov 8, 2023
97e26ef
fix list render
Boomatang Nov 8, 2023
ebad553
Updating links for display on docs.kuadrant.io
Boomatang Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
18 changes: 0 additions & 18 deletions doc/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,5 @@
# Development Guide

<!--ts-->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why remove the TOC? 😢

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are generated automatically already in the docs website and by Github.

Screenshot 2023-11-10 at 15 13 00 Screenshot 2023-11-10 at 15 15 01

* [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
Expand Down
1 change: 1 addition & 0 deletions doc/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`
Expand Down
6 changes: 4 additions & 2 deletions doc/rate-limit-headers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading