add user guide

linkedin · May 20, 2017 · 273a1d0 · 273a1d0
1 parent 124ff72
commit 273a1d0
Show file tree

Hide file tree

Showing 14 changed files with 407 additions and 4 deletions.
diff --git a/Procfile b/Procfile
@@ -1,2 +1,3 @@
 web: oncall-dev ./configs/config.yaml --skip-build-assets
 assets: build_assets watch
+doc: bash -c 'cd docs && sphinx-autobuild -H 0.0.0.0 -p ${PORT} --ignore '*~' source build/html/'
diff --git a/dev_requirements.txt b/dev_requirements.txt
@@ -3,3 +3,7 @@ pytest-mock
 requests
 gunicorn
 flake8
+Sphinx==1.5.6
+sphinxcontrib-httpdomain
+sphinx_rtd_theme
+sphinx-autobuild
diff --git a/docs/Makefile b/docs/Makefile
@@ -17,4 +17,8 @@ help:
 # 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)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
+livehtml:
+	sphinx-autobuild -b html -H 0.0.0.0 --ignore '*~' "$(SOURCEDIR)" "$(BUILDDIR)/html"
diff --git a/docs/source/_static/add-remove-rosters.gif b/docs/source/_static/add-remove-rosters.gif
diff --git a/docs/source/_static/create-event.gif b/docs/source/_static/create-event.gif
diff --git a/docs/source/_static/create-team.gif b/docs/source/_static/create-team.gif
diff --git a/docs/source/_static/show-on-cal.gif b/docs/source/_static/show-on-cal.gif
diff --git a/docs/source/_static/substitute-events.gif b/docs/source/_static/substitute-events.gif
diff --git a/docs/source/_static/swap-events.gif b/docs/source/_static/swap-events.gif
diff --git a/docs/source/_static/update-team.gif b/docs/source/_static/update-team.gif
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,4 +1,4 @@
-API
+REST API
 ========
 
 .. autofalcon:: oncall.doc_helper:app
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,10 +6,23 @@
 Welcome to Oncall's documentation!
 ==================================
 
+Oncall_ is a calendar tool designed for scheduling and managing on-call shifts.
+It is a standalone application that serves as source of truth for dynamic
+ownership information as well as contact info.
+
+.. _Oncall: http://oncall.tools
+.. _Iris: http://iris.claims
+
+At linkedin, we use Oncall together with our open-source escalation and
+messaging system Iris_. The combination of the two provide a way to manage
+on-call schedules and ensure that the person scheduled as on-call at a given
+time is notified of any issues.
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Table of contents
 
+   user_guide
    api