svn commit: r859089 - in /websites/staging/sling/trunk/content: ./ documentation/bundles/sling-health-check-tool.html

[bu...@apache.org]

Author: buildbot
Date: Fri Apr 19 09:42:59 2013
New Revision: 859089

Log:
Staging update by buildbot for sling

Modified:
    websites/staging/sling/trunk/content/   (props changed)
    websites/staging/sling/trunk/content/documentation/bundles/sling-health-check-tool.html

Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Apr 19 09:42:59 2013
@@ -1 +1 @@
-1469756
+1469761

Modified: websites/staging/sling/trunk/content/documentation/bundles/sling-health-check-tool.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/sling-health-check-tool.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/sling-health-check-tool.html Fri Apr 19 09:42:59 2013
@@ -86,10 +86,29 @@
       
       
       <h1>Sling Health Check Tool</h1>
-      <p>TODO: flesh this out.</p>
-<h2 id="section">Section...</h2>
+      <p>Based on extensible rules that check various system attributes, the Sling Health Check Tool ("hc" in short form) is used to 
+check the health of live Sling systems, based on various <em>system attributes</em> that the rules check.</p>
+<p>Default rules are provided to check JMX MBeans, OSGi bundle states, disabling of default Sling 
+accounts, JUnit tests results and the output of scripts written in any language supported by Sling.</p>
+<p>Custom rules can be created by supplying <em>RuleBuilder</em> OSGi services, see the <em>hc-sling</em> and <em>sling-demo</em> modules for examples.</p>
+<h2 id="how-to-test-the-provided-demo-rules">How to test the provided demo rules</h2>
+<p>The health check tool is currently (April 2013) not included in the default Sling launchpad, so you need to add 
+the required bundles to a Sling trunk instance to run the demo, as follows:</p>
+<ol>
+<li>Start a standalone Sling instance from <em>launchpad/builder</em>.
+1.. Install the org.apache.sling.junit.core-1.0.8 bundle </li>
+<li>Build the <em>contrib/extensions/healthcheck</em> modules.</li>
+<li>From that module, install the <em>org.apache.sling.hc.core</em>, <em>org.apache.sling.hc.rules</em> and <em>org.apache.sling.hc.sling</em> bundles.</li>
+<li>Open http://localhost:8080/apps/hc/demo.healthcheck.json] to see the evaluation result of the rules defined at http://localhost:8080/apps/hc/demo.tidy.4.json</li>
+</ol>
+<h2 id="known-issues">Known issues</h2>
+<p>See <a href="https://issues.apache.org/jira/browse/SLING-2822">SLING-2822</a> for details.</p>
+<h2 id="todo-for-this-page">TODO for this page</h2>
+<ul>
+<li>Describe the JSON evaluation output</li>
+</ul>
       <div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
-        Rev. 1469756 by bdelacretaz on Fri, 19 Apr 2013 09:29:03 +0000
+        Rev. 1469761 by bdelacretaz on Fri, 19 Apr 2013 09:42:51 +0000
       </div>
       <div class="trademarkFooter"> 
         Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project