Added scratchy tasks and config.js docs

Gruntfile.js

@@ -8,6 +8,7 @@ module.exports = function (grunt) {
     srcDir: 'src',
     destDir: 'dist',
     tempDir: 'tmp',
+    docsDir: 'docs'
   };
 
   // load plugins

docs/configuration/config.js.asciidoc

@@ -0,0 +1,24 @@
+= Config.js =
+config.js is where you will find the core Kibana configuration. This file contains parameter that
+must be set before kibana is run for the first time.
+== Parameters ==
+
+=== elasticsearch ===
+
+The URL to your elasticsearch server. You almost certainly don't
+want 'http://localhost:9200' here. Even if Kibana and Elasticsearch are on
+the same host
+
+By default this will attempt to reach ES at the same host you have
+elasticsearch installed on. You probably want to set it to the FQDN of your
+elasticsearch host
+
+=== kibana-int ===
+
+The default ES index to use for storing Kibana specific object
+such as stored dashboards
+
+=== panel_name ===
+
+An array of panel modules available. Panels will only be loaded when they are defined in the
+dashboard, but this list is used in the "add panel" interface.

package.json

@@ -29,7 +29,8 @@
     "grunt-contrib-uglify": "~0.2.4",
     "load-grunt-tasks": "~0.2.0",
     "glob": "~3.2.7",
-    "grunt-contrib-connect": "~0.5.0"
+    "grunt-contrib-connect": "~0.5.0",
+    "grunt-scratchy": "git://github.com/rashidkpc/grunt-scratchy.git"
   },
   "license": "Apache License"
 }

src/config.js

@@ -1,36 +1,46 @@
-/**
+/** @scratch /configuration/config.js/1
- * These is the app's configuration, If you need to configure
+ * = Config.js =
- * the default dashboard, please see dashboards/default
+ * config.js is where you will find the core Kibana configuration. This file contains parameter that
+ * must be set before kibana is run for the first time.
  */
 define(['settings'],
 function (Settings) {
   "use strict";
 
+  /** @scratch /configuration/config.js/2
+   * == Parameters ==
+   */
   return new Settings({
 
-    /**
+    /** @scratch /configuration/config.js/5
-     * URL to your elasticsearch server. You almost certainly don't
+     *
-     * want 'http://localhost:9200' here. Even if Kibana and ES are on
+     * === elasticsearch ===
+     *
+     * The URL to your elasticsearch server. You almost certainly don't
+     * want 'http://localhost:9200' here. Even if Kibana and Elasticsearch are on
      * the same host
      *
      * By default this will attempt to reach ES at the same host you have
      * elasticsearch installed on. You probably want to set it to the FQDN of your
      * elasticsearch host
-     * @type {String}
      */
     elasticsearch: "http://"+window.location.hostname+":9200",
 
-    /**
+    /** @scratch /configuration/config.js/5
+     *
+     * === kibana-int ===
+     *
      * The default ES index to use for storing Kibana specific object
      * such as stored dashboards
-     * @type {String}
      */
     kibana_index: "kibana-int",
 
-    /**
+    /** @scratch /configuration/config.js/5
-     * Panel modules available. Panels will only be loaded when they are defined in the
+     *
+     * === panel_name ===
+     *
+     * An array of panel modules available. Panels will only be loaded when they are defined in the
      * dashboard, but this list is used in the "add panel" interface.
-     * @type {Array}
      */
     panel_names: [
       'histogram',

tasks/default_task.js

@@ -1,4 +1,4 @@
 // Lint and build CSS
 module.exports = function(grunt) {
-  grunt.registerTask('default', ['jshint:source', 'less:src']);
+  grunt.registerTask('default', ['jshint:source', 'less:src', 'docs']);
 };

tasks/docs_task.js

@@ -0,0 +1,4 @@
+// Lint and build CSS
+module.exports = function(grunt) {
+  grunt.registerTask('docs', ['clean:docs', 'scratchy:docs']);
+};

tasks/options/clean.js

@@ -2,5 +2,6 @@ module.exports = function(config) {
   return {
     on_start: ['<%= destDir %>', '<%= tempDir %>'],
     temp: ['<%= tempDir %>'],
+    docs: ['<%= docsDir %>']
   };
 };

tasks/options/scratchy.js

@@ -0,0 +1,12 @@
+module.exports = function(config) {
+  return {
+    docs: {
+      src: ['src/app/**/*.js','src/config.js'],
+      dest: config.docsDir,
+      options: {
+        unslash: true,
+        extension: '.asciidoc'
+      }
+    }
+  }
+};