Fix documentation.

datasweet · Feb 14, 2018 · 5b5becc · 5b5becc
1 parent 034a65f
commit 5b5becc
Show file tree

Hide file tree

Showing 8 changed files with 63 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![datasweet-logo](docs/img/datasweet.png)](http://www.datasweet.fr)
 
 Hi all !
-We are Datasweet, a french startup providing full service (big) data solutions. We tweaked Kibana to fit our needs. We are happy to release Datasweet Formula, a real time calculated metric plugin, that workds on any standard Kibana vizualisation. Check out what it can do in the [documentation.](http://www.datasweet.fr/datasweet-formula.html)
+We are Datasweet, a french startup providing full service (big) data solutions. We tweaked Kibana to fit our needs. We are happy to release Datasweet Formula, a real time calculated metric plugin, that works on any standard Kibana vizualisation. Check out what it can do in the [documentation.](http://www.datasweet.fr/datasweet-formula/)
 
 # Example : simple ratio calculation
 
@@ -12,17 +12,17 @@ We are Datasweet, a french startup providing full service (big) data solutions.
 # Installation
 This plugin is supported by : 
  - Kibana 6.x
- - Kibana >= 5.5
+ - Kibana 5.6
 
 Copy the last installation url for your version of Kibana from the [repository releases](https://github.com/datasweet-fr/kibana-datasweet-formula/releases/latest).
 ```
 ./bin/kibana-plugin install  https://github.com/datasweet-fr/kibana-datasweet-formula/releases/download/version_name/datasweet_formula-X.X.X_kibana-major.minor.patch.zip
 ```
 # Features
-Check out what it can do in the [documentation.](http://www.datasweet.fr/datasweet-formula.html)
+Check out what it can do in the [documentation.](http://www.datasweet.fr/datasweet-formula/)
 
 # Questions ? problems ? suggestions ?
-If you've found a bug or want to request a feature, please create a [GitHub Issue](https://github.com/datasweet-fr/kibana-datasweet-formula/issues/new).
+If you find a bug or want to request a feature, please create a [GitHub Issue](https://github.com/datasweet-fr/kibana-datasweet-formula/issues/new).
 
 # Credits
 Datasweet Formula is built on [Javascript Expression Evaluator](https://silentmatt.com/javascript-expression-evaluator/) by Silent Matt.

diff --git a/docs/functions/basics.md b/docs/functions/basics.md
@@ -0,0 +1,48 @@
+# Basics
+
+## Arithmetic operators
+
+* +
+* -
+* *
+* /
+* %
+* ^
+
+## Logical operators
+
+* and
+* or
+* not
+
+## Comparaison operators 
+
+* < less than
+* <= less than equal
+* == equal
+* != not equal
+* &gt; greater than
+* &gt;= greater than equal
+
+## Basics maths functions
+
+* abs
+* acos
+* acosh
+* asin
+* asinh
+* atan
+* atanh
+* ceil
+* cos
+* cosh
+* exp
+* floor
+* log (alias ln)
+* log10 (alias lg)
+* round
+* sinh
+* sqrt
+* tan
+* tanh
+* trunc
diff --git a/docs/functions/filter.md b/docs/functions/filter.md
@@ -1,6 +1,6 @@
 # Function filter
 
-Returns a null value for a filter value. 
+Filter out values matching the condition in the serie, by returning a null value.
 
 ## Syntax
 ```

diff --git a/docs/functions/next.md b/docs/functions/next.md
@@ -1,6 +1,6 @@
 # Function next
 
-Shift to right a serie.
+Shift a serie to right.
 
 ## Syntax
 ```

diff --git a/docs/functions/prev.md b/docs/functions/prev.md
@@ -1,6 +1,6 @@
 # Function prev
 
-Shift to left a serie.
+Shift a serie to left.
 
 ## Syntax
 ```

diff --git a/docs/index.md b/docs/index.md
@@ -1,19 +1,22 @@
 # Datasweet Formula
 
-Datasweet Formula makes it possible to calculate a metric in real time, based on any existing metrics, in a Kibana standard vizualisation. It thus allows to create pretty much any calculation, from simple ratios to more complex, chained treatments.
+Datasweet Formula makes it possible to calculate a metric in real time, based on any existing metrics, in a Kibana standard vizualisation. It allows to create pretty much any calculation, from simple ratios to more complex, chained treatments.
 
 ![tutorial-datasweet-formula](img/tutorial-datasweet-formula.gif)
 
 ## Usage
 Select the metrics you need as input to your formula, then : 
 
 * Add new metric > select _Datasweet Formula_
-* Type your formula in the input textbox as follow : `aggX + aggY`, where X and Y are the #id attributed by Kibana to the metric you want as inputs.
+* Type your formula in the input textbox as follow : `aggX + aggY`, where X and Y are the #id attributed by Kibana to the metric you want as input.
+* You can apply functions to your calculation : `avg(aggX + aggY)`
+* Functions are chainables :  `floor(avg(aggX + aggY))`
+* You can use a previously set formula as input for a new one.
 
 ## Credits
 
 Datasweet Formula is built on [Javascript Expression Evaluator](https://silentmatt.com/javascript-expression-evaluator/) by Silent Matt.
 
 ## Questions ? problems ? suggestions ?
-If you've found a bug or want to request a feature, please create a [GitHub Issue](https://github.com/datasweet-fr/kibana-datasweet-formula/issues/new).
+If you find a bug or want to request a feature, please create a [GitHub Issue](https://github.com/datasweet-fr/kibana-datasweet-formula/issues/new).
 
diff --git a/docs/installation.md b/docs/installation.md
@@ -8,4 +8,4 @@ Copy the last installation url for your version of Kibana from the [repository r
 This plugin is supported by : 
 
 * Kibana 6.x
-* Kibana >= 5.5
+* Kibana >= 5.6
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -20,6 +20,7 @@ pages:
   - About: about.md
   - Installation: installation.md
   - Functions List:
+    - functions/basics.md
     - functions/avg.md
     - functions/count.md
     - functions/cusum.md