Doc updates

This commit is contained in:
Rashid Khan 2013-11-26 12:21:10 -07:00
parent 22993c46a5
commit e95503fef3
3 changed files with 29 additions and 22 deletions

View File

@ -1,24 +1,32 @@
= Config.js =
= Kibana =
== Configuration ==
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 ==
// src/config.js:1
=== elasticsearch ===
=== Parameters ===
// src/config.js:13
==== 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
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
// src/config.js:18
=== kibana-int ===
==== kibana-int ====
The default ES index to use for storing Kibana specific object
such as stored dashboards
// src/config.js:29
=== panel_name ===
==== 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.
// src/config.js:37

View File

@ -1,5 +1,8 @@
/** @scratch /configuration/config.js/1
* = Config.js =
*
* = Kibana =
*
* == Configuration ==
* 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.
*/
@ -8,27 +11,23 @@ function (Settings) {
"use strict";
/** @scratch /configuration/config.js/2
* == Parameters ==
* === Parameters ===
*/
return new Settings({
/** @scratch /configuration/config.js/5
*
* === elasticsearch ===
* ==== 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
* 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
*/
elasticsearch: "http://"+window.location.hostname+":9200",
/** @scratch /configuration/config.js/5
*
* === kibana-int ===
* ==== kibana-int ====
*
* The default ES index to use for storing Kibana specific object
* such as stored dashboards
@ -36,8 +35,7 @@ function (Settings) {
kibana_index: "kibana-int",
/** @scratch /configuration/config.js/5
*
* === panel_name ===
* ==== 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.

View File

@ -5,7 +5,8 @@ module.exports = function(config) {
dest: config.docsDir,
options: {
unslash: true,
extension: '.asciidoc'
extension: '.asciidoc',
annotate: '// '
}
}
}