Wagon: Deploying sitegen to repository

hawtio · Apr 18, 2013 · 6959149 · 6959149
1 parent 19fddc3
commit 6959149
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 28 deletions.
diff --git a/building/index.html b/building/index.html
@@ -130,7 +130,7 @@ <h3 id = "Trying_Different_Containers">Trying Different Containers</h3>
 mvn jboss-as:run
 mvn jetty:run</code></pre>
 
-<h3 id = "LiveReload_and_other_containers">LiveReload and other containers</h3>
+<h3 id = "Using_your_build__span_class__amp___amp___span__LiveReload_inside_web_containers_containers">Using your build <span class="amp">&amp;</span> LiveReload inside web containers containers</h3>
 
 <p>The easiest way to use other containers and still get the benefits of LiveReload is to create a symbolic link to the generated hawtio-web war in expanded form, in the deploy directory in your web server.</p>
 
@@ -146,6 +146,17 @@ <h3 id = "LiveReload_and_other_containers">LiveReload and other containers</h3>
 
 <p>Now just run Tomcat as normal. You should have full LiveReload support and should not have to stop/start Tomcat or recreate the WAR etc!</p>
 
+<h4 id = "Using_your_build_from_inside_Jetty">Using your build from inside Jetty</h4>
+
+<p>For jetty you need to name the symlink directory <strong>hawtio.war</strong> for <a href="http://www.eclipse.org/jetty/documentation/current/automatic-webapp-deployment.html">Jetty to recognise it</a>.</p>
+
+<pre><code>cd jetty-distribution/webapps
+ln -s ~/hawtio/hawtio-web/target/hawtio-web-1.1-SNAPSHOT hawtio.war</code></pre>
+
+<p>Another thing is for symlinks jetty uses the real directory name rather than the symlink name for the context path.</p>
+
+<p>So to open the application in Jetty open <a href="http://localhost:8080/hawtio-web-1.1-SNAPSHOT/">http://localhost:8080/hawtio-web-1.1-SNAPSHOT/</a></p>
+
 <h3 id = "Incremental_Compile_with_TypeScript">Incremental Compile with TypeScript</h3>
 
 <p>There is a handy shell script <a href="https://github.com/hawtio/hawtio/blob/master/hawtio/compileTS">compileTS</a> which wraps up using the <em>tsc</em> command to compile the <a href="https://github.com/hawtio/hawtio/tree/master/hawtio/src/main/webapp/js">TypeScipt *.ts files</a> into the <a href="https://github.com/hawtio/hawtio/blob/master/hawtio/src/main/webapp/js/app.js">webapp/js/app.js file</a></p>
@@ -193,7 +204,7 @@ <h2 id = "Running_the_End-to-End_Integration_Tests">Running the End-to-End Integ
 
 <p>To get the latest greatest testacular crack (e.g. so console.log() statements output to the command shell, etc.) you need 0.5.x or later use this command:</p>
 
-<pre><code>npm install -g testacular@&quot;~0.5.7&quot;</code></pre>
+<pre><code>npm install -g testacular@"~0.5.7"</code></pre>
 
 <h3 id = "Running_Tests_With_Testacular">Running Tests With Testacular</h3>
 

diff --git a/changelog.html b/changelog.html
@@ -57,25 +57,27 @@ <h1 id = "hawtio_change_log">hawtio change log</h1>
 
 <h1 id = "1_1__in_progress_">1.1 (in progress)</h1>
 
-<p>Added the following new plugins:</p>
+<ul>
+<li><p>Added the following new plugins:</p>
 
 <ul>
 <li><a href="https://github.com/hawtio/hawtio/blob/master/hawtio-web/src/main/webapp/app/forms/doc/developer.md">forms</a></li>
 <li><a href="http://hawt.io/plugins/infinispan/">infinispan</a></li>
 <li><a href="http://hawt.io/plugins/jclouds/">jclouds</a></li>
 <li><a href="http://hawt.io/plugins/maven/">maven</a></li>
 <li><a href="https://github.com/hawtio/hawtio/blob/master/hawtio-web/src/main/webapp/app/tree/doc/developer.md">tree</a></li>
+</ul></li>
+<li><p>Added a new real time Camel profile view and the first version of a web based wiki based camel editor</p></li>
+<li><p>Added more flexible documentation system</p></li>
+<li><p>Fixes <a href="https://github.com/hawtio/hawtio/issues?milestone=2&amp;state=closed">these issues and enhancements</a></p></li>
 </ul>
 
-<p>Added more flexible documentation system</p>
-
-<p>Fixes <a href="https://github.com/hawtio/hawtio/issues?milestone=2&amp;state=closed">these issues and enhancements</a></p>
-
 <h1 id = "1_0">1.0</h1>
 
-<p>First main release of hawtio with <a href="http://hawt.io/plugins/index.html">lots of hawt plugins</a>.</p>
-
-<p>Fixes <a href="https://github.com/hawtio/hawtio/issues?milestone=1&amp;state=closed">these 74 issues and enhancements</a></p>
+<ul>
+<li>First main release of hawtio with <a href="http://hawt.io/plugins/index.html">lots of hawt plugins</a>.</li>
+<li>Fixes <a href="https://github.com/hawtio/hawtio/issues?milestone=1&amp;state=closed">these 74 issues and enhancements</a></li>
+</ul>
 
 <p></div>
   </div></p>

diff --git a/configuration/index.html b/configuration/index.html
@@ -62,39 +62,39 @@ <h2 id = "hawtio_configuration">hawtio configuration</h2>
 
 <p>The following table contains the various configuration settings you can set via Java system properties or environment variables.</p>
 
-<p>You can also specify these via the <em>context parameters</em> in your <strong>web.xml</strong>. e.g. you can make your own WAR which depends on the hawtio-web.war like the <a href="https://github.com/hawtio/hawtio/blob/master/sample/pom.xml#L17">sample project's pom.xml</a> then you can create your own custom web.xml file such as the <a href="https://github.com/hawtio/hawtio/blob/master/sample/src/main/webapp/WEB-INF/web.xml#L24">sample project's web.xml</a>.</p>
+<h4 id = "web_application_configuration">web application configuration</h4>
 
-<p>e.g. add this to your web.xml</p>
+<p>If you are using a web container, the easiest way to change these configuration values is </p>
 
-<pre><code>&lt;listener&gt;
-  &lt;listener-class&gt;io.hawt.git.GitContextListener&lt;/listener-class&gt;
-&lt;/listener&gt;
+<ul>
+<li>Create your own WAR which depends on the <strong>hawtio-default.war</strong> like the <a href="https://github.com/hawtio/hawtio/blob/master/sample/pom.xml#L17">sample project's pom.xml</a></li>
+<li>Create your own <a href="https://github.com/hawtio/hawtio/blob/master/sample/src/main/resources/blueprint.properties#L7">blueprint.properties</a> file that then can override whatever properties you require</li>
+</ul>
 
-&lt;context-param&gt;
-  &lt;param-name&gt;hawtio.config.dir&lt;/param-name&gt;
-  &lt;param-value&gt;/tmp/hawtio&lt;/param-value&gt;
-&lt;/context-param&gt;</code></pre>
+<h4 id = "OSGi_configuration">OSGi configuration</h4>
+
+<p>Just update the blueprint configuration values in OSGi config admim as you would any OSGi blueprint bundles. On OSGi all the hawtio Java modules use OSGi blueprint.</p>
 
 <h3 id = "configuration_system_properties_and_environment_variables">configuration system properties and environment variables</h3>
 
 <table class="table">
 <tr>
-<th>System Property</th><th>Environment Variable</th><th>Description</th>
+<th>System Property</th><th>Description</th>
 </tr>
 <tr>
-<td>hawtio.config.dir</td><td>HAWTIO_CONFIG_DIR</td><td>The directory on the file system used to keep a copy of the configuration for hawtio; for all user settings, the dashboard configurations, the wiki etc. Typically you will push this configuration to some remote git server (maybe even github itself) so if not specified this directory will be a temporary created directory. However if you are only running one hawtio server then set this somewhere safe and you probably want to back this up!</td>
+<td>hawtio.config.dir</td><td>The directory on the file system used to keep a copy of the configuration for hawtio; for all user settings, the dashboard configurations, the wiki etc. Typically you will push this configuration to some remote git server (maybe even github itself) so if not specified this directory will be a temporary created directory. However if you are only running one hawtio server then set this somewhere safe and you probably want to back this up!</td>
 </tr>
 <tr>
-<td>hawtio.config.repo</td><td>HAWTIO_CONFIG_REPO</td><td>The URL of the remote git repository used to clone for the dashboard and wiki configuration. This defaults to <b>git@github.com:hawtio/hawtio-config.git</b> but if you forked the hawtio-config repository then you would use your own user name; e.g. <b>git@github.com:myUserName/hawtio-config.git</b></td>
+<td>hawtio.config.repo</td><td>The URL of the remote git repository used to clone for the dashboard and wiki configuration. This defaults to <b>git@github.com:hawtio/hawtio-config.git</b> but if you forked the hawtio-config repository then you would use your own user name; e.g. <b>git@github.com:myUserName/hawtio-config.git</b></td>
 </tr>
 <tr>
-<td>hawtio.config.cloneOnStartup</td><td>HAWTIO_CONFIG_CLONEONSTARTUP</td><td>If set to the value of <b>false</b> then there will be no attempt to clone the remote repo</td>
+<td>hawtio.config.cloneOnStartup</td><td>If set to the value of <b>false</b> then there will be no attempt to clone the remote repo</td>
 </tr>
 <tr>
-<td>hawtio.config.pollOnStartup</td><td>HAWTIO_CONFIG_POLLONSTARTUP</td><td>If set to the value of <b>false</b> then there will be no attempt to pull from the remote config repo on startup</td>
+<td>hawtio.config.pullOnStartup</td><td>If set to the value of <b>false</b> then there will be no attempt to pull from the remote config repo on startup</td>
 </tr>
 <tr>
-<td>hawtio.maven.index.dir</td><td>HAWTIO_MAVEN_INDEX_DIR</td><td>The directory where the maven indexer will use to store its cache and index files</td>
+<td>hawtio.maven.index.dir</td><td>The directory where the maven indexer will use to store its cache and index files</td>
 </tr>
 </table>
 

diff --git a/developers/index.html b/developers/index.html
@@ -64,7 +64,7 @@ <h1>Developers</h1>
 
 <h2 id = "Building_the_code">Building the code</h2>
 
-<p>Check out the <a href="http://hawt.io/building/index.html">how to build the code</a> if you want to start hacking on the source.</p>
+<p>Check out <a class="btn btn-primary btn-large" href="http://hawt.io/building/index.html">How To Build The Code</a> if you want to start hacking on the source.</p>
 
 <h2 id = "Architecture">Architecture</h2>
 
@@ -208,7 +208,7 @@ <h4 id = "Use_a_nested_scope_object_to_own_state_for_2_way_binding">Use a nested
 
 <p>When binding models to HTML templates; its always a good idea to use a level of indirection between the $scope and the property. So rather than binding to $scope.name, bind to $scope.entity.name then have code like</p>
 
-<pre><code>$scope.entity = { &quot;name&quot;: &quot;James&quot; };</code></pre>
+<pre><code>$scope.entity = { "name": "James" };</code></pre>
 
 <p>This means to that to reset the form you can just do</p>
 

diff --git a/getstarted/index.html b/getstarted/index.html
@@ -69,7 +69,7 @@ <h2 id = "Using_a_Servlet_Engine_or_Application_Server">Using a Servlet Engine o
 <table class="buttonTable">
   <tr>
     <td>
-      <a class="btn btn-large  btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-web/1.0/hawtio-web-1.0.war">Download hawtio-web.war</a>
+      <a class="btn btn-large  btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-default/1.0/hawtio-default-1.0.war">Download hawtio-default.war</a>
     </td>
     <td>
       <a class="btn btn-large  btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/sample/1.0/sample-1.0.war">Download sample.war</a>
@@ -88,8 +88,19 @@ <h2 id = "Using_a_Servlet_Engine_or_Application_Server">Using a Servlet Engine o
 
 <p>Copy the WAR file to your deploy directory in your container; for simplicity use the 'hawtio' context path (e.g. by copying the WAR file to <em>hawtio.war</em> in your deploy directory) then opening <a href="http://localhost:8080/hawtio/">http://localhost:8080/hawtio/</a> and you should have your hawtio console to play with.</p>
 
+<p>If you are working offline and have no access to the internet on the machines you want to use with hawtio then you may wish to 
+ <a class="btn" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-default-offline/1.0/hawtio-default-offline-1.0.war">Download hawtio-default-offline.war</a> which avoids some pesky errors appearing in your log on startup (as the default behaviour is to clone a git repo on startup for some default wiki and dashboard content).</p>
+
 <p>To see whats changed lately check out the <a href="http://hawt.io/changelog.html">change log</a>.</p>
 
+<p>If you don't see a Tomcat / Jetty / JBoss tab for your container you may need to enable JMX.</p>
+
+<h3 id = "Enable_JMX_on_Jetty_8_x">Enable JMX on Jetty 8.x</h3>
+
+<p>If you are using Jetty 8.x then JMX may not enabled by default, so make sure the following line is not commented out in <strong>jetty-distribution/start.ini</strong> (you may have to uncomment it to enable JMX).</p>
+
+<pre><code>etc/jetty-jmx.xml</code></pre>
+
 <h2 id = "Using_Apache_Karaf__Apache_Servicemix__or_Fuse_ESB">Using Apache Karaf, Apache Servicemix, or Fuse ESB</h2>
 
 <p>If you are using a developer snapshot of <a href="http://fusesource.com/products/fuse-esb-enterprise/">Fuse ESB</a> you can run:</p>