Merge pull request #666 from stianst/master

Updated docs to inherit project version from keycloak-parent
This commit is contained in:
Stian Thorgersen 2014-09-02 14:07:24 +02:00
commit 9af0743883
4 changed files with 22 additions and 18 deletions

View file

@ -1,15 +1,19 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" <project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>keycloak-parent</artifactId>
<groupId>org.keycloak</groupId>
<version>1.0-final-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-reference-guide-${translation}</artifactId> <artifactId>keycloak-reference-guide-${translation}</artifactId>
<version>1.0-final-SNAPSHOT</version>
<packaging>jdocbook</packaging> <packaging>jdocbook</packaging>
<name>Keycloak Reference Guide (${translation})</name> <name>Keycloak Reference Guide (${translation})</name>
<description/> <description/>
<modelVersion>4.0.0</modelVersion>
<repositories> <repositories>
<repository> <repository>
<id>jboss</id> <id>jboss</id>

View file

@ -38,7 +38,7 @@
<bookinfo> <bookinfo>
<title>Keycloak Reference Guide</title> <title>Keycloak Reference Guide</title>
<subtitle>SSO for Web Apps and REST Services</subtitle> <subtitle>SSO for Web Apps and REST Services</subtitle>
<releaseinfo>1.0-final-SNAPSHOT</releaseinfo> <releaseinfo>&project.version;</releaseinfo>
</bookinfo> </bookinfo>
<toc/> <toc/>

View file

@ -8,11 +8,11 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
keycloak-appliance-dist-all-1.0-final-SNAPSHOT.zip keycloak-appliance-dist-all-&project.version;.zip
</listitem> </listitem>
<listitem> <listitem>
keycloak-war-dist-all-1.0-final-SNAPSHOT.zip keycloak-war-dist-all-&project.version;.zip
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -31,7 +31,7 @@
<para> <para>
<programlisting> <programlisting>
keycloak-appliance-dist-all-1.0-final-SNAPSHOT/ keycloak-appliance-dist-all-&project.version;/
keycloak/ keycloak/
bin/ bin/
standalone.sh standalone.sh
@ -42,9 +42,9 @@ keycloak-appliance-dist-all-1.0-final-SNAPSHOT/
keycloak-server.json keycloak-server.json
themes/ themes/
adapters/ adapters/
keycloak-as7-adapter-dist-1.0-final-SNAPSHOT.zip keycloak-as7-adapter-dist-&project.version;.zip
keycloak-eap6-adapter-dist-1.0-final-SNAPSHOT.zip keycloak-eap6-adapter-dist-&project.version;.zip
keycloak-wildfly-adapter-dist-1.0-final-SNAPSHOT.zip keycloak-wildfly-adapter-dist-&project.version;.zip
examples/ examples/
docs/ docs/
</programlisting> </programlisting>
@ -79,7 +79,7 @@ keycloak-appliance-dist-all-1.0-final-SNAPSHOT/
</para> </para>
<para> <para>
<programlisting> <programlisting>
keycloak-war-dist-all-1.0-final-SNAPSHOT/ keycloak-war-dist-all-&project.version;/
deployments/ deployments/
auth-server.war/ auth-server.war/
keycloak-ds.xml keycloak-ds.xml
@ -87,9 +87,9 @@ keycloak-war-dist-all-1.0-final-SNAPSHOT/
keycloak-server.json keycloak-server.json
themes/ themes/
adapters/ adapters/
keycloak-as7-adapter-dist-1.0-final-SNAPSHOT.zip keycloak-as7-adapter-dist-&project.version;.zip
keycloak-eap6-adapter-dist-1.0-final-SNAPSHOT.zip keycloak-eap6-adapter-dist-&project.version;.zip
keycloak-wildfly-adapter-dist-1.0-final-SNAPSHOT.zip keycloak-wildfly-adapter-dist-&project.version;.zip
examples/ examples/
docs/ docs/
</programlisting> </programlisting>
@ -101,7 +101,7 @@ keycloak-war-dist-all-1.0-final-SNAPSHOT/
</para> </para>
<para> <para>
<programlisting> <programlisting>
$ cd keycloak-war-dist-all-1.0-final-SNAPSHOT $ cd keycloak-war-dist-all-&project.version;
$ cp -r deployments $JBOSS_HOME/standalone $ cp -r deployments $JBOSS_HOME/standalone
$ cp -r configuration $JBOSS_HOME/standalone $ cp -r configuration $JBOSS_HOME/standalone
</programlisting> </programlisting>

View file

@ -154,7 +154,7 @@
</para> </para>
<para> <para>
Keycloaks default account management provider is built on the FreeMarker template engine (<literal>forms/account-freemarker</literal>). Keycloaks default account management provider is built on the FreeMarker template engine (<literal>forms/account-freemarker</literal>).
To make sure your provider is loaded you will either need to delete <literal>standalone/deployments/auth-server.war/WEB-INF/lib/keycloak-account-freemarker-1.0-final-SNAPSHOT.jar</literal> To make sure your provider is loaded you will either need to delete <literal>standalone/deployments/auth-server.war/WEB-INF/lib/keycloak-account-freemarker-&project.version;.jar</literal>
or disable it with the system property <literal>org.keycloak.account.freemarker.FreeMarkerAccountProviderFactory</literal>. or disable it with the system property <literal>org.keycloak.account.freemarker.FreeMarkerAccountProviderFactory</literal>.
</para> </para>
</section> </section>
@ -167,7 +167,7 @@
</para> </para>
<para> <para>
Keycloaks default login forms provider is built on the FreeMarker template engine (<literal>forms/login-freemarker</literal>). Keycloaks default login forms provider is built on the FreeMarker template engine (<literal>forms/login-freemarker</literal>).
To make sure your provider is loaded you will either need to delete <literal>standalone/deployments/auth-server.war/WEB-INF/lib/keycloak-login-freemarker-1.0-final-SNAPSHOT.jar</literal> To make sure your provider is loaded you will either need to delete <literal>standalone/deployments/auth-server.war/WEB-INF/lib/keycloak-login-freemarker-&project.version;.jar</literal>
or disable it with the system property <literal>org.keycloak.login.freemarker.FreeMarkerLoginFormsProviderFactory</literal>. or disable it with the system property <literal>org.keycloak.login.freemarker.FreeMarkerLoginFormsProviderFactory</literal>.
</para> </para>
</section> </section>