[gatein-commits] gatein SVN: r2752 - in portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US: fallback_content and 1 other directory.
do-not-reply at jboss.org
do-not-reply at jboss.org
Fri Apr 23 11:13:14 EDT 2010
Author: luc.texier at jboss.com
Date: 2010-04-23 11:13:12 -0400 (Fri, 23 Apr 2010)
New Revision: 2752
Modified:
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Introduction.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/fallback_content/Feedback.xml
Log:
JBEPP-274: luc's review pass #1
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml 2010-04-23 14:28:36 UTC (rev 2751)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml 2010-04-23 15:13:12 UTC (rev 2752)
@@ -17,14 +17,12 @@
<title>Overview</title>
<para>
- A relational database management system (RDBMS) Java Database Connectivity (JDBC) connector is required for &PRODUCT; to communicate with a database.
- &PRODUCT; comes bundled with the Hypersonic SQL (HSQL) database so that users can get up and running quickly without having to initially set up
- a database. However, HSQL should not be used in a production environment.
+ A Java Database Connectivity (JDBC) connector/driver is required for &PRODUCT; to communicate with a relational database management system (RDBMS). &PRODUCT; comes bundled with the Hypersonic SQL (HSQL) database in order for users to get up and running quickly without having to initially set up a database and the server. However, HSQL should not be used in a production environment and &HOLDER; does not offer ANY support for it. Therefore we recommend to setup a RDBMS and &PRODUCT; connect to it as follows:
</para>
<para>&PRODUCT; has two different database dependencies. One is the
identity service configuration, which depends on Hibernate. The other
- database dependency is the Java content repository (JCR) service, which
+ database dependency is the Java Content Repository (JCR) service, which
depends on the native JDBC API. JCR has the capability to integrate with
any existing datasource implementation.</para>
@@ -335,4 +333,4 @@
</datasources>]]> </programlisting>
</section>
-</section>
\ No newline at end of file
+</section>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml 2010-04-23 14:28:36 UTC (rev 2751)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml 2010-04-23 15:13:12 UTC (rev 2752)
@@ -9,8 +9,8 @@
<section id="Getting_Started-Pre_Requisites">
<title>Pre-Requisites</title>
<para>
- You must have adequate disk space to install a JDK and &PRODUCT; (550MB) while also allowing enough space for your applications. Before installing &PRODUCT; you must have a working installation of Java. Since JBoss is 100% pure Java you can have it working on any Operating System / Platform that supports Java.
- However, only some combinations are certified (tested prior to shipping) or supported (on which you can open support tickets), the certified combinations are listed below.
+ You must have adequate disk space to install a JDK and &PRODUCT; (about 520MB) while also allowing enough space for your applications. Before installing &PRODUCT; you must have a working installation of Java. Since JBoss is 100% pure Java you can have it working on any Operating System / Platform that supports Java.
+ <!--However, only some combinations are certified (tested prior to shipping) or supported (on which you can open support tickets), the certified combinations are listed below. -->
</para>
<section id="Pre_Requisites-EAP">
<title>Enterprise Application Platform</title>
@@ -21,9 +21,11 @@
</section>
<section id="Pre_Requisites-Hardware_and_Operating_System_Requirements">
<title>System Requirements</title>
+<!--
<para><remark>Add hardware requirements as per this section of this doc?</remark></para>
<para><ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/4.3.0.cp07/html/Installation_Guide/Getting_Started.html"></ulink>?</para>
- <para>For the latest information on supported Operating System / JVM combinations and supported Database platforms, please refer to <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigurations/">http://www.jboss.com/products/platforms/portals/testedconfigurations/</ulink>.
+-->
+ <para>For the latest information on supported Operating System / JVM combinations and supported Database platforms, please always refer to <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigurations/">http://www.jboss.com/products/platforms/portals/testedconfigurations/</ulink>.
</para>
<para>
The following is a list of certified operating systems and JVM version combinations:
@@ -128,7 +130,7 @@
</table>
<para>
- The following is a list of supported databases and database drivers:
+ The following is a list of supported databases and JDBC drivers:
</para>
<indexterm>
<primary>System Requirements</primary>
@@ -140,7 +142,7 @@
</indexterm>
<table>
<title>
- Supported and Certified Database / Database driver Combinations.
+ Supported and Certified Database / JDBC driver Combinations.
</title>
<tgroup cols="2">
@@ -291,11 +293,13 @@
</tbody>
</tgroup>
</table>
+<!--
<note>
<para>
JBoss uses an embedded Tomcat and does not require a stand-alone Tomcat.
</para>
</note>
+-->
</section>
<section id="Pre_Requisites-Configuring_Your_Java_Environment">
@@ -559,29 +563,7 @@
</listitem>
<listitem>
<para>
- In order to run java from the command line add the <literal>jre\bin</literal> directory to your path, for example: <literal>C:\Program Files\Java\jdk1.6.0_19\jre\bin</literal>. To do this:
- <orderedlist>
- <listitem>
- <para>
- Open the Control Panel from the Start Menu, switching to Classic View if necessary.
- </para>
- </listitem>
- <listitem>
- <para>
- Open the System Control Panel applet.
- </para>
- </listitem>
- <listitem>
- <para>
- Select the Advanced Tab
- </para>
- </listitem>
- <listitem>
- <para>
- Click on the Environment Variables button.
- </para>
- </listitem>
- </orderedlist>
+ In order to run java from the command line add the <literal>jre\bin</literal> directory to your path, for example: <literal>C:\Program Files\Java\jdk1.6.0_19\jre\bin</literal>. You may set these variables by going to the System Properties window then select the Advanced tab and finally click on the Environment Variables button.
</para>
</listitem>
</itemizedlist>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml 2010-04-23 14:28:36 UTC (rev 2751)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml 2010-04-23 15:13:12 UTC (rev 2752)
@@ -8,10 +8,10 @@
<title>Installation</title>
<section id="Download">
- <title>Download</title>
+ <title>Downloading</title>
<para>
- You can download the zip file from the JBoss Customer Support Portal (CSP), located at <ulink url="https://network.jboss.com">https://network.jboss.com</ulink>.
+ The officially supported archives are available from the JBoss Customer Support Portal (CSP) located at <ulink url="https://support.redhat.com">https://support.redhat.com</ulink>. Platforms including in your Support subscription are listed in the <literal>Software</literal> section.
</para>
</section>
@@ -19,9 +19,8 @@
<title>Installing</title>
<para>
- To install from a zip file, simply unzip the downloaded file to a directory of your choice. You can unzip the platform on any operating system that supports the zip format. Six types of server configurations will be included in your installation - minimal, default, production, all, standard and web.
- The Getting Started Guide of &JBEAP; explains in detail the different server configuration file sets.
-
+ To install from a zip file, simply unzip the downloaded file to a directory of your choice.
+
<itemizedlist>
<listitem>
<para>
@@ -32,11 +31,19 @@
</listitem>
<listitem>
<para>
- You are done with the installation! You should now have a directory called <filename>jboss-epp-<replaceable><release></replaceable></filename>. Refer to the Getting Started Guide to understand and explore the Platform Directory Structure.
+ You are done with the installation! You should now have a directory called <filename>jboss-epp-<replaceable><release></replaceable></filename>.
</para>
</listitem>
</itemizedlist>
- </para>
+ </para>
+ <note>
+ <title>Note: server configurations</title>
+ <para>
+ Six types of server configurations will be included in your installation: <literal>minimal</literal>, <literal>default</literal>, <literal>production</literal>, <literal>all</literal>, <literal>standard</literal> and <literal>web</literal>.
+ The Getting Started Guide of &JBEAP; 5.0 explains in detail the different server configuration file sets.
+ </para>
+ </note>
+
</section>
<section id="server-config-differences">
@@ -67,10 +74,10 @@
</listitem>
</itemizedlist>
</para>
- <para><remark>Added the note below to account for all gatein.ear archives.</remark></para>
+ <!--<para><remark>Added the note below to account for all gatein.ear archives.</remark></para>-->
<note><title>Note: gatein.ear archive</title>
<para>
- The getein.ear archive, which contains the Portal components, is located in the deploy folder of the <literal>default</literal>, <literal>all</literal> and <literal>production</literal> server configurations.
+ The gatein.ear archive, which contains the Portal components, is located in the deploy folder of the <literal>default</literal>, <literal>all</literal> and <literal>production</literal> server configurations.
</para>
</note>
</section>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Introduction.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Introduction.xml 2010-04-23 14:28:36 UTC (rev 2751)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Introduction.xml 2010-04-23 15:13:12 UTC (rev 2752)
@@ -7,20 +7,18 @@
<chapter id="Introduction">
<title>Introduction</title>
<para>
- &PRODUCT; is the open source implementation of the Java EE suite of services and Portal services running atop &JBEAP;. It comprises a set of offerings
- for enterprise customers who are looking for preconfigured profiles of JBoss Enterprise Middleware components that have been tested and certified together
- to provide an integrated experience. Its easy-to-use server architecture and high flexibility makes JBoss the ideal choice for users just starting out with J2EE, as well as senior architects looking for a customizable middleware platform.
+ &PRODUCT; is the open source implementation of the Java EE suite of services and Portal services running atop &JBEAP;. It comprises a set of offerings for enterprise customers who are looking for preconfigured profiles of JBoss Enterprise Middleware components that have been tested and certified together to provide an integrated experience. Its easy-to-use server architecture and high flexibility makes JBoss the ideal choice for users just starting out with J2EE, as well as senior architects looking for a customizable middleware platform.
</para>
<para>
- Because it is Java-based, &PRODUCT; is cross-platform and easy to install and use on any operating system that supports Java. The readily available source code is a powerful learning tool to debug the server and understand it. It also gives you the flexibility to create customized versions for your personal or business use.
+ Because it is Java-based, &PRODUCT; is cross-platform and easy to install and use on any operating system that supports Java.
</para>
<para>
- Installing &PRODUCT; is simple and easy. You can have it installed and running in no time. This guide will teach you to install and uninstall it.
+ Installing &PRODUCT; is simple and easy. In this guide you will learn how to install, configure and secure &PRODUCT;.
</para>
<section id="Introduction-Other_Manuals">
<title>Other Manuals</title>
<para>
- If you are looking for detailed product information refer to the manuals available online at <ulink url="http://www.redhat.com/docs/manuals/jboss"></ulink>.
+ If you are looking for detailed information about other JBoss middleware products such as JBoss Enterprise Applications Platform please refer to the manuals available online at <ulink url="http://www.redhat.com/docs/manuals/jboss"></ulink>.
<!--TODO mention about the other guides attached-->
</para>
</section>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml 2010-04-23 14:28:36 UTC (rev 2751)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml 2010-04-23 15:13:12 UTC (rev 2752)
@@ -28,45 +28,27 @@
On Microsoft Windows
</title>
<para>
- Create an environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: C:\Program Files\jboss-epp-5.0\jboss-as\. In order to run the server from the command line add the <filename>bin</filename> directory to your path, for example: <literal>C:\Program Files\jboss-epp-5.0\jboss-as\bin</literal>. To do this:
- <orderedlist>
- <listitem>
- <para>
- Open the Control Panel from the Start Menu, switching to Classic View if necessary.
- </para>
- </listitem>
- <listitem>
- <para>
- Open the System Control Panel applet.
- </para>
- </listitem>
- <listitem>
- <para>
- Select the Advanced Tab
- </para>
- </listitem>
- <listitem>
- <para>
- Click on the Environment Variables button.
- </para>
- </listitem>
- </orderedlist>
+ Create an environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: C:\jboss-epp-5.0\jboss-as\.
+ In order to run the server from the command line add the <filename>bin</filename> directory to your path, for example: <literal>C:\jboss-epp-5.0\jboss-as\bin</literal>.
+ You may set these variables by going to the System Properties window then select the Advanced tab and finally click on the Environment Variables button
</para>
</formalpara>
</section>
<section id="Adjust_Memory_Settings">
<title>Adjust memory settings</title>
+<!--
<para>
- The server will start in the <literal><remark>default</remark></literal> configuration when started without specifying a configuration (such as by passing <command>-c <configuration></command> to the run script). <remark>It is recommended that large applications be run using the <literal>production</literal> configuration.</remark>
+ The server will start in the <literal><remark>default</remark></literal> configuration when started without specifying a configuration (such as by passing <command>-c <configuration></command> to the run script). <remark>It is recommended that large applications be deployed using the <literal>production</literal> configuration.</remark>
</para>
<para><remark>Note to Reviewer</remark></para>
<para>
When I run the server without specifying a configuration parameter I get <screen>16:20:52,778 INFO [ServerImpl] Server Name: default</screen>
</para>
<para><remark>End Note to Reviewer</remark></para>
+-->
<para>
- In the event of memory issues, adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename>JBOSS_DIST/jboss-as/bin/run.conf</filename>. The default values listed in the sample below are usually sufficient:
+ If the server is running out of memory, you may adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename>JBOSS_DIST/jboss-as/bin/run.conf</filename> on Linux or <filename>JBOSS_DIST/jboss-as/bin/run.conf.bat</filename> on Windows. The default values don't take in account the memory requirements of your applications:
<programlisting>
-Xms1303m -Xmx1303m -XX:MaxPermSize=256m ....
</programlisting>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/fallback_content/Feedback.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/fallback_content/Feedback.xml 2010-04-23 14:28:36 UTC (rev 2751)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/fallback_content/Feedback.xml 2010-04-23 15:13:12 UTC (rev 2752)
@@ -10,7 +10,7 @@
<secondary>contact information for this manual</secondary>
</indexterm>
<para>
- If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in Bugzilla: <ulink url="http://bugzilla.redhat.com/bugzilla/">http://bugzilla.redhat.com/bugzilla/</ulink> against the product <application>&PRODUCT;</application>.
+ If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a support ticket with your comments via the JBoss Customer Support Portal available at <ulink url="http://support.redhat.com">http://support.redhat.com</ulink> against the product <application>&PRODUCT;</application>.
</para>
<para>
When submitting a bug report, be sure to mention the manual's identifier: <citetitle>&BOOKID;</citetitle>
More information about the gatein-commits
mailing list