Update docs

logpai · Jun 4, 2018 · 228a4f9 · 228a4f9
1 parent d6c8055
commit 228a4f9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/README.rst b/docs/README.rst
@@ -9,6 +9,7 @@ Logparser provides a toolkit and benchmarks for automated log parsing, which is
 
    demo
 
+
 .. toctree::
    :maxdepth: 1
    :caption: Installation

diff --git a/docs/demo.rst b/docs/demo.rst
@@ -1,23 +1,29 @@
 Demo
 ====
 
-The logparser toolkit is implemented with Python and requires a number of `dependency requirements <./installation/dependency.rst>`_ installed. Users are encouraged to set up the local environment for logparser. However, for ease of reproducing our benchmark results, we have also build `docker images <https://hub.docker.com/u/logpai/>`_ for the running evironments. Docker is a popular container technology used in production. If you have `docker installed <./install_docker.rst>`_, you can easily pull and run docker containers as follows::
+The logparser toolkit is implemented with Python and requires a number of `dependency requirements <./installation/dependency.html>`_ installed. Users are encouraged to set up the local environment for logparser. However, for ease of reproducing our benchmark results, we have also build `docker images <https://hub.docker.com/u/logpai/>`_ for the running evironments. Docker is a popular container technology used in production. If you have `docker installed <./install_docker.html>`_, you can easily pull and run docker containers as follows::
+
     $ mkdir logparser # Pull the logparser repository into this directory
     $ docker run --name logparser_py2 -it -v logparser:/logparser logpai/logparser:py2 bash
 
 Note that if you are going to try MoLFI, which requires Python 3, please run the following container::
-	$ mkdir logparser
+
+    $ mkdir logparser
     $ docker run --name logparser_py3 -it -v logparser:/logparser logpai/logparser:py3 bash
 
 
 After starting the docker containers, you can run the demos for logparser::
+
     $ git clone https://github.com/logpai/logparser.git /logparser/
     $ cd /logparser
     $ git checkout dev # checkout dev branch
     $ cd demo
     $ python Drain_demo.py
 
+The logparser demo/benchmark scripts will produce both event templates and structured logs in the result directory::
 
+    - HDFS_2k.log_templates.csv
+    - HDFS_2k.log_structured.csv