ace-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r829678 - in /websites/staging/ace/trunk/content: ./ user-doc/user-guide.html
Date Wed, 22 Aug 2012 10:44:47 GMT
Author: buildbot
Date: Wed Aug 22 10:44:46 2012
New Revision: 829678

Staging update by buildbot for ace

    websites/staging/ace/trunk/content/   (props changed)

Propchange: websites/staging/ace/trunk/content/
--- cms:source-revision (original)
+++ cms:source-revision Wed Aug 22 10:44:46 2012
@@ -1 +1 @@

Modified: websites/staging/ace/trunk/content/user-doc/user-guide.html
--- websites/staging/ace/trunk/content/user-doc/user-guide.html (original)
+++ websites/staging/ace/trunk/content/user-doc/user-guide.html Wed Aug 22 10:44:46 2012
@@ -170,6 +170,23 @@
       <h1>ACE Users guide</h1>
       <div class="clear"></div>
       <div id="content"><p>This article describes how to use ACE and should be
a good starting point for new users of Apache ACE. The remainder of this article assumes you've
read and followed the "<a href="/user-doc/getting-started.html">Getting Started</a>"
guide, meaning that you have an ACE server successfully up and running.</p>
+<p>Revision 0.8, last updated: August 22nd, 2012.</p>
+<div class="toc">
+<li><a href="#introduction">Introduction</a></li>
+<li><a href="#workflow">Workflow</a></li>
+<li><a href="#working-with-ace-server">Working with ACE Server</a><ul>
+<li><a href="#uploading-artifacts">Uploading artifacts</a></li>
+<li><a href="#creating-a-new-feature-distribution-andor-target">Creating a new
feature, distribution and/or target</a></li>
+<li><a href="#creating-associations">Creating associations</a></li>
+<li><a href="#running-a-target">Running a target</a><ul>
+<li><a href="#using-the-template-engine-for-targets">Using the template engine
for targets</a></li>
 <h2 id="introduction">Introduction</h2>
 <p>Apache ACE is a framework that enables you to provision OSGi software(components)
in a controlled manner. What this means is that you have a central server to which clients,
or "targets" in ACE terminology, connect and fetch their software from. This allows one to
control which target gets which software. </p>
 <p>The software that is deployed to a target, is composed of one or more distributions.
A distribution is roughly similar to a piece of self-contained software. For example, think
of a distribution as C/C++ Development Tooling that you can install on the Eclipse platform.
On its own, distributions consists of one or more features, that provide pieces of functionality
to your software. The difference between a feature and distribution is that the former is
not necessarily fully self-contained: it might need other features in order to work. Each
feature groups one or more artifacts. An artifact is anything from an OSGi bundle, configuration
file or any other kind of artifact that is needed for the software to work. </p>
@@ -183,13 +200,14 @@ Assume you are working on a large OSGi-b
 <p>When all acceptance tests are successful, the new version of your software needs
to be deployed on several production environments, which is done by you, the release manager.
As most production environments only differ in a few details, such as IP addresses and database
credentials, you use the template engine of ACE to make specific configuration files for each
production target. This way, you can easily scale up your production environment by defining
new targets and provide them with the necessary configuration values.</p>
 <h2 id="working-with-ace-server">Working with ACE Server</h2>
 <p>The server UI might look a bit daunting at first, but once you become more familiar
with it, you'll see that it is rather easy to work with.<br />
-After logging in, the main window consists of two main areas:</p>
+<p><a href="ace_server_ui.png" target="_blank"><img src="ace_server_ui.png"
width="640px" title="Figure 1: The server UI of ACE, showing the control area at the top,
and the resource area below that." /></a><br />
+<strong>Figure 1</strong>: The server UI of ACE after logging in, showing the
control area at the top, and the resource area below that (click on image to see full size).</p>
+<p>After logging in, the main window consists of two main areas:</p>
 <li>The control area at the top of the screen, where you can perform actions like,
retrieving the latest repository changes, revert the changes you've made locally, add new
artifacts, and so on;</li>
 <li>The resource area, consisting of (up to) four columns showing the current artifacts,
features, distributions and targets that are known to ACE.</li>
-<p><img alt="Figure 1: ACE server UI" src="ace_server_ui.png" title="Figure 1: The
server UI of ACE, showing the control area at the top, and the resource area below that."
/><br />
 <h3 id="uploading-artifacts">Uploading artifacts</h3>
 <p>To upload one or more artifacts, you click on the "Add artifact…" button. An
"Add artifact" dialogs opened, showing both the artifacts currently in the <abbr title="OSGi
Bundle Repository">OBR</abbr> and a list of uploaded artifacts. There are two possibilities
to upload a file:</p>

View raw message