7:16 p.m.
Author: rob.stryker(a)jboss.com
Date: 2007-05-11 13:16:36 -0400 (Fri, 11 May 2007)
New Revision: 2028
Added:
trunk/as/docs/reference/en/images/archives/publish.jpg
trunk/as/docs/reference/en/images/projects/
trunk/as/docs/reference/en/images/projects/wizard1.jpg
trunk/as/docs/reference/en/images/projects/wizard2.jpg
trunk/as/docs/reference/en/modules/deploy.xml
trunk/as/docs/reference/en/modules/projects.xml
Modified:
trunk/as/docs/reference/en/master.xml
trunk/as/docs/reference/en/modules/archives.xml
Log:
First draft done
Added: trunk/as/docs/reference/en/images/archives/publish.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/archives/publish.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/projects/wizard1.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/projects/wizard1.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/as/docs/reference/en/images/projects/wizard2.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/as/docs/reference/en/images/projects/wizard2.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: trunk/as/docs/reference/en/master.xml
===================================================================
--- trunk/as/docs/reference/en/master.xml 2007-05-11 16:37:20 UTC (rev 2027)
+++ trunk/as/docs/reference/en/master.xml 2007-05-11 17:16:36 UTC (rev 2028)
@@ -6,6 +6,8 @@
<!ENTITY runtimesAndServers SYSTEM "modules/runtimesAndServers.xml">
<!ENTITY asPerspective SYSTEM "modules/thePerspective.xml">
<!ENTITY archives SYSTEM "modules/archives.xml">
+<!ENTITY facetedProjects SYSTEM "modules/projects.xml">
+<!ENTITY deploying SYSTEM "modules/deploy.xml">
]>
@@ -23,5 +25,6 @@
&runtimesAndServers;
&asPerspective;
&archives;
-
+&facetedProjects;
+&deploying;
</book>
Modified: trunk/as/docs/reference/en/modules/archives.xml
===================================================================
--- trunk/as/docs/reference/en/modules/archives.xml 2007-05-11 16:37:20 UTC (rev 2027)
+++ trunk/as/docs/reference/en/modules/archives.xml 2007-05-11 17:16:36 UTC (rev 2028)
@@ -129,7 +129,8 @@
an excludes pattern. As you type in either of these fields,
the preview viewer should update itself with which files are matched.</para>
</section>
- <section><title>View Actions</title>
+ </section>
+ <section><title>View Actions</title>
<para>
The context menu on the items in the view is extendable, but there are
several that come standard. The first is the <emphasis>Build
Archive</emphasis>
@@ -138,13 +139,33 @@
not needing an explanation. The edit action brings up the wizard associated
with that particular node type and allows the details to be changed. The final
action contribution here is the ability to publish to a declared
server.</para>
- <section><title>Publishing to a server</title>
+ </section>
+ <section><title>The Publish to Server Action</title>
+ <figure id="publishAction"> <title>Publish to
Server</title>
+ <mediaobject>
+ <alt>Publish to Server</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\archives\publish.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The dialog above appears after selecting <emphasis>Publish to
Server</emphasis>.
+ To simply publish once, you just select the server(s) that you want, and
+ finish. If you want the <emphasis>Publish to Server</emphasis> action
+ on that particular Archive to <emphasis>always</emphasis> publish to
+ that set of servers, then check the appropriate checkbox. And finally, to
+ enable automatic publishing upon build events, check the last
checkbox.</para>
+ <para>
+ The automatic publishing feature is nice if, for example, your
+ package's destination (where it is built) is a temporary folder and
+ you want the archive published to several servers. If you only really want your
+ archive published to one server, it might be easier to have the archive's
+ destination folder be the deploy folder of the server.</para>
- </section>
+
</section>
- </section>
-
-
</section>
Added: trunk/as/docs/reference/en/modules/deploy.xml
===================================================================
--- trunk/as/docs/reference/en/modules/deploy.xml (rev 0)
+++ trunk/as/docs/reference/en/modules/deploy.xml 2007-05-11 17:16:36 UTC (rev 2028)
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter id="deploy">
+ <title>Deploying Modules</title>
+
+ <para>
+ Deploying to a server is mostly painless.
+ There are several ways to do it provided by Webtools,
+ and some additional methods provided by RHDS. </para>
+ <section><title>WTP Projects</title>
+ <section><title>Run On Server</title>
+ <para>
+ The first WTP method is to right-click on a webtools project,
+ such as a dynamic web project, ejb project, or ear project.
+ and then selecting <emphasis>run on server...</emphasis>.
+ The resulting dialog allows you to select which supporting
+ server the project can be published to. </para>
+ <para>
+ For the JBoss AS Server Adapters, publishing using this method
+ will force a default, best-guess, packaging configuration
+ for your project. This best-guess does <emphasis>not</emphasis>
+ publish incrementally, but instead repackages your entire
+ project into a .war, .jar, or .ear as appropriate, and
+ then coppies that file into the proper deploy directory.
+ For quicker smarter deployment, you will need to create
+ archives using the <emphasis>Project Archives</emphasis>
+ view and customize packaging yourself.</para>
+ </section>
+ <section><title>Add / Remove Projects</title>
+ <para>
+ Another method is in either the Servers View, or the JBoss
+ Servers View, to right click on a server and select
+ the <emphasis>Add or Remove Projects</emphasis> menu item.
+ This will bring up a dialog allowing you to either publish
+ projects / modules to a server, or remove them from the server.</para>
+
+ <para>
+ If the selected module is a webtools project,
+ it will be published as in the <emphasis>Run on Server</emphasis>
+ option, with a best-guess full package. If, however, the selected
+ element is an archive from the <emphasis>Project Archives
View</emphasis>,
+ it will be published according to the rules of that module type, which
+ are explained below.</para>
+ </section>
+ <section><title>JBoss Servers View, Publish</title>
+ <para>
+ In the JBoss Server's View, in the bottom section, is a
+ category called <emphasis>Modules</emphasis> which should
+ display all currently-published modules on the server.
+ By right-clicking on the desired module and selecting
+ <emphasis>Publish</emphasis>, it will force a full
+ rebuild of the entire module. </para>
+ </section>
+ <section><title>Project Archives View</title>
+ <para>In the Project Archives View, you can
+ right-click on any declared archive and select the
+ <emphasis>Publish To Server</emphasis> element, as described in
+ the last chapter. </para>
+ <para>
+ The ONLY WAY to ensure an <emphasis>Incremental Build</emphasis>,
+ such as changes to one jsp, html, or .class file, is to
+ enable the builder for that project. This is done by either changing
+ the global preferences for the Archives View, or in enabling
+ project-specific preferences and ensuring the builder is on.</para>
+ </section>
+ <!--
+ <figure id="viewMain"> <title>JBoss Servers View: Main
Section</title>
+ <mediaobject>
+ <alt>JBoss Servers View Main Section</alt>
+ <imageobject>
+ <imagedata
+ fileref="..\..\..\..\reference\en\images\asPerspective\viewMain.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ -->
+ </section>
+ </chapter>
Added: trunk/as/docs/reference/en/modules/projects.xml
===================================================================
--- trunk/as/docs/reference/en/modules/projects.xml (rev 0)
+++ trunk/as/docs/reference/en/modules/projects.xml 2007-05-11 17:16:36 UTC (rev 2028)
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter id="webtoolsProjects">
+ <title>Webtools Projects</title>
+ <section><title>Description</title>
+ <para>
+ Webtools provides what are called "faceted" projects,
+ Their most popular such projects are their J2EE projects,
+ such as their Dynamic Web Project, their EJB Project,
+ or their EAR project. </para>
+ <para>
+ The idea behind faceted projects is that each project
+ can accept units of functionality, or facets, which can be
+ added or removed by the user. Some examples of these facets
+ are adding a webdoclet facet to a web project, or an
+ ejbdoclet to an EJB Project. </para>
+ <para>
+ Most often, these "facets" either add to the project's classpath,
+ enable a builder, or watch the project in some other fashion. </para>
+ <para>
+ WTP projects have undergone some criticism as being
+ <emphasis>over-engineered</emphasis> or too restrictive in their
+ design. WTP projects are set up in a tree-relationship to each other,
+ where one project can be a child of another. For example, an EAR
+ project may have a Web Project child, an EJB project child,
+ or other types. </para>
+ <para>
+ The benefit of this is that the structure of your projects is
+ then known, and packaging it up *should* be trivial. However,
+ if your project is non-standard, or you feel too confined by
+ such rigid structural requirements, you can still choose to
+ package your project using the Archives plugin as described
+ in the last chapter</para>
+
+ </section>
+ <section><title>Faceted Project Wizards</title>
+ <figure id="faceted1"> <title>Faceted Project Wizard: First
Page</title>
+ <mediaobject>
+ <alt>Faceted Project Wizard: First Page</alt>
+ <imageobject>
+ <imagedata width="5in" scalefit="0"
+ fileref="..\..\..\..\reference\en\images\projects\wizard1.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The first page of most WTP projects allows you to target a specific runtime,
+ representing a server's library location. It will also provide you the ability to
+ add this project to an EAR project, and select a pre-selected default set of facets,
+ called a configuration, rather than manually select each facet you might
want.</para>
+ <para>
+ Selecting the runtime, again, allows the project to install the proper
+ classpaths to the project so it knows what code to compile against.</para>
+ <figure id="faceted2"> <title>Faceted Project Wizard: Second
Page</title>
+ <mediaobject>
+ <alt>Faceted Project Wizard: Second Page</alt>
+ <imageobject>
+ <imagedata width="5in" scalefit="0"
+ fileref="..\..\..\..\reference\en\images\projects\wizard2.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The second page of the wizard allows you to enable or disable specific facets, as
+ described above. Some facets may require others, and some may conflict with others,
+ but on the whole this page allows you to add any number of facets that don't
conflict
+ with each other. </para>
+ <para>
+ Further pages are specific to either hte project type, or the facets
selected.</para>
+ </section>
+</chapter>