Kuadrant / kuadrantctl

Kuadrant configuration command line utility
Apache License 2.0
6 stars 12 forks source link

Reference docs: OAS Resource generation - kuadrantctl #52

Closed jasonmadigan closed 4 months ago

jasonmadigan commented 5 months ago

What

Create some detailed reference docs for kuadrantctl commands & functionality, covering general usage but also OAS/GWAPI resource generation.

How

Some existing guides can be used / extended to flesh this content out:

https://github.com/Kuadrant/kuadrantctl/blob/main/doc/generate-gateway-api-httproute.md https://github.com/Kuadrant/kuadrantctl/blob/main/doc/generate-kuadrant-auth-policy.md https://github.com/Kuadrant/kuadrantctl/blob/main/doc/generate-kuadrant-rate-limit-policy.md https://github.com/Kuadrant/kuadrantctl/blob/main/doc/openapi-kuadrant-extensions.md

Seperately, we'll build out tutorials for usage of kuadrantctl - this issue is only concerned with reference docs for kuadrantctl:

https://github.com/Kuadrant/kuadrantctl/issues/53 https://github.com/Kuadrant/docs.kuadrant.io/issues/63]

jasonmadigan commented 4 months ago

Related: https://github.com/Kuadrant/kuadrantctl/pull/54