-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: David Martin <[email protected]>
- Loading branch information
1 parent
f0d2a7a
commit fcaf0a6
Showing
2 changed files
with
14 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
The site configuration and navigation layout are defined in [./mkdocs.yml](./mkdocs.yml). | ||
The navigation sections follow the [Diátaxis framework](https://diataxis.fr/), with four main areas: | ||
|
||
- Concepts (known as 'Explanation' in Diátaxis) | ||
- APIs & Reference | ||
- Tutorials | ||
- Guides | ||
|
||
When adding new documentation, take a moment to consider which area the document belongs to. | ||
You can use the [Diátaxis compass](https://diataxis.fr/compass/) to help answer that question. | ||
If you are unsure, raise an issue, create a PR anyways to invite discussion, or reach out on the [#kuadrant](https://kubernetes.slack.com/archives/C05J0D0V525) slack channel. | ||
|
||
When writing content, refer to the [./style_guide.md](./style_guide.md) for writing style guidelines, tips and examples. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters