Update docs

docs/README.rst

@@ -1,24 +1,29 @@
-.. logparser documentation master file, created by
-   sphinx-quickstart on Thu May 31 11:27:35 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+Logparser's Documentation
+=========================
 
-Welcome to logparser's documentation!
-=====================================
+Logparser provides a toolkit and benchmarks for automated log parsing, which is a crucial step towards structured log analytics. By applying logparser, users can automatically learn event templates from unstructured logs and convert raw log messages into a sequence of structured events. 
 
-Logparser provides a toolkit and benchmarks for automated log parsing, which is a crucial step towards structured log analytics. Logparser implements a number of state-of-the-art data-driven approaches for this goal. By applying logparser, users can automatically learn event templates from unstructured logs and convert raw log messages into a sequence of structured events. 
+.. toctree::
+   :maxdepth: 1
+   :caption: Get Started
+
+   demo
 
 .. toctree::
    :maxdepth: 1
    :caption: Installation
 
+   installation/dependency
    installation/install_docker
+   installation/build_docker_image
 
 .. toctree::
    :maxdepth: 1
-   :caption: Publications
+   :caption: Tools
+
+   publication
+
 
-   reference
 
 .. toctree::
    :maxdepth: 1

docs/demo.rst

@@ -0,0 +1,24 @@
+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::
+    $ 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
+    $ 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
+
+
+
+
+
+

docs/installation/build_docker_image.md

@@ -0,0 +1,44 @@
+
+```Bash
+sudo docker run -i -t ubuntu:16.04 bash 
+
+cd home
+mkdir anaconda
+cd anaconda
+
+apt-get update
+apt-get install -y wget nano bzip2
+apt-get install -y gcc perl git
+rm -rf /var/lib/apt/lists/*
+
+wget https://repo.anaconda.com/archive/Anaconda3-5.1.0-Linux-x86_64.sh
+bash Anaconda3-5.1.0-Linux-x86_64.sh 
+source ~/.bashrc
+
+cd ~
+rm -r anaconda
+pip install deap
+
+conda create --name pyenv2 anaconda python=2.7
+
+git clone https://github.com/logpai/logparser
+
+sudo docker commit df888c72ed5a logparser
+docker login
+docker tag logparser logpai/logparser
+docker push logpai/logparser
+```
+
+sudo docker run -it logpai/logparser bash
+
+cd ~/logparser/demo
+source activate pyenv2
+python drain_demo.py
+source deactivate
+
+python MoLFI_demo.py
+
+Multiple files contained by the folder src can be copied into the target folder using:
+
+docker cp src/. mycontainer:/target
+docker cp mycontainer:/src/. target

docs/installation/dependency.rst

@@ -0,0 +1,18 @@
+Dependency
+==========
+
+The logparser toolkit has the following requirements by default. We recommend users to use `Anaconda <https://www.anaconda.com/download/#linux>`_, which is a popular Python data science platform with many common packages pre-installed.
+- python 2.7
+- scipy 
+- numpy 
+- scikit-learn 
+- pandas
+
+Some tools have additional dependency requirements:
+- SLCT: gcc 4.8.5
+- LogCluster: perl 5.22
+- MoLFI: python 3.6, deap 1.2.2
+- POP: pyspark
+
+
+

docs/installation/install_docker.rst

@@ -20,15 +20,15 @@ This is a note showing the steps of installing docker on Ubuntu platforms. If yo
             linux-image-extra-$(uname -r) \
             linux-image-extra-virtual
 
-    Download docker package file at: https://download.docker.com/linux/ubuntu/dists/trusty/pool/stable/amd64/docker-ce_17.03.2~ce-0~ubuntu-trusty_amd64.deb
+    Download docker package file `docker-ce_17.03.2~ce-0~ubuntu-trusty_amd64.deb <https://download.docker.com/linux/ubuntu/dists/trusty/pool/stable/amd64/docker-ce_17.03.2~ce-0~ubuntu-trusty_amd64.deb>`_.
     ::
 
         $ sudo dpkg -i ~/docker/docker-ce_17.03.2~ce-0~ubuntu-trusty_amd64.deb
 
 
 - **Ubuntu 16.04**
 
-    Download docker package file at: https://download.docker.com/linux/ubuntu/dists/xenial/pool/stable/amd64/docker-ce_17.03.2~ce-0~ubuntu-xenial_amd64.deb
+    Download docker package file `docker-ce_17.03.2~ce-0~ubuntu-xenial_amd64.deb <https://download.docker.com/linux/ubuntu/dists/xenial/pool/stable/amd64/docker-ce_17.03.2~ce-0~ubuntu-xenial_amd64.deb>`_.
     ::
 
         $ sudo dpkg -i ~/docker/docker-ce_17.03.2~ce-0~ubuntu-xenial_amd64.deb