keycloak-scim/docs/documentation/internal_resources/README.md

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.
Create README.md 2017-03-30 16:41:33 +00:00			`Keycloak Documentation Guidelines`
			`======================`

			`This folder contains guidelines for writers.`
Update README.md 2017-03-30 20:19:40 +00:00
created contributors guide and edited existing related files 2017-11-15 13:44:10 +00:00			`Contributor's Guide`
			`-------------------`

couple more edits 2017-11-15 13:47:34 +00:00			`See our [Contributor's Guide](contributing.adoc) to learn the procedure for making contributions to documentation.`
created contributors guide and edited existing related files 2017-11-15 13:44:10 +00:00
Update README.md 2017-03-30 20:19:40 +00:00			`Templates`
created contributors guide and edited existing related files 2017-11-15 13:44:10 +00:00			`---------`
Update README.md 2017-03-30 20:19:40 +00:00
couple more edits 2017-11-15 13:47:34 +00:00			`We have templates that we ask you to please use for your new content. When:`
Update README.md 2017-03-30 20:19:40 +00:00
			`* I want to do X`
created contributors guide and edited existing related files 2017-11-15 13:44:10 +00:00			`* 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.`
Update README.md 2017-03-30 20:24:17 +00:00			`* I want to understand X`
Update README.md 2017-03-30 20:24:41 +00:00			`* Use the [Concept Template](template_concept.adoc)`
Update README.md 2017-03-30 20:24:17 +00:00			`* I want to know X`
Update README.md 2017-03-30 20:24:41 +00:00			`* Use the [Reference Template](template_reference.adoc)`
Update README.md 2017-03-30 20:45:46 +00:00
			`Styles`
			`------`

created contributors guide and edited existing related files 2017-11-15 13:44:10 +00:00			`When writing content we use the IBM Style Guide.`