adds documentation

.gitignore

@@ -20,4 +20,6 @@ target/
 .Failify*
 .failify*
 
+docs/_build
+
 dependency-reduced-pom.xml

README.md

@@ -1,7 +1,17 @@
 # Failify
 
-Failify is a tool for end-to-end regression testing of distributed systems. It can enforce a specific order in operations in different nodes and simulate node and network failure. It is especially important when the sequence of operations in different nodes can be undeterministic and a bug can occur only in a specific sequence. Also, it can be used to inject node and network failures in a specific time.
+[![Javadocs](https://www.javadoc.io/badge/io.failify/failify.svg)](https://www.javadoc.io/doc/io.failify/failify) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Maven Central](https://img.shields.io/maven-central/v/io.failify/failify.svg)](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22io.failify%22%20AND%20a%3A%22failify%22)
 
-# License and Development
+Failify is a new test framework for end-to-end testing of distributed systems. It can be used to deterministically inject failures during a normal test case execution. Currently, node failure, network partition, and clock drift is supported. For a few supported languages, it is possible to enforce a specific order between nodes in order to reproduce a specific time-sensitive scenario and inject failures before or after a specific method is called when a specific stack trace is present. For more information, please refer to the documentation
 
-Failify is licensed under <a href="https://opensource.org/licenses/MIT">MIT</a> and is freely available on Github. The project is built using Maven.
+# Questions
+
+To get started using Failify, look at the Failify's [User Guide](https://docs.failify.io) for your desired version. For detailed information about Failify's API take a look at its [Javadoc](https://www.javadoc.io/doc/io.failify/failify). If you still have questions, try asking in StackOverflow using failify tag or create a github issue with question label.
+
+# Contributing
+
+Contribution to Failify is welcomed and appreciated. For developer guides check out the project's [wiki](https://github.com/failify/failify/wiki). To contribute, you first need to find an open issue in the project [issues page](https://github.com/failify/failify/issues). If what you want to work on is not listed as an issue, first create an issue and discuss the importance and necessity of what you want to contribute. Then, send a pull request to be reviewed. If approved, your pull request will be merged into develop and will be included in the next release! Yaaaaay!
+
+# License
+
+Failify is licensed under [MIT](https://opensource.org/licenses/MIT) and is freely available on Github.

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,189 @@
+import xml.etree.ElementTree as ET
+import os
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'Failify'
+copyright = u'2019, Armin Balalaie'
+author = u'Armin Balalaie'
+
+tree = ET.parse(os.path.join(os.path.abspath('.'), '../pom.xml'))
+root = tree.getroot()
+for child in root:
+    if child.tag.endswith('version'):
+        version = release = child.text
+        break
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.githubpages',
+    'sphinx.ext.extlinks',
+    'javasphinx'
+]
+
+extlinks = {'javadoc': ('https://static.javadoc.io/io.failify/failify/' + version + '%s',
+                      'javadoc ')}
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+rst_prolog = """
+.. |projectName| replace:: %s
+""" % (project)
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Failifydoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Failify.tex', u'Failify Documentation',
+     u'Armin Balalaie', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'failify', u'Failify Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Failify', u'Failify Documentation',
+     author, 'Failify', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------

docs/index.rst

@@ -0,0 +1,35 @@
+.. Failify documentation master file, created by
+   sphinx-quickstart on Tue Feb  5 15:05:10 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. Replacements Definition
+
+
+=======
+Failify
+=======
+
+Introduction
+============
+
+|projectName| is a test framework for end-to-end testing of distributed systems. It can be used to deterministically inject
+failures during a normal test case execution. Currently, node failure, network partition, and clock drift is supported. For a few supported languages, it is possible to enforce a specific order between
+nodes in order to reproduce a specific time-sensitive scenario and inject failures before or after a specific method is
+called when a specific stack trace is present.
+
+
+
+
+
+.. toctree::
+    :caption: Table of Contents
+    :maxdepth: 2
+    :glob:
+
+    pages/prereq
+    pages/quickstart
+    pages/deterministic
+    pages/runseq
+    pages/jvmservice
+    pages/docker

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd