mirror of
https://github.com/keycloak/keycloak
synced 2025-05-12 21:19:45 +00:00
015f06b5b8
- refer mvnw instead of mvn - contributing.adoc reflects GitHub-Issues and new git-structure Closes #35373 Signed-off-by: Sebastian Rose <sebastian.rose@gmail.com> |
||
|---|---|---|
| .. | ||
| contributing.adoc | ||
| README.md | ||
| screenshots.adoc | ||
| styleguide.adoc | ||
| template_concept.adoc | ||
| template_reference.adoc | ||
| template_task_brief.adoc | ||
| template_task.adoc | ||
| terms_conventions.adoc | ||
| testing.adoc | ||
Keycloak Documentation Guidelines
This folder contains guidelines for writers.
Contributor's Guide
See our Contributor's Guide to learn the procedure for making contributions to documentation.
Templates
We have templates that we ask you to please use for your new content. When:
- I want to do X
- Use the brief task template. The detailed task template has a wealth of resources and tips that you may find useful.
- I want to understand X
- Use the Concept Template
- I want to know X
- Use the Reference Template
Styles
When writing content we use the IBM Style Guide.