servicemix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache ServiceMix > Documentation project
Date Mon, 18 Oct 2010 14:24:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/1810/9/13/_/styles/combined.css?spaceKey=SM&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/SM/Documentation+project">Documentation
project</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~gertvanthienen">Gert
Vanthienen</a>
    </h4>
        <br/>
                         <h4>Changes (12)</h4>
                                 
    
<div id="page-diffs">
            <table class="diff" cellpadding="0" cellspacing="0">
            <tr><td class="diff-changed-lines" >The ServiceMix documentation project
aims to build a set of manuals for ServiceMix using <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">DocBook
XML.</span> <span class="diff-added-words"style="background-color: #dfd;">[Scalate|http://scalate.fusesource.org].</span>
<br></td></tr>
            <tr><td class="diff-unchanged" > <br></td></tr>
            <tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">h3.
Links <br>For ServiceMix 4.3-SNAPSHOT <br>* Programmer&#39;s Guide ([One-page
HTML|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/single/index.html]) ([HTML|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/html/index.html])
([PDF|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/pdf/index.pdf]) <br>*
JBI Reference Guide ([One-page HTML|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/single/index.html])
([HTML|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/html/index.html]) ([PDF|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/pdf/index.pdf])
<br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">h3.
Sample output <br>For ServiceMix 4.3-SNAPSHOT: http://servicemix.apache.org/docs/4.3.0-SNAPSHOT/
<br></td></tr>
            <tr><td class="diff-unchanged" > <br>h3. Source code <br></td></tr>
            <tr><td class="diff-changed-lines" >The source code for this project
can be found at <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">https://svn.apache.org/repos/asf/servicemix/documentation/</span>
<br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">*
https://svn.apache.org/repos/asf/servicemix/documentation/ <br>* git://git.apache.org/servicemix-documentation.git
<br> <br>Branches: <br></td></tr>
            <tr><td class="diff-unchanged" >* {{trunk}} refers to the next development
version of ServiceMix (currently 4.3-SNAPSHOT) <br> <br></td></tr>
            <tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">Content
can be added in two formats: <br>* pure DocBook XML source files go in the *{{src/docbkx}}*
folder <br>* a Confluence-alike wiki markup can be used in *{{src/confluence}}* <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">h3.
Prerequisites <br>Before being able to build and run this project, you need to download
and install: <br>* [Pygments|http://pygments.org/] : http://pygments.org/download/ <br>*
[Prince XML|princexml.com] : http://princexml.com/download/ <br></td></tr>
            <tr><td class="diff-unchanged" > <br>h3. Project layout <br></td></tr>
            <tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">*
{{common}} : common files (xsl, css, ...) <br>* {{docs}} : common maven plugin setup
for underlying projects <br>* {{docs/manual}} : Programmer&#39;s Manual <br>*
{{docs/jbi}} : JBI Reference Manual <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">The
project is a basic Maven WAR project.  Some important directories and files in the project:
<br>* {{src/main/webapp/commands}} : TOC and index files for Console Commands manual
section <br>* {{src/main/webapp/karaf}} : TOC and index files for Karaf manual section
 <br>* {{src/main/webapp/users-guide}} : The ServiceMix User&#39;s Guide section
<br>* {{src/main/webapp/WEB-INF/scalate/layouts}} : Scalate SSP templates for the site
<br></td></tr>
            <tr><td class="diff-unchanged" > <br>h3. Building and deploying
<br></td></tr>
            <tr><td class="diff-changed-lines" >The documentation can be built
by running *{{mvn clean install}}* on the documentation project. <span class="diff-added-words"style="background-color:
#dfd;"> This will create and install:</span> <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">-
{{target/sitegen}}: a local copy of the static website <br>- A WAR file for installing
the documentation on an application server <br>- PDF file for the users-guide directory
<br></td></tr>
            <tr><td class="diff-unchanged" > <br></td></tr>
            <tr><td class="diff-changed-lines" >You can also deploy the site directly
by running *{{mvn <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">site:deploy}}*</span>
<span class="diff-added-words"style="background-color: #dfd;">scalate:deploy}}*</span>
afterwards, provided you have set up the correct credentials for *{{people.apache.org}}* in
*{{~/.m2/settings.xml}}*: <br></td></tr>
            <tr><td class="diff-unchanged" >{newcode:linenumbers=false} <br>&lt;settings
xmlns=&quot;http://maven.apache.org/SETTINGS/1.0.0&quot; <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
        </table>
</div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <p>The ServiceMix documentation project aims to build a set of manuals for ServiceMix
using <a href="http://scalate.fusesource.org" class="external-link" rel="nofollow">Scalate</a>.</p>

<h3><a name="Documentationproject-Sampleoutput"></a>Sample output</h3>
<p>For ServiceMix 4.3-SNAPSHOT: <a href="http://servicemix.apache.org/docs/4.3.0-SNAPSHOT/"
class="external-link" rel="nofollow">http://servicemix.apache.org/docs/4.3.0-SNAPSHOT/</a></p>

<h3><a name="Documentationproject-Sourcecode"></a>Source code</h3>
<p>The source code for this project can be found at</p>
<ul>
	<li><a href="https://svn.apache.org/repos/asf/servicemix/documentation/" class="external-link"
rel="nofollow">https://svn.apache.org/repos/asf/servicemix/documentation/</a></li>
	<li>git://git.apache.org/servicemix-documentation.git</li>
</ul>


<p>Branches:</p>
<ul>
	<li><tt>trunk</tt> refers to the next development version of ServiceMix
(currently 4.3-SNAPSHOT)</li>
</ul>


<h3><a name="Documentationproject-Prerequisites"></a>Prerequisites</h3>
<p>Before being able to build and run this project, you need to download and install:</p>
<ul>
	<li><a href="http://pygments.org/" class="external-link" rel="nofollow">Pygments</a>
: <a href="http://pygments.org/download/" class="external-link" rel="nofollow">http://pygments.org/download/</a></li>
	<li><a href="/confluence/pages/createpage.action?spaceKey=SM&amp;title=princexml.com&amp;linkCreation=true&amp;fromPageId=20644423"
class="createlink">Prince XML</a> : <a href="http://princexml.com/download/" class="external-link"
rel="nofollow">http://princexml.com/download/</a></li>
</ul>


<h3><a name="Documentationproject-Projectlayout"></a>Project layout</h3>
<p>The project is a basic Maven WAR project.  Some important directories and files in
the project:</p>
<ul>
	<li><tt>src/main/webapp/commands</tt> : TOC and index files for Console
Commands manual section</li>
	<li><tt>src/main/webapp/karaf</tt> : TOC and index files for Karaf manual
section</li>
	<li><tt>src/main/webapp/users-guide</tt> : The ServiceMix User's Guide
section</li>
	<li><tt>src/main/webapp/WEB-INF/scalate/layouts</tt> : Scalate SSP templates
for the site</li>
</ul>


<h3><a name="Documentationproject-Buildinganddeploying"></a>Building and
deploying</h3>
<p>The documentation can be built by running <b><tt>mvn clean install</tt></b>
on the documentation project.  This will create and install:</p>
<ul class="alternate" type="square">
	<li><tt>target/sitegen</tt>: a local copy of the static website</li>
	<li>A WAR file for installing the documentation on an application server</li>
	<li>PDF file for the users-guide directory</li>
</ul>


<p>You can also deploy the site directly by running <b><tt>mvn scalate:deploy</tt></b>
afterwards, provided you have set up the correct credentials for <b><tt>people.apache.org</tt></b>
in <b><tt>~/.m2/settings.xml</tt></b>:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<script type="syntaxhighlighter" class="toolbar: false; theme: Default; brush: java; gutter:
false"><![CDATA[
&lt;settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd"&gt;
  &lt;servers&gt;
    &lt;server&gt;
      &lt;id&gt;people.apache.org&lt;/id&gt;
      &lt;username&gt;gertv&lt;/username&gt;
      &lt;!-- either one of these authentication methods --&gt;
      &lt;privateKey/&gt;
      &lt;password/&gt;
    &lt;/server&gt;
  &lt;/servers&gt;
  
&lt;/settings&gt;
]]></script>
</div></div>

<h3><a name="Documentationproject-Hudsonbuilds"></a>Hudson builds</h3>
<p>A Hudson build has been set up for trunk in <a href="http://hudson.zones.apache.org/hudson/job/ServiceMix-Docs/"
class="external-link" rel="nofollow">http://hudson.zones.apache.org/hudson/job/ServiceMix-Docs/</a></p>

<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16"
align="absmiddle" alt="" border="0"></td><td><b>No automatic deployment</b><br
/>At the moment, we're unable to deploy updates to the documentation automatically from
the Hudson builds.</td></tr></table></div>



    </div>
        <div id="commentsSection" class="wiki-content pageSection">
        <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
        </div>
        <a href="https://cwiki.apache.org/confluence/display/SM/Documentation+project">View
Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=20644423&revisedVersion=3&originalVersion=2">View
Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/SM/Documentation+project?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message