History

Matthew Helmke e027742a95 Added a couple of details to contrib guide		2017-12-19 10:39:02 +01:00
..
contributing.adoc	Added a couple of details to contrib guide	2017-12-19 10:39:02 +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	cleaned up existing styleguide file and fixed a minor format issue in the contributing file	2017-11-15 09:45:26 -06:00
template_concept.adoc	Upload templates	2017-03-30 11:41:55 -05:00
template_reference.adoc	Upload templates	2017-03-30 11:41:55 -05:00
template_task.adoc	Upload templates	2017-03-30 11:41:55 -05:00
template_task_brief.adoc	Upload templates	2017-03-30 11:41:55 -05:00
terms_conventions.adoc	Update terms_conventions.adoc	2017-03-30 15:39:49 -05:00
testing.adoc	KEYCLOAK-5404 Add testing	2017-09-07 14:09:11 +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.