Author: mmcallis
Date: 2008-04-02 00:43:57 -0400 (Wed, 02 Apr 2008)
New Revision: 10471
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
Log:
minor corrections, s/wiki/Wiki
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-04-02
03:10:57 UTC (rev 10470)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-04-02
04:43:57 UTC (rev 10471)
@@ -128,7 +128,7 @@
Copy the Datasource descriptor that matches your database into the
<filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory, where <replaceable>configuration</replaceable> is either all,
default, minimal or production. The production configuration only exists on JBoss EAP, and
not JBoss AS. For example, if you are using the all configuration, copy the Datasource
descriptor into the <filename>$JBOSS_HOME/server/all/deploy/</filename>
directory.
</para>
<para>
- After the Datasource descriptor has been copied into the
<filename>deploy</filename> directory, make sure the username, password,
connection-url, and driver-class are correct for your chosen database. Datasource
descriptor files can be deployed to test before being used in production. The following is
an example Datasource descriptor for the PostgreSQL database:
+ After the Datasource descriptor has been copied into the
<filename>deploy</filename> directory, make sure the
<computeroutput>user-name</computeroutput>,
<computeroutput>password</computeroutput>,
<computeroutput>connection-url</computeroutput>, and
<computeroutput>driver-class</computeroutput>, are correct for your chosen
database. Datasource descriptor files can be deployed to test before being used in
production. The following is an example Datasource descriptor for the PostgreSQL
database:
</para>
<programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
@@ -143,7 +143,7 @@
</datasources>
]]></programlisting>
<para>
- For further details about Datasource descriptors, please refer to the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
JDBC Datasource wiki page</ulink>.
+ For further details about Datasource descriptors, please refer to the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
JDBC Datasource Wiki page</ulink>.
</para>
</sect3>
</sect2>
@@ -259,7 +259,7 @@
</imageobject>
</mediaobject>
<para>
- If the source files were obtained from SVN, change into the
<filename>trunk/src/</filename> directory to see the directories from the
above image. As well, there is an empty <filename>thirdparty</filename>
directory. This directory contains files after building the JBoss Portal source code
(refer to <xref linkend="building_deploying_from_source" />). For more
information about the JBoss Portal SVN repository, and accessing different versions of the
JBoss Portal codebase, please visit the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalSVNRepo">... Portal SVN
Repo</ulink> page on the JBoss Wiki.
+ If the source files were obtained from SVN, change into the
<filename>trunk/src/</filename> directory to see the directories from the
above image. As well, there is an empty <filename>thirdparty</filename>
directory. This directory contains files after building the JBoss Portal source code
(refer to <xref linkend="building_deploying_from_source" />). For more
information about the JBoss Portal SVN repository, and accessing different versions of the
JBoss Portal codebase, refer to the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalSVNRepo">... Portal SVN
Repo</ulink> page on the JBoss Wiki.
</para>
</sect2>
<sect2>
@@ -444,7 +444,7 @@
Copy the Datasource descriptor that matches your database into the
<filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory, where <replaceable>configuration</replaceable> is either all,
default, minimal, or production. For example, if you are using the production
configuration, copy the Datasource descriptor into the
<filename>$JBOSS_HOME/server/production/deploy/</filename> directory. The
production configuration only exists on JBoss EAP installations, and not JBoss AS.
</para>
<para>
- After the Datasource descriptor has been copied into the
<filename>deploy</filename> directory, make sure the username, password,
connection-url, and driver-class are correct for your chosen database. Datasource
descriptor files can be deployed to test before being used in production. The following is
an example Datasource descriptor for the PostgreSQL database:
+ After the Datasource descriptor has been copied into the
<filename>deploy</filename> directory, make sure the
<computeroutput>user-name</computeroutput>,
<computeroutput>password</computeroutput>,
<computeroutput>connection-url</computeroutput>, and
<computeroutput>driver-class</computeroutput>, are correct for your chosen
database. Datasource descriptor files can be deployed to test before being used in
production. The following is an example Datasource descriptor for the PostgreSQL
database:
</para>
<programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
@@ -459,7 +459,7 @@
</datasources>
]]></programlisting>
<para>
- For further details about Datasource descriptors, please refer to the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
JDBC Datasource wiki page</ulink>.
+ For further details about Datasource descriptors, please refer to the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
JDBC Datasource Wiki page</ulink>.
</para>
</sect2>
</sect1>
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-02
03:10:57 UTC (rev 10470)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-02
04:43:57 UTC (rev 10471)
@@ -1542,12 +1542,12 @@
<sect2 id="descriptor_ds">
<title>Datasource Descriptors
(<filename>portal-*-ds.xml</filename>)</title>
<para>
- JBoss Portal requires a Datasource descriptor to be deployed alongside the
<filename>jboss-portal.sar</filename>, in order to communicate with a
database. This section explains where to obtain template Datasource descriptors, how to
compile them from source, and how to configure them for your installation. For an in-depth
introduction to datasources, view the JBoss AS documentation online on the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=ConfigDataSources"...
Datasource wiki page</ulink>.
+ JBoss Portal requires a Datasource descriptor to be deployed alongside the
<filename>jboss-portal.sar</filename>, in order to communicate with a
database. This section explains where to obtain template Datasource descriptors, how to
compile them from source, and how to configure them for your installation. For an in-depth
introduction to datasources, refer to the JBoss AS documentation online on the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=ConfigDataSources"...
Datasource Wiki page</ulink>.
</para>
<sect3>
<title>Datasource Descriptors included in Binary
releases</title>
<para>
- Several template Datasource descriptors are included in the binary and bundled
distributions of JBoss Portal. They are commonly located within the
<filename>jboss-portal-<replaceable>version</replaceable>/setup/</filename>
directory:
+ Several template Datasource descriptors are included in the binary and bundled
distributions of JBoss Portal. They are commonly located in the
<filename>jboss-portal-<replaceable>version</replaceable>/setup/</filename>
directory:
</para>
<para>
<mediaobject>
@@ -1558,7 +1558,7 @@
</mediaobject>
</para>
<para>
- The <filename>setup/</filename> directory contains sample Datasource
descriptors for the MySQL, Microsoft SQL Server, PostgreSQL, and Oracale databases. These
can be customised for your own database:
+ The
<filename>jboss-portal-<replaceable>version</replaceable>/setup/</filename>
directory contains sample Datasource descriptors for the MySQL, Microsoft SQL Server,
PostgreSQL, and Oracale databases, which can be customized for your own database:
</para>
<para>
<mediaobject>
@@ -1571,7 +1571,7 @@
<sect3>
<title>Building Datasource Descriptors from Source</title>
<para>
- Before proceeding:
+ To build the Datasource descriptors from source:
</para>
<para>
<orderedlist>
@@ -1587,7 +1587,7 @@
</listitem>
<listitem>
<para>
- Change into the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename> directory. To build
the JBoss Portal source code on Linux, run the <command>./build.sh
deploy</command> command, or, if you are running Microsoft Windows, run the
<command>build.bat deploy</command> command. If this is the first build,
third-party libaries are obtained from an online repository, so you must be connected to
the internet. After building the JBoss Portal source, the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/thirdparty/</filename> directory
contains the required files. For further details, refer to <xref
linkend="building_deploying_from_source" />.
+ Change into the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename> directory. To build
the JBoss Portal source code on Linux, run the <command>./build.sh
deploy</command> command, or, if you are running Microsoft Windows, run the
<command>build.bat deploy</command> command. If this is the first build,
third-party libaries are obtained from an online repository, so you must be connected to
the Internet. After building the JBoss Portal source, the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/thirdparty/</filename> directory is
created if it does not already exist, and will contain the files required in later steps.
For further details, refer to <xref linkend="building_deploying_from_source"
/>.
</para>
</listitem>
<listitem>
@@ -1615,7 +1615,7 @@
</screen>
</para>
<para>
- Once complete, the datasource build produces the following directory and file
structure:
+ Once complete, the datasource build process produces the following directory and
file structure, with the Datasource descriptors being located in the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/core/output/resources/setup</filename>
directory:
</para>
<para>
<mediaobject>
@@ -1624,9 +1624,11 @@
</imageobject>
</mediaobject>
</para>
- <para>At this point, you should configure the one that suits you best
with your Database and JDBC
- driver.
- <programlisting><![CDATA[
+ <para>
+ The following is an example Datasource descriptor for the PostgreSQL database:
+ </para>
+ <para>
+<screen><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<datasources>
<local-tx-datasource>
@@ -1636,9 +1638,11 @@
<user-name>portal</user-name>
<password>portalpassword</password>
</local-tx-datasource>
-</datasources>]]></programlisting>
- Please verify that the username, password, url, and driver-class are
correct for
- your flavor of DB.
+</datasources>]]>
+</screen>
+ </para>
+ <para>
+ Make sure the <computeroutput>user-name</computeroutput>,
<computeroutput>password</computeroutput>,
<computeroutput>connection-url</computeroutput>, and
<computeroutput>driver-class</computeroutput>, are correct for your chosen
database.
</para>
</sect3>
</sect2>