keycloak-scim/internal_resources/README.md

Keycloak Documentation Guidelines
======================

This folder contains guidelines for writers.

Templates
------

Which template should you use for your new content?

* I want to do X
  * Use the [Task Template](template_task.adoc)
  * Once you have mastered the task template you can use the [brief task template](template_task_brief.adoc) to create your content.
* 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 following style guides in order:

1. IBM Style Guide (printed)
2. [IBM DeveloperWorks Editorial Style Guide](https://www.ibm.com/developerworks/library/styleguidelines/)
3. [Red Hat Corporate Style](http://brand.redhat.com/elements/)
4. [RH-SSO Style Guide](styleguide.adoc)
5. [RH-SSO Terms and Conventions](terms_conventions.adoc)
6. [Red Hat Glossary of Terms and Conventions](http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/glossary-of-terms-and-conventions-for-product-documentation-branch-master/lastSuccessfulBuild/artifact/index.html)
7. [RH-SSO Screenshot Guidelines](screenshots.adoc)
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
			`Templates`
			`------`

			`Which template should you use for your new content?`

			`* I want to do X`
Update README.md 2017-03-30 20:24:41 +00:00			`* Use the [Task Template](template_task.adoc)`
Update README.md 2017-03-30 20:45:46 +00:00			`* Once you have mastered the task template you can use the [brief task template](template_task_brief.adoc) to create your content.`
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`
			`------`

			`When writing content we use the following style guides in order:`

			`1. IBM Style Guide (printed)`
			`2. [IBM DeveloperWorks Editorial Style Guide](https://www.ibm.com/developerworks/library/styleguidelines/)`
			`3. [Red Hat Corporate Style](http://brand.redhat.com/elements/)`
			`4. [RH-SSO Style Guide](styleguide.adoc)`
			`5. [RH-SSO Terms and Conventions](terms_conventions.adoc)`
			`6. [Red Hat Glossary of Terms and Conventions](http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/glossary-of-terms-and-conventions-for-product-documentation-branch-master/lastSuccessfulBuild/artifact/index.html)`
			`7. [RH-SSO Screenshot Guidelines](screenshots.adoc)`