summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2017-08-01 22:44:01 +0200
committernicolargo <nicolas@nicolargo.com>2017-08-01 22:44:01 +0200
commit45f530c507d768fe822716840b3cab22b23327bb (patch)
tree34a0dd1c099db8b3d3c302f14afad464d736d70a
parentcaeb07192a0d5fd0e232b1f695f578ac38f2c0a4 (diff)
Improve documentation
-rw-r--r--NEWS4
-rw-r--r--docs/gw/index.rst1
-rw-r--r--docs/gw/json.rst8
-rw-r--r--docs/man/glances.12
4 files changed, 5 insertions, 10 deletions
diff --git a/NEWS b/NEWS
index 90f835a9..a84bb4fe 100644
--- a/NEWS
+++ b/NEWS
@@ -7,9 +7,9 @@ Version NEXT RELEASE
Enhancements and new features:
- * [WIP] Refactoring of the WebUI
* New export plugin: standard and configurable Restfull exporter (issue #1129)
- * Add a JSON export module
+ * Add a JSON export module (issue #1130)
+ * [WIP] Refactoring of the WebUI
Bugs corrected:
diff --git a/docs/gw/index.rst b/docs/gw/index.rst
index c4a18528..26041717 100644
--- a/docs/gw/index.rst
+++ b/docs/gw/index.rst
@@ -15,6 +15,7 @@ to providing stats to multiple services (see list below).
couchdb
elastic
influxdb
+ json
kafka
opentsdb
prometheus
diff --git a/docs/gw/json.rst b/docs/gw/json.rst
index 44330d12..4bffccc6 100644
--- a/docs/gw/json.rst
+++ b/docs/gw/json.rst
@@ -3,14 +3,8 @@
JSON
====
-It's possible to export stats to a JSON file to be processed later by an
-external system.
+It's possible to export stats to a JSON file.
.. code-block:: console
$ glances --export-json /tmp/glances.json
-
-JSON file description:
-
-Each line would contain a JSON glance of the system. If this file needs to be
-processed it should be processed in a line by line basis.
diff --git a/docs/man/glances.1 b/docs/man/glances.1
index 454c001e..2ab7086b 100644
--- a/docs/man/glances.1
+++ b/docs/man/glances.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "GLANCES" "1" "Jul 30, 2017" "2.10.1_DEVELOP" "Glances"
+.TH "GLANCES" "1" "Aug 01, 2017" "2.10.1_DEVELOP" "Glances"
.SH NAME
glances \- An eye on your system
.