History

Marc Wrobel 33baeefeab Fix minor typos in the 'Release Notes' guide (#1705 )		2022-10-19 08:50:08 +02:00
..
contributing.adoc	Update main branch name in Contributor's Guide (#1345 )	2022-01-03 13:30:44 +01:00
README.md	couple more edits	2017-11-15 07:47:34 -06:00
screenshots.adoc	Upload screenshot guidelines	2017-03-30 11:42:45 -05:00
styleguide.adoc	Fix typos and improve readability (#381 )	2018-05-29 10:02:18 +02:00
template_concept.adoc
template_reference.adoc	Fix minor typos in the 'Release Notes' guide (#1705 )	2022-10-19 08:50:08 +02:00
template_task.adoc
template_task_brief.adoc
terms_conventions.adoc	Update terms_conventions.adoc	2017-03-30 15:39:49 -05:00
testing.adoc	Fix typos and improve readability (#381 )	2018-05-29 10:02:18 +02:00

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.

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

When writing content we use the IBM Style Guide.