[jboss-svn-commits] JBoss PortletSwap SVN: r122 - in docs/userGuide/en: . modules
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Wed Aug 16 11:24:27 EDT 2006
Author: roy.russo at jboss.com
Date: 2006-08-16 11:24:26 -0400 (Wed, 16 Aug 2006)
New Revision: 122
Added:
docs/userGuide/en/modules/faq.xml
Modified:
docs/userGuide/en/master.xml
docs/userGuide/en/modules/sendportlets.xml
Log:
SWAP-15
Modified: docs/userGuide/en/master.xml
===================================================================
--- docs/userGuide/en/master.xml 2006-08-16 14:49:59 UTC (rev 121)
+++ docs/userGuide/en/master.xml 2006-08-16 15:24:26 UTC (rev 122)
@@ -6,6 +6,7 @@
<!ENTITY portlets SYSTEM "modules/portlets.xml">
<!ENTITY sendportlets SYSTEM "modules/sendportlets.xml">
<!ENTITY hosting SYSTEM "modules/hosting.xml">
+ <!ENTITY faq SYSTEM "modules/faq.xml">
]>
<book lang="en">
<bookinfo>
@@ -24,4 +25,5 @@
<!-- getting the portlets --> &portlets;
<!-- send portlets --> &sendportlets;
<!-- hosting --> &hosting;
+ <!-- faq --> &faq;
</book>
Added: docs/userGuide/en/modules/faq.xml
===================================================================
--- docs/userGuide/en/modules/faq.xml 2006-08-16 14:49:59 UTC (rev 121)
+++ docs/userGuide/en/modules/faq.xml 2006-08-16 15:24:26 UTC (rev 122)
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="faq">
+ <chapterinfo>
+ <author>
+ <surname>Roy Russo</surname>
+ <email>roy at jboss.org</email>
+ </author>
+ </chapterinfo>
+ <title>FAQ</title>
+ <sect1>
+ <title>FAQ</title>
+ <para>
+ <emphasis role="bold">General</emphasis>
+ <itemizedlist>
+ <listitem>
+ <link linkend="swap1">What is PortletSwap?</link>
+ </listitem>
+ <listitem>
+ <link linkend="swap2">What is JBoss Portal?</link>
+ </listitem>
+ <listitem>
+ <link linkend="swap3">Are PortletSwap downloads JBoss Portal specific?</link>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ <emphasis role="bold">Submitting Portlets</emphasis>
+ <itemizedlist>
+ <listitem>
+ <link linkend="submit1">How do I contribute portlets?</link>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ <emphasis role="bold">Hosting Portlet Projects</emphasis>
+ </para>
+ <para></para>
+ <para id="swap1">
+ <emphasis role="bold">I am seeing "ERROR [JDBCExceptionReporter] Table not found in statement" in the logfile
+ on first
+ boot. What is
+ this?</emphasis>
+ <para></para>
+ Ignore this error. It is used by the portal to create the initial database tables. On second boot, you should
+ not see them at all.
+ </para>
+ <para id="swap2">
+ <emphasis role="bold">I want to do a clean install/upgrade over my existing one. What are the steps?</emphasis>
+ <para></para>
+ </para>
+ <para id="swap3">
+ <emphasis role="bold">Is my database vendor/version combination supported?</emphasis>
+ <xref linkend=""/>
+ </para>
+ <para id="submit1">
+ <emphasis role="bold">How do I change the CMS repository configuration?</emphasis>
+ <para></para>
+ </para>
+ </sect1>
+</chapter>
Modified: docs/userGuide/en/modules/sendportlets.xml
===================================================================
--- docs/userGuide/en/modules/sendportlets.xml 2006-08-16 14:49:59 UTC (rev 121)
+++ docs/userGuide/en/modules/sendportlets.xml 2006-08-16 15:24:26 UTC (rev 122)
@@ -8,64 +8,105 @@
</author>
</chapterinfo>
<title>Submitting Portlets to the Catalog</title>
- <para>
- Getting your portlet project listed in the portlet catalog, is as easy as following the simple steps below.
- <note>You will need a valid account on JBoss.org/.com, to access our JIRA pages.</note>
- </para>
- <para>
- <orderedlist>
- <listitem>
- <para>Access the
- <ulink url="http://jira.jboss.com/jira/browse/SWAP">PortletSwap JIRA page</ulink>
- and
- click on
- <emphasis>Create a New Issue</emphasis>
- .
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/submit_home.gif" valign="middle"/>
- </imageobject>
- </mediaobject>
- </para>
- </listitem>
- <listitem>
- <para>Once at the
- <emphasis>Create a New Issue</emphasis>
- screen, you can select
- <emphasis>Release</emphasis>
- from the drop-down menu (selecting anything here will not make a difference, really)
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/submit1.gif" valign="middle"/>
- </imageobject>
- </mediaobject>
- </para>
- </listitem>
- <listitem>
- <para>On the subsequent screen, you will need to fill in the appropriate information, as depicted.
- <warning>Make sure you input your portlet name, and a brief description! All submitted information will
- be used to describe your portlet in the catalog. If you need to convey information, privately, please
- send an email to roy at jboss.com</warning>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/submit2.gif" valign="middle"/>
- </imageobject>
- </mediaobject>
- </para>
- </listitem>
- <listitem>
- <para>This section is optional, and relevant to those wanting to add additional information for their
- submitted portlet such as, screenshots, a deployable war/ear, or comments.
- </para>
- <para>After submitting your initial portlet information, you should arrive at the following screen, where
- you can add this additional information, using the menu items on the left-hand side of the screen.
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/submit3.gif" valign="middle"/>
- </imageobject>
- </mediaobject>
- </para>
- </listitem>
- </orderedlist>
- </para>
+ <sect1 id="sendportlets_readme">
+ <title>Contributor ReadME</title>
+ <para>
+ Before beginning the process of submitting your work, or links to your project, please read below:
+ </para>
+ <para>
+ <emphasis role="bold">General Information, As a contributor:</emphasis>
+ <itemizedlist>
+ <listitem>You maintain the copyright on your work.</listitem>
+ <listitem>You grant JBoss, Inc the right to distribute, display, and publicize your work in whole or in
+ part, or in any form, without compensation. (It wouldn't be much of an exchange, otherwise)</listitem>
+ <listitem>You license your work however you want to. We are license agnostic.</listitem>
+ <listitem>You may upload commercial, free, shareware, etc... portlets and layouts.</listitem>
+ <listitem>Please make sure to adhere to every item in the checklist below or items you are contributing
+ will not be categorized correctly, or even made available to the public!</listitem>
+ </itemizedlist>
+
+ <emphasis role="bold">Contributor Checklist, Contributing portlets and layouts:</emphasis>
+ <itemizedlist>
+ <listitem>Only submit portlets and layouts that work with JBoss Portal.</listitem>
+ <listitem>You must be the original author of the application or have written consent to distribute
+ it.</listitem>
+ <listitem>You must place a license file in the uploaded archive. (e.g. LICENSE.txt)</listitem>
+ <listitem>Please include any additional setup instructions, documentation, screenshots, etc... in the
+ distributable archive.</listitem>
+ </itemizedlist>
+
+ <emphasis role="bold">If the above instructions are not adhered to, your submission will most likely be
+ ignored, discarded, or
+ ridiculed. ;-)</emphasis>
+ </para>
+ </sect1>
+ <sect1>
+ <title>Submittal Process</title>
+ <para>
+ Getting your portlet project listed in the portlet catalog, is as easy as following the simple steps below. If
+ you
+ have questions over the portlet submittal process, please read the
+ <xref linkend="faq">FAQ</xref>
+ at the end of this document.
+ <note>You will need a valid account on JBoss.org/.com, to access our JIRA pages.</note>
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>Access the
+ <ulink url="http://jira.jboss.com/jira/browse/SWAP">PortletSwap JIRA page</ulink>
+ and
+ click on
+ <emphasis>Create a New Issue</emphasis>
+ .
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/submit_home.gif" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Once at the
+ <emphasis>Create a New Issue</emphasis>
+ screen, you can select
+ <emphasis>Release</emphasis>
+ from the drop-down menu (selecting anything here will not make a difference, really)
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/submit1.gif" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ <listitem>
+ <para>On the subsequent screen, you will need to fill in the appropriate information, as depicted.
+ <warning>Make sure you input your portlet name, and a brief description! All submitted information
+ will
+ be used to describe your portlet in the catalog. If you need to convey information, privately,
+ please
+ send an email to roy at jboss.com</warning>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/submit2.gif" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ <listitem>
+ <para>This section is optional, and relevant to those wanting to add additional information for their
+ submitted portlet such as, screenshots, a deployable war/ear, or comments.
+ </para>
+ <para>After submitting your initial portlet information, you should arrive at the following screen, where
+ you can add this additional information, using the menu items on the left-hand side of the screen.
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/submit3.gif" valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </sect1>
</chapter>
\ No newline at end of file
More information about the jboss-svn-commits
mailing list