Skip to content

Commit

Permalink
Move CONTRIBUTING out
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 21, 2025
1 parent f0d2a7a commit fcaf0a6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
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.
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,7 @@ This repository contains documentation for Kuadrant, built using MkDocs and the

## Contributing

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.

When writing content, refer to the [./style_guide.md](./style_guide.md) for writing style guidelines, tips and examples.
See [./CONTRIBUTING.md](./CONTRIBUTING.md)

## Using Docker/Podman

Expand Down

0 comments on commit fcaf0a6

Please sign in to comment.