26 lines
No EOL
767 B
Markdown
26 lines
No EOL
767 B
Markdown
Keycloak Documentation Guidelines
|
|
======================
|
|
|
|
This folder contains guidelines for writers.
|
|
|
|
Contributor's Guide
|
|
-------------------
|
|
|
|
See our [Contributor's Guide](contributing.adoc) 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](template_task_brief.adoc). The [detailed task template](template_task.adoc) has a wealth of resources and tips that you may find useful.
|
|
* I want to understand X
|
|
* Use the [Concept Template](template_concept.adoc)
|
|
* I want to know X
|
|
* Use the [Reference Template](template_reference.adoc)
|
|
|
|
Styles
|
|
------
|
|
|
|
When writing content we use the IBM Style Guide. |