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.

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

Reference docs: OAS Resource generation - kuadrantctl #52

Closed
2 tasks
jasonmadigan opened this issue Feb 14, 2024 · 1 comment
Closed
2 tasks

Reference docs: OAS Resource generation - kuadrantctl #52

jasonmadigan opened this issue Feb 14, 2024 · 1 comment
Assignees

Comments

@jasonmadigan
Copy link
Member

jasonmadigan commented Feb 14, 2024

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

  • Create a new sub-section beneath the components nav on docs.kuadrant.io for kuadrantctl
  • Link to the above guides as reference material and extend as we see fit

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

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

@jasonmadigan jasonmadigan moved this to Todo in Kuadrant Feb 14, 2024
@jasonmadigan jasonmadigan changed the title OAS Resource generation - kuadrantctl docs OAS Resource generation - kuadrantctl Reference docs Feb 14, 2024
@jasonmadigan jasonmadigan changed the title OAS Resource generation - kuadrantctl Reference docs Reference docs: OAS Resource generation - kuadrantctl Feb 27, 2024
@jasonmadigan jasonmadigan self-assigned this Feb 27, 2024
@jasonmadigan jasonmadigan moved this from Todo to In Progress in Kuadrant Feb 27, 2024
@jasonmadigan
Copy link
Member Author

Related: #54

@jasonmadigan jasonmadigan moved this from In Progress to Ready For Review in Kuadrant Mar 1, 2024
@jasonmadigan jasonmadigan moved this from Ready For Review to Done in Kuadrant Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

1 participant