[gatein-commits] gatein SVN: r9151 - epp/docs/branches/6.0/Admin_Guide/en-US.
do-not-reply at jboss.org
do-not-reply at jboss.org
Thu Feb 14 20:48:41 EST 2013
Author: rdickens
Date: 2013-02-14 20:48:41 -0500 (Thu, 14 Feb 2013)
New Revision: 9151
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml
Log:
Final review and editing prior to requesting cover-to-cover review by QE
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml 2013-02-14 17:27:10 UTC (rev 9150)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml 2013-02-15 01:48:41 UTC (rev 9151)
@@ -142,7 +142,7 @@
<title>Request Parameter</title>
<para>
- Since the management system supports more then just four operations, operations can also be explicitly defined by including HTTP parameters as part of the REST request. For example by adding the query parameter
+ Since the management system supports more than just four operations, operations can also be explicitly defined by including HTTP parameters as part of the REST request. For example by adding the query parameter
<emphasis role="strong">op</emphasis>
to the request URL, clients can define what operation to invoke.
</para>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-14 17:27:10 UTC (rev 9150)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2013-02-15 01:48:41 UTC (rev 9151)
@@ -30,7 +30,7 @@
<example>
<title>SSH Syntax</title>
<para>
- <command>ssh -p <port> <user> @<host></command>
+ <command>ssh -p <port> <user>@<host></command>
</para>
</example>
<example>
@@ -61,21 +61,21 @@
<section id="sid-8094332_GateInManagement-Commands">
<title>Commands</title>
<para>
- The CLI component comes with a number of management commands that will execute operations on managed resources in the portal. For a listing of all commands available type in
- <emphasis role="strong">help</emphasis>
+ The CLI component comes with a number of management commands that will execute operations on managed resources in the portal. For a listing of all commands available type
+ <command>help</command>
in the shell. You can also add the help option
- <emphasis role="strong">-h</emphasis>
+ <command>-h</command>
or
- <emphasis role="strong">--help</emphasis>
+ <command>--help</command>
for each command for further information. Also the
- <emphasis role="strong">man</emphasis>
+ <command>man</command>
command can be executed for even more detailed information about the command.
</para>
<section id="sid-8094332_GateInManagement-mgmt">
<title>mgmt</title>
<para>
The mgmt command allows a user to connect and disconnect from the management system. It also provides an
- <code>exec</code>
+ <command>exec</command>
command which allows more custom control over executing operations with the management system.
</para>
<example>
@@ -346,7 +346,7 @@
<code>export-resource</code>
and
<code>import-resource</code>
- operations. These operations are executed in order to export to and import from a host other then the portal.
+ operations. These operations are executed in order to export to and import from a host other than the portal.
</para>
<section id="sid-8094332_GateInManagement-Export">
<title>Export</title>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2013-02-14 17:27:10 UTC (rev 9150)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2013-02-15 01:48:41 UTC (rev 9151)
@@ -7,7 +7,7 @@
<title>Management Extensions</title>
<section id="sid-8094332_GateInManagement-MOPManagementExtension">
<title>MOP Management Extension</title>
- <para>The MOP management extension registers the 'mop' managed component which is responsible for managing pages, navigation, and site layout. It primarily supports exporting and importing this data through the <systemitem>export-resource</systemitem> and <systemitem>import-resource</systemitem> operations. It also supports the read-config-as-xml operation to expose the portal meta data as XML.</para>
+ <para>The MOP management extension registers the 'mop' managed component which is responsible for managing pages, navigation, and site layout. It primarily supports exporting and importing this data through the <systemitem>export-resource</systemitem> and <systemitem>import-resource</systemitem> operations. It also supports the <systemitem>read-config-as-xml</systemitem> operation to expose the portal's metadata as XML.</para>
<section id="sid-8094332_GateInManagement-Operationsxx">
<title><remark>BZ#794408 </remark>Operations</title>
<section id="sid-8094332_GateInManagement-readconfigasxml">
@@ -15,9 +15,7 @@
<para>
The
<code>read-config-as-xml</code>
- operation can only be executed on the site layout, pages, and navigation managed resources. The XML format returned is defined by the
- <ulink url="http://www.gatein.org/xml/ns/">gatein-objects</ulink>
- XSD. These resources are exposed in the same format a portal extension would accept for importing data into the portal.
+ operation can only be executed on the site layout, pages, and navigation managed resources. The XML format returned is defined by the <systemitem>gatein-objects</systemitem> XSD, which can be found at <ulink url="http://www.gatein.org/xml/ns/">http://www.gatein.org/xml/ns/</ulink>. These resources are exposed in the same format a portal extension would accept for importing data into the portal.
</para>
</section>
<section id="sid-8094332_GateInManagement-exportresource">
@@ -69,7 +67,7 @@
<term>Merge (default)</term>
<listitem>
<para>
- Import when data does not exist, update data when it does exist.
+ Import data when data does not exist, update data when it does exist.
</para>
</listitem>
@@ -190,7 +188,7 @@
</example>
<section id="sid-8094332_GateInManagement-readconfigasxmlx">
<title>config-as-xml</title>
- <para>Example of reading the site layout as XML for site classic.</para>
+ <para>Example of reading the site layout as XML for site <citetitle>classic</citetitle>.</para>
<example>
<title>HTTP Request</title>
<screen>GET /mop/portalsites/classic/portal.xml
@@ -215,7 +213,7 @@
</section>
<section id="sid-8094332_GateInManagement-exportresourcex">
<title>export-resource</title>
- <para>Example of exporting the site layout for site classic.</para>
+ <para>Example of exporting the site layout for site <citetitle>classic</citetitle>.</para>
<example>
<title>HTTP Request</title>
<screen>GET /mop/portalsites/classic/portal.zip
@@ -235,7 +233,7 @@
</section>
<section id="sid-8094332_GateInManagement-PagesResource">
<title>Pages Resource</title>
- <para>The pages resource represents the pages of the portal. It is the data defined in the <filename>pages.xml</filename> used in portal extensions to configure data.</para>
+ <para>The <systemitem>pages</systemitem> resource represents the pages of the portal. It is the data defined in the <filename>pages.xml</filename> used in portal extensions to configure data.</para>
<example>
<title>URL</title>
<programlisting>URL: /mop/{site-type}sites/{site-name}/pages/{page-name}</programlisting>
@@ -351,7 +349,7 @@
...
</node-navigation></screen>
</example>
- <para>Example of reading the home node as XML for site <citetitle>classic</citetitle>.</para>
+ <para>Example of reading the <systemitem>home</systemitem> node as XML for site <citetitle>classic</citetitle>.</para>
<example>
<title>HTTP Request</title>
<screen>GET /mop/portalsites/classic/navigation/home.xml
@@ -503,9 +501,9 @@
<example>
<title>Export MOP artifacts</title>
<para>
- <screen>$ scp -P 2000 'root at example.org:portal:/mop/portalsites/classic' classic.zip
+ <command>$ scp -P 2000 'root at example.org:portal:/mop/portalsites/classic' classic.zip
$ scp -P 2000 'root at example.org:portal:/mop/portalsites/classic/pages/homepage' homepage.zip
- $ scp -P 2000 'root at example.org:portal:/mop' mop.zip</screen>
+ $ scp -P 2000 'root at example.org:portal:/mop' mop.zip</command>
</para>
</example>
<para>
@@ -518,9 +516,9 @@
<example>
<title>Import MOP artifacts</title>
<para>
- <screen>$ scp -P 2000 classic.zip 'root at example.org:portal:/mop'
+ <command>$ scp -P 2000 classic.zip 'root at example.org:portal:/mop'
$ scp -P 2000 homepage.zip 'root at example.org:portal:/mop?importMode=overwrite'
- $ scp -P 2000 mop.zip 'root at example.org:portal:/mop'</screen>
+ $ scp -P 2000 mop.zip 'root at example.org:portal:/mop'</command>
</para>
</example>
</section>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml 2013-02-14 17:27:10 UTC (rev 9150)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml 2013-02-15 01:48:41 UTC (rev 9151)
@@ -7,7 +7,7 @@
<title><remark>BZ#856436</remark>JBoss Operations Network GateIn JON Plug-in</title>
<para>JBoss Portal Platform provides a JBoss Operations Network plug-in (<firstterm>GateIn JON Plug-in</firstterm>) to assist with monitoring the platform.</para>
<para>The plug-in captures application/portlet and site statistics. A different set of statistics are collected depending on the context of each portlet. <xref linkend="fig-GateIn_JON_Plug-in_Interface"/> shows the basic JON interface.</para>
- <para>Follow the download and installation instructions in the <citetitle>Installation Guide</citetitle> to activate Administration and Monitoring.</para>
+ <para>Follow the download and installation instructions in the <citetitle>Installation Guide</citetitle> to activate administration and monitoring.</para>
<remark>BZ#856436 Updated screenshot with Nick Scavelli's provided screenshot from the Confluence docs.</remark>
<figure id="fig-GateIn_JON_Plug-in_Interface">
<title>GateIn JON Plug-in Interface</title>
More information about the gatein-commits
mailing list