servicemix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ge...@apache.org
Subject svn commit: r1141087 - in /servicemix/website/trunk/src/main/webapp/developers: source.page source/documentation-source.page source/website-source.page tools.page
Date Wed, 29 Jun 2011 13:08:30 GMT
Author: gertv
Date: Wed Jun 29 13:08:30 2011
New Revision: 1141087

URL: http://svn.apache.org/viewvc?rev=1141087&view=rev
Log:
Add information about the documentation project

Added:
    servicemix/website/trunk/src/main/webapp/developers/source/documentation-source.page
Modified:
    servicemix/website/trunk/src/main/webapp/developers/source.page
    servicemix/website/trunk/src/main/webapp/developers/source/website-source.page
    servicemix/website/trunk/src/main/webapp/developers/tools.page

Modified: servicemix/website/trunk/src/main/webapp/developers/source.page
URL: http://svn.apache.org/viewvc/servicemix/website/trunk/src/main/webapp/developers/source.page?rev=1141087&r1=1141086&r2=1141087&view=diff
==============================================================================
--- servicemix/website/trunk/src/main/webapp/developers/source.page (original)
+++ servicemix/website/trunk/src/main/webapp/developers/source.page Wed Jun 29 13:08:30 2011
@@ -17,9 +17,13 @@ h2. ServiceMix 5.x
 
 //TODO: write something about this
 
-h2. Documentation
 
-//TODO: write something about this
+h2. [Documentation|documentation-source]
+
+The ServiceMix documentation project aims to build a set of manuals for ServiceMix using
[Scalate|http://scalate.fusesource.org].
+
+More information about the source code locations and how to build the documentation project,
can be found [here|documentation-source].
+
 
 h2. [Website|website-source]
 

Added: servicemix/website/trunk/src/main/webapp/developers/source/documentation-source.page
URL: http://svn.apache.org/viewvc/servicemix/website/trunk/src/main/webapp/developers/source/documentation-source.page?rev=1141087&view=auto
==============================================================================
--- servicemix/website/trunk/src/main/webapp/developers/source/documentation-source.page (added)
+++ servicemix/website/trunk/src/main/webapp/developers/source/documentation-source.page Wed
Jun 29 13:08:30 2011
@@ -0,0 +1,105 @@
+---
+title: Documentation Project
+--- pipeline:conf
+
+h1. Documentation Project
+
+The ServiceMix documentation project aims to build a set of manuals for ServiceMix using
[Scalate|http://scalate.fusesource.org].
+
+It's currently used to generate the contents for:
+- ServiceMix 4.3-SNAPSHOT: [http://servicemix.apache.org/docs/4.3.0-SNAPSHOT/]
+
+h2. Browsing the Source Tree
+
+h3. Web Browsing of SVN
+
+To browse the raw SVN repo, use the following URL:
+
+{panel}
+[http://svn.apache.org/repos/asf/servicemix/documentation/trunk/]
+{panel}
+
+To browse the SVN repo using [ViewVC|http://www.viewvc.org/], use the following URL:
+
+{panel}
+[http://svn.apache.org/viewvc/servicemix/documentation/trunk/]
+{panel}
+
+h3. Web Browsing of FishEye
+
+A hearty thanks to [Atlassian|http://atlassian.com/] for providing [FishEye|http://www.atlassian.com/software/fisheye/]
hosting for ServiceMix. Below is the URL to browse the Subversion repo via FishEye:
+
+{panel}
+[http://fisheye6.cenqua.com/browse/servicemix/documentation/]
+{panel}
+
+h2. Checking out the Source Tree
+
+h3. Anonymous Checkout from the ServiceMix SVN Repo
+
+This project's SVN repository can be checked out anonymously using the following command:
+
+{panel}
+*{{svn co http://svn.apache.org/repos/asf/servicemix/documentation/trunk/}}*
+{panel}
+
+h3. Committer Checkout from the ServiceMix SVN Repo
+
+ServiceMix committers can check out using the following command:
+
+{panel}
+*{{svn co https://svn.apache.org/repos/asf/servicemix/documentation/trunk/}}*
+{panel}
+
+*Only project developers can commit to the SVN tree via this method. SSH must be installed
on your client machine. Enter your site password when prompted.*
+
+h2. Project layout
+The project is a basic Maven WAR project.  Some important directories and files in the project:
+* {{src/main/webapp}} : Contains the documentation page contents
+* {{src/main/webapp/commands}} : TOC and index files for Console Commands manual section
+* {{src/main/webapp/karaf}} : TOC and index files for Karaf manual section
+* {{src/main/webapp/users-guide}} : The ServiceMix User's Guide section
+* {{src/main/webapp/WEB-INF/scalate/layouts}} : Scalate SSP templates for the site
+
+h2. Building and deploying
+
+h3. Prerequisites
+Before being able to build and run this project, you need to download and install:
+* [Pygments|http://pygments.org/] : http://pygments.org/download/
+* [Prince XML|http://princexml.com] : http://princexml.com/download/
+
+h3. Static website and WAR
+The documentation website and WAR can be built by running *{{mvn clean install}}* on the
documentation project.  This will create and install:
+- {{target/sitegen}}: a local copy of the static website
+- A WAR file for installing the documentation on an application server
+- If [Prince XML|http://princexml.com] has been installed, it will also create the PDF manuals
+
+h3. Live website for editing
+Running *{{mvn jetty:run}}* in the documentation project allows you to preview the resulting
website on http://localhost:8080.  Just edit any page and hit refresh in the browser to have
a look at the result.
+
+h3. Deploying a new documentation site copy
+You can also deploy the site directly by running *{{mvn scalate:deploy}}* afterwards, provided
you have set up the correct credentials for *{{people.apache.org}}* in *{{~/.m2/settings.xml}}*:
+{pygmentize:lang=xml}
+<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">
+  <servers>
+    <server>
+      <id>people.apache.org</id>
+      <username>gertv</username>
+      <!-- either one of these authentication methods -->
+      <privateKey/>
+      <password/>
+    </server>
+  </servers>
+
+</settings>
+{pygmentize}
+
+h2. Hudson builds
+A Hudson build has been set up for trunk in http://hudson.zones.apache.org/hudson/job/ServiceMix-Docs/
+
+{note:title=No automatic deployment}
+At the moment, we're unable to deploy updates to the documentation automatically from the
Hudson builds.
+{note}

Modified: servicemix/website/trunk/src/main/webapp/developers/source/website-source.page
URL: http://svn.apache.org/viewvc/servicemix/website/trunk/src/main/webapp/developers/source/website-source.page?rev=1141087&r1=1141086&r2=1141087&view=diff
==============================================================================
--- servicemix/website/trunk/src/main/webapp/developers/source/website-source.page (original)
+++ servicemix/website/trunk/src/main/webapp/developers/source/website-source.page Wed Jun
29 13:08:30 2011
@@ -11,23 +11,21 @@ h3. Web Browsing of SVN
 To browse the raw SVN repo, use the following URL:
 
 {panel}
-http://svn.apache.org/repos/asf/servicemix/website/trunk/
+[http://svn.apache.org/repos/asf/servicemix/website/trunk/]
 {panel}
 
 To browse the SVN repo using [ViewVC|http://www.viewvc.org/], use the following URL:
 
 {panel}
-http://svn.apache.org/viewvc/servicemix/website/trunk/
+[http://svn.apache.org/viewvc/servicemix/website/trunk/]
 {panel}
 
 h3. Web Browsing of FishEye
 
-!/images/Fisheye_logo.png!
-
 A hearty thanks to [Atlassian|http://atlassian.com/] for providing [FishEye|http://www.atlassian.com/software/fisheye/]
hosting for ServiceMix. Below is the URL to browse the Subversion repo via FishEye:
 
 {panel}
-http://fisheye6.cenqua.com/browse/servicemix/website/
+[http://fisheye6.cenqua.com/browse/servicemix/website/]
 {panel}
 
 h2. Checking out the Source Tree
@@ -36,25 +34,28 @@ h3. Anonymous Checkout from the ServiceM
 
 This project's SVN repository can be checked out anonymously using the following command:
 
-{code}
-svn co http://svn.apache.org/repos/asf/servicemix/website/trunk/
-{code}
+{panel}
+*{{svn co http://svn.apache.org/repos/asf/servicemix/website/trunk/}}*
+{panel}
 
 h3. Committer Checkout from the ServiceMix SVN Repo
 
 ServiceMix committers can check out using the following command:
 
-{code}
-svn co https://svn.apache.org/repos/asf/servicemix/website/trunk
-{code}
+{panel}
+*{{svn co https://svn.apache.org/repos/asf/servicemix/website/trunk/}}*
+{panel}
 
 *Only project developers can commit to the SVN tree via this method. SSH must be installed
on your client machine. Enter your site password when prompted.*
 
 h2. Building a new website
 
 h3. A few words about the project structure
+The project is a basic Maven WAR project.  Some important directories and files in the project:
+* {{src/main/webapp}} : Contains the documentation page contents
+* {{src/main/webapp/WEB-INF/scalate/layouts}} : Scalate SSP templates for the site
 
-This project looks like a regular Maven war project.  The source for the website pages are
living in the {{src/main/webapp}} directory.  We don't intend to release this project, the
main goal is just to upload the result of the build to http://servicemix.apache.org/staging
+We don't intend to release this project, the main goal is just to upload the result of the
build to http://servicemix.apache.org/staging
 
 h3. Build and browse locally
 
@@ -68,9 +69,19 @@ If you're a committer, you can upload a 
 Before you run this command, ensure to configure the {{people.apache.org}} server credentials
in your {{~/.m2/settings.xml}}.
 
 {pygmentize:lang=xml}
-<server>
-  <id>people.apache.org</id>
-  <username>your_apache_user_name</username>
-  <password/> or <privateKey/>
-</server>
-{pygmentize}
\ No newline at end of file
+<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">
+  <servers>
+    <server>
+      <id>people.apache.org</id>
+      <username>gertv</username>
+      <!-- either one of these authentication methods -->
+      <privateKey/>
+      <password/>
+    </server>
+  </servers>
+
+</settings>
+{pygmentize}

Modified: servicemix/website/trunk/src/main/webapp/developers/tools.page
URL: http://svn.apache.org/viewvc/servicemix/website/trunk/src/main/webapp/developers/tools.page?rev=1141087&r1=1141086&r2=1141087&view=diff
==============================================================================
--- servicemix/website/trunk/src/main/webapp/developers/tools.page (original)
+++ servicemix/website/trunk/src/main/webapp/developers/tools.page Wed Jun 29 13:08:30 2011
@@ -5,3 +5,4 @@ h3. We thank the following vendors for s
 
 | [!/images/sonar.png!|http://sonar.codehaus.org] | The Sonar Team has set up builds on their
public instance \\ (http://nemo.sonar.codehaus.org) |
 | [!/images/yourkit.jpg!|http://www.yourkit.com] | YourKit has given the ServiceMix team
free licenses. |
+| [!/images/Fisheye_logo.png!|http://www.atlassian.com/software/fisheye/] | Thanks to [Atlassian|http://atlassian.com/]
for providing [FishEye|http://www.atlassian.com/software/fisheye/] hosting for ServiceMix
|



Mime
View raw message