Skip to content

Commit

Permalink
Add explanation of docs structure
Browse files Browse the repository at this point in the history
Signed-off-by: David Martin <[email protected]>
  • Loading branch information
david-martin committed Jan 15, 2025
1 parent e9dfa7a commit 64fe4c5
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ To use Kuadrant, the `LoadBalancer` service type is required for Gateways. kind

* [Install with Helm](./install-helm.md)
* [Install with OLM](./install-olm.md)

## Further Reading

The documentation on this site follows the [Diátaxis framework](https://diataxis.fr/) to better serve you, our users.
This approach also helps us create new content and maintain existing material effectively.
Under this framework, all content falls into one of four categories, accessible from the side navigation:

* Concepts - (also called 'Explanations') Deepens and broadens your understanding of Kuadrant.
* APIs & Reference - Provides concise descriptions of Kuadrant APIs for quick consultation.
* Tutorials - Offers practical, step-by-step activities for you to safely try out.
* Guides - Delivers goal-oriented instructions to help you solve specific problems in any environment.

0 comments on commit 64fe4c5

Please sign in to comment.