History

Matthew Helmke 6ce9676d68 Update docs/documentation/internal_resources/contributing.adoc Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>		2023-06-02 07:58:59 -03:00
..
contributing.adoc	Update docs/documentation/internal_resources/contributing.adoc	2023-06-02 07:58:59 -03:00
README.md	Moving docs to new folder	2023-03-20 09:07:58 +01:00
screenshots.adoc	Moving docs to new folder	2023-03-20 09:07:58 +01:00
styleguide.adoc	Moving docs to new folder	2023-03-20 09:07:58 +01:00
template_concept.adoc	Moving docs to new folder	2023-03-20 09:07:58 +01:00
template_reference.adoc	Moving docs to new folder	2023-03-20 09:07:58 +01:00
template_task.adoc	Moving docs to new folder	2023-03-20 09:07:58 +01:00
template_task_brief.adoc	Moving docs to new folder	2023-03-20 09:07:58 +01:00
terms_conventions.adoc	Moving docs to new folder	2023-03-20 09:07:58 +01:00
testing.adoc	Moving docs to new folder	2023-03-20 09:07:58 +01: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.