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

Jump to bottom

Sub Component Configuration Documentation #306

Open
4 tasks
Boomatang opened this issue Nov 16, 2023 · 0 comments
Open
4 tasks

Sub Component Configuration Documentation #306

Boomatang opened this issue Nov 16, 2023 · 0 comments
Labels
area/doc Improvements or additions to documentation

Comments

@Boomatang
Copy link
Contributor

A new section is required on docs.kuadrant.io in the Concepts and APIs section to define the Kuadrant CR. This should have at least an Overview and Reference documents created. The Overview should describe what the Kuadrant CR is used for, and what kinds of configuration set ups can be done using it. While the Reference doc should go into detail of all the fields in the Kuadrant CR spec.

Bonus points for adding how-to guides.

Must Haves

  • links work on GitHub
  • links work on docs site
  • page renders are correct on GitHub
  • page renders are correct on docs site
@Boomatang Boomatang mentioned this issue Nov 16, 2023
Open
5 tasks
@Boomatang Boomatang added the area/doc Improvements or additions to documentation label Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/doc Improvements or additions to documentation
Projects
Kuadrant
Status: No status
Kuadrant Service Protection
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Boomatang