Author: smumford Date: 2010-06-14 22:09:01 -0400 (Mon, 14 Jun 2010) New Revision: 3333 Modified: epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Book_Info.xml epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Documentation.xml epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Installation.xml epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Revision_History.xml Log: Finalize installation instructions and file naming conventions. Modified: epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Book_Info.xml 2010-06-14 22:53:55 UTC (rev 3332) +++ epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Book_Info.xml 2010-06-15 02:09:01 UTC (rev 3333) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.0</productnumber> <edition>1</edition> - <pubsnumber>1.0</pubsnumber> + <pubsnumber>1.5</pubsnumber> <abstract> <para> These release notes contain important information related to the &JBEPP; Site Publisher Technical Preview that may not be currently available in the Product Manuals. You should read these Release Notes in their entirety before installing &JBEPP; Site Publisher. Modified: epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Documentation.xml =================================================================== --- epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Documentation.xml 2010-06-14 22:53:55 UTC (rev 3332) +++ epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Documentation.xml 2010-06-15 02:09:01 UTC (rev 3333) @@ -6,9 +6,12 @@ <chapter id="chap-Site_Publisher_Release_Notes-Documentation"> <title>Documentation</title> <para> - The User Guide for this Technical Preview has been included within the provided zip file in the &lt;DIRECTORY&gt; + A copy of the User Guide for this Technical Preview is included in the provided zip file. It is found at <filename>exo-wcm-2.0.0-tp/docs/ECMS v3.0.pdf</filename> </para> <para> - For more Jboss Enterprise Portal Platform documentation please consult the following URL for the latest information: <ulink type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo... + This document was prepared by the documentation team at eXo Platform. It is included in this Technical Preview with thanks. It will be superseded by official Red Hat documentation in the official release of Site Publisher. </para> + <para> + For more Jboss Enterprise Portal Platform documentation please visit the following URL for the latest information: <ulink type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo... + </para> </chapter> Modified: epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Installation.xml =================================================================== --- epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Installation.xml 2010-06-14 22:53:55 UTC (rev 3332) +++ epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Installation.xml 2010-06-15 02:09:01 UTC (rev 3333) @@ -8,105 +8,144 @@ <note> <title>DOC NOTE</title> <para> - The instructions below are based on the eXo Release Notes. More information is required to ensure they are correct. + The instructions below require tech review to ensure they are correct. </para> </note> - + <formalpara> + <title>Configuration Locations</title> + <para> + Installation of the Site Publisher add-on requires various configuration files to be copied to the configuration location of your &PRODUCT; instance. + </para> + </formalpara> + <para> + There are three possible locations for this configuration location depending on your &PRODUCT; configuration setup: + </para> + <variablelist> + <varlistentry> + <term>Default</term> + <listitem> + <para> + <filename>jboss-epp-5.0/jboss-as/server/default/deploy</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>All</term> + <listitem> + <para> + <filename>jboss-epp-5.0/jboss-as/server/all/deploy</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Production</term> + <listitem> + <para> + <filename>jboss-epp-5.0/jboss-as/server/production/deploy</filename>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + If you use a custom configuration location, copy the files into that location. + </para> + <para> + Ensure you know which of the above locations is in use in your &PRODUCT; environment before you begin the installation. + </para> + <para> + Alternatively, the required files can be copied into each of the three locations. + </para> <procedure> - <title>eXo Install procedure (Doc Note: will be removed)</title> + <title>Installation Instructions</title> <step> <para> - Install Java... + If you have not already done so, install &PRODUCT; &VERSION;. </para> <para> - Based on JavaEE, Site Publisher runs with version 1.6 so if you are using newer version, please download and install this version to run Site Publisher. Support for newer versions of Java will be added in future releases. + Installation instructions can be found in the &PRODUCT; Installation Guide at <ulink type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo... </para> </step> <step> <para> - Unzip the Site Publisher package under a path that does not contain any spaces (in Windows). + Download the <filename>exo-wcm-2.0.0-tech-preview-for-epp-5.0.0.GA.zip</filename> file from the Red Hat JBoss Customer Support Portal. </para> </step> <step> <para> - Open a command terminal session and navigate to the <filename>bin/</filename> in the extracted location. + Extract the Site Publisher package to an appropriate location. Ensure the path to this location does not contain any spaces. </para> </step> <step> <para> - Run the command that corresponds to your operating environment. + Copy the following files from the extracted location to the configuration location of your &PRODUCT; installation (as discussed above). </para> <itemizedlist> <listitem> <para> - In Windows: + <filename>gatein-ecmdemo-extension-2.0.0-GA.ear</filename> </para> -<programlisting>run.bat -</programlisting> </listitem> <listitem> <para> - In Unix/Linux/cygwin: + <filename>gatein-ecmdemo-portal-2.0.0-GA.ear</filename> </para> -<programlisting>./run.sh -</programlisting> </listitem> + <listitem> + <para> + <filename>gatein-exo-workflow-2.0.0-GA.ear</filename> + </para> + </listitem> + <listitem> + <para> + <filename>gatein-ds.xml</filename> + </para> + </listitem> + <listitem> + <para> + <filename>wcm-ds.xml</filename> + </para> + </listitem> </itemizedlist> - </step> - </procedure> - <procedure> - <title>EPP Install Procedure</title> - <step> + <note> + <title>Overwriting gatein-ds.xml</title> <para> - If you have not already done so, install &PRODUCT; &VERSION;. + Be aware that the base installation of &PRODUCT; already contains a <filename>gatein-ds.xml</filename> file in the <filename>deploy</filename> directory. It is recommended that this file be backed-up before copying the new Site Publisher version of the file. </para> <para> - Installation instructions can be found in the &PRODUCT; Installation Guide at <ulink type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platfo... + This ensures that if you wish to 'uninstall' the Site Publisher add-on, you can revert to the original <filename>gatein-ds.xml</filename> file. </para> - </step> - <step> - <para> - Unzip the Site Publisher package to an appropriate location. In Windows environments, ensure the path to this location does not contain any spaces. - </para> - </step> - <step> - <para> - Copy the <filename>X</filename>, <filename>Y</filename> and <filename>Z</filename> EAR files from the <filename>directory/name</filename> directory in to the <filename>jboss-as/somewhere/</filename> directory. - </para> - </step> - <step> + </note> + </step> + <step> <para> Start &PRODUCT; using your established method, the procedures outlined in the &PRODUCT; &VERSION; Installation Guide or by following the steps below. </para> - </step> - <step> - <procedure> - <step> - <para> - Open a command-line terminal session and navigate to the <filename>bin/</filename> directory in the &PRODUCT; location. - </para> - </step> - <step> - <para> - Run the command that corresponds to your operating environment. - </para> - <itemizedlist> - <listitem> - <para> - In Windows: - </para> + <procedure> + <step> + <para> + Open a command-line terminal session and navigate to the <filename>jboss-epp-5.0/jboss-as/bin</filename> directory in the &PRODUCT; location. + </para> + </step> + <step> + <para> + Run the command that corresponds to your operating environment. + </para> + <itemizedlist> + <listitem> + <para> + In Windows: + </para> <programlisting>run.bat</programlisting> - </listitem> - <listitem> - <para> - In Unix/Linux/cygwin: - </para> + </listitem> + <listitem> + <para> + In Unix/Linux/cygwin: + </para> <programlisting>./run.sh</programlisting> - </listitem> - </itemizedlist> - </step> - </procedure> + </listitem> + </itemizedlist> + </step> + </procedure> </step> </procedure> - </chapter> Modified: epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Revision_History.xml 2010-06-14 22:53:55 UTC (rev 3332) +++ epp/docs/branches/EPP_5_0_Branch/Site_Publisher_Release_Notes/en-US/Revision_History.xml 2010-06-15 02:09:01 UTC (rev 3333) @@ -8,6 +8,24 @@ <simpara> <revhistory> <revision> + <revnumber>1.5</revnumber> + <date>Mon Jun 15 2010</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email&gt;smumford(a)redhat.com&lt;/email&gt; + + </author> + <revdescription> + <simplelist> + <member>Finalize installation instructions and file naming conventions.</member> + + </simplelist> + + </revdescription> + + </revision> + <revision> <revnumber>1.0</revnumber> <date>Wed Jun 9 2010</date> <author>