No description
Find a file
Jen Malloy 109a9aacf2 Merge pull request #36 from sgilda/fix-headers
Fix heading title errors.
2016-11-29 15:06:25 -05:00
images Fixes and updates. 2016-09-08 19:58:55 -03:00
topics Fix heading title errors. Add a blank line between each include in the SUMMARY.adoc file to fix title build errors. Remove trailing + line in the enforcer/keycloak-enforcement-filter.adoc file. Add a buildGuide.sh and instructions to use it in the README.adoc file. 2016-11-29 15:02:13 -05:00
.gitignore First bucket of documentation from docbook. 2016-05-31 17:36:14 -03:00
book-product.json Added bits for productized version of docs 2016-09-20 11:30:25 +02:00
book.json Added bits for productized version of docs 2016-09-20 11:30:25 +02:00
build.sh Added bits for productized version of docs 2016-09-20 11:30:25 +02:00
buildGuide.sh Fix heading title errors. Add a blank line between each include in the SUMMARY.adoc file to fix title build errors. Remove trailing + line in the enforcer/keycloak-enforcement-filter.adoc file. Add a buildGuide.sh and instructions to use it in the README.adoc file. 2016-11-29 15:02:13 -05:00
gitlab-conversion.py Added bits for productized version of docs 2016-09-20 11:30:25 +02:00
master-docinfo.xml Update master-docinfo.xml 2016-11-09 13:58:53 -05:00
metadata.ini Added bits for productized version of docs 2016-09-20 11:30:25 +02:00
README.adoc Fix heading title errors. Add a blank line between each include in the SUMMARY.adoc file to fix title build errors. Remove trailing + line in the enforcer/keycloak-enforcement-filter.adoc file. Add a buildGuide.sh and instructions to use it in the README.adoc file. 2016-11-29 15:02:13 -05:00
SUMMARY.adoc Fix heading title errors. Add a blank line between each include in the SUMMARY.adoc file to fix title build errors. Remove trailing + line in the enforcer/keycloak-enforcement-filter.adoc file. Add a buildGuide.sh and instructions to use it in the README.adoc file. 2016-11-29 15:02:13 -05:00

= Authorization Services Guide

image:images/keycloak_logo.png[alt="Keycloak"]

{{book.project.name}} {{book.project.version}}

http://www.keycloak.org


== Test the Product Build

Follow the steps below to test that this documentation for the product build.

. In a terminal, navigate to the root folder of this project source.
. Convert the content by running the following Python command.
+
[source,options="nowrap"]
----
$ python gitlab-conversion.py
----
. This command puts the converted content in the `target/` directory.
. Copy the `buildGuide.sh` script from the root of the project folder to the `target/` directory.
+
[source,options="nowrap"]
----
cp buildGuide.sh target/
----
. Navigate to the `target/` directory and build the documentation to be sure there are no errors.
+
[source,options="nowrap"]
----
./buildGuide.sh
----
. Open the link provided as a result of the build and visually check the guide to make sure it is correctly formatted.
* Search for '<<' to find links that were not converted.
* Search for '==' to find titles that are not rendered correctly.