Author: buildbot
Date: Tue Apr 29 10:26:56 2014
New Revision: 907286
Log:
Staging update by buildbot for ace
Modified:
websites/staging/ace/trunk/content/ (props changed)
websites/staging/ace/trunk/content/user-doc/getting-started.html
Propchange: websites/staging/ace/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Apr 29 10:26:56 2014
@@ -1 +1 @@
-1590938
+1590940
Modified: websites/staging/ace/trunk/content/user-doc/getting-started.html
==============================================================================
--- websites/staging/ace/trunk/content/user-doc/getting-started.html (original)
+++ websites/staging/ace/trunk/content/user-doc/getting-started.html Tue Apr 29
10:26:56 2014
@@ -165,7 +165,7 @@
<p><a href="/"><i class='icon-home'></i> Home</a> » <a
href="/user-doc/">User-doc</a></p>
<h1>Getting Started</h1>
<div class="clear"></div>
- <div id="content"><p>This guide shows the core functionality of ACE,
organizing bundles and other artifacts into logical features and distributions
and associating those with specific targets, all done using a convenient web
interface.</p>
+ <div id="content"><p>This guide shows the core functionality of ACE,
organising bundles and other artifacts into logical features and distributions
and associating those with specific targets, all done using a convenient web
interface.</p>
<h2 id="download-the-distribution">Download the distribution</h2>
<p>To start using ACE, you must first launch a server. If you're a developer,
you can do that inside Eclipse, as explained <a
href="/dev-doc/getting-started.html">here</a>. Otherwise, you need to download
a distribution of the server, unpack it, and start it up:</p>
<ol>
@@ -174,37 +174,39 @@
</ol>
<h2 id="start-the-ace-server">Start the ACE server</h2>
<ol>
-<li>Open a terminal and navigate nto the root of the distribution.</li>
-<li>Navigate to the sub directory <code>server-allinone</code>.</li>
-<li>Start the server using <code>java -jar server-allinone.jar</code></li>
+<li>Open a terminal and navigate to the root of the distribution;</li>
+<li>Navigate to the sub directory <code>server-allinone</code>;</li>
+<li>Start the server using <code>java -jar server-allinone.jar</code>.</li>
</ol>
+<p>The server is configured by means of configuration files found in the
<tt>conf</tt> directory. </p>
<h2 id="start-an-ace-target">Start an ACE target</h2>
<ol>
-<li>Open a terminal and navigate into the root of the distribution.</li>
-<li>Navigate to the sub directory <code>target</code>.</li>
-<li>Start the target using <code>java -jar target.jar</code></li>
+<li>Open a terminal and navigate into the root of the distribution;</li>
+<li>Navigate to the sub directory <code>target</code>;</li>
+<li>Start the target using <code>java -jar target.jar</code>.</li>
</ol>
+<p>Configuring the target can by done by supplying it commandline parameters,
as described in the <a href="user-guide.html#running-a-target">user
guide</a>.</p>
<h2 id="provisioning-some-bundles">Provisioning some bundles</h2>
<p>Apache ACE has both a Web UI and a <a href="restapi.html">REST API</a> to
interact with it. Both use a similar workflow. You start by checking out a copy
of the workspace, then you work on that copy, and finally you commit your
changes back to the server.</p>
<p>The following steps can be followed to get started:</p>
<ol>
-<li>Launch a browser and point it to: http://localhost:8080/ace/ You should
now be greeted with a login prompt. Log in with user "d" password "f" and you
should see a view with 4 empty columns and some buttons at the top of the
screen.</li>
-<li>Click on 'Retrieve' to get the initial version of the repository. The
column on the right will show you have a target running with name
<code>defaultTargetID</code>. The other columns remain empty as this is an
initial empty version of the repository.</li>
-<li>Upload some sample bundles into the artifacts column by first clicking the
'Add Artifact...' button. In the dialog that appears, you can upload a bundle
using the 'Upload' button in the middle of the window. You can perform this
step multiple times if you want to upload more than one bundle. Finally, hit
the 'Add' button to add all uploaded artifacts to ACE.</li>
-<li>Create a feature by clicking on the 'Add Feature...' button. Features are
the first level of logical grouping for artifacts.</li>
-<li>Create a distribution by clicking on the 'Add Distribution...' button.
Distributions are another level of logical grouping: you group features into
distributions.</li>
-<li>Drag an artifact onto a feature to create an association between the two.
By repeating this process you can associate all relevant artifacts to
features.</li>
-<li>Drag a feature onto a distribution and again repeat this process until
you've associated all your features with their relevant distributions.</li>
-<li>Drag the distribution onto the target to associate it.</li>
+<li>Launch a browser and point it to: http://localhost:8080/ace/ You should
now be greeted with a login prompt. Log in with user "d" password "f" and you
should see a view with 4 empty columns and some buttons at the top of the
screen;</li>
+<li>Click on 'Retrieve' to get the initial version of the repository. The
column on the right will show you have a target running with name
<code>defaultTargetID</code>. The other columns remain empty as this is an
initial empty version of the repository;</li>
+<li>Upload some sample bundles into the artifacts column by first clicking the
'Add Artifact...' button. In the dialog that appears, you can upload a bundle
using the 'Upload' button in the middle of the window. You can perform this
step multiple times if you want to upload more than one bundle. Finally, hit
the 'Add' button to add all uploaded artifacts to ACE;</li>
+<li>Create a feature by clicking on the 'Add Feature...' button. Features are
the first level of logical grouping for artifacts;</li>
+<li>Create a distribution by clicking on the 'Add Distribution...' button.
Distributions are another level of logical grouping: you group features into
distributions;</li>
+<li>Drag an artifact onto a feature to create an association between the two.
By repeating this process you can associate all relevant artifacts to
features;</li>
+<li>Drag a feature onto a distribution and again repeat this process until
you've associated all your features with their relevant distributions;</li>
+<li>Drag the distribution onto the target to associate it;</li>
<li>Click on 'Store' to actually store changes on the server, which should
trigger the actual deployment of the artifacts to the target.</li>
</ol>
<h2 id="validating-that-it-works">Validating that it works</h2>
<p>After following the steps listed above the bundles should have been
provisioned onto the target. But did it work? There are a lot of things that
can go wrong the first time. For example, remember you are provisioning into an
empty OSGi framework so the deployment should be able to resolve. Two ways to
debug problems are;</p>
<ol>
-<li>Inspect state and log of the target by double-clicking it in the
webui.</li>
+<li>Inspect state and log of the target by double-clicking it in the web
UI;</li>
<li>Start of by provisioning a shell to allow inspection of the target
itself.</li>
</ol>
-<p>Note: In version 1.0 the default binary target comes with a <a
href="http://felix.apache.org/site/apache-felix-gogo.html">Gogo shell</a>
pre-installed. It can be used right away.</p></div>
+<p>Note: As of version 1.0, the default target includes a <a
href="http://felix.apache.org/site/apache-felix-gogo.html">Gogo shell</a>,
allowing it to be used right away.</p></div>
<hr>
<footer>
<p>Copyright © 2012-2014 <a href="http://www.apache.org/">The
Apache Software Foundation</a>, Licensed under the <a
href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version
2.0</a>.<br/>Apache ACE, the Apache ACE logo, Apache and the Apache feather
logo are trademarks of The Apache Software Foundation. All other marks
mentioned may be trademarks or registered trademarks of their respective
owners.</p>