Permalink
Browse files

More docs work.

  • Loading branch information...
1 parent 692c854 commit b8c2b9bf637ff814523b738c422128373c9c4d56 @oddshocks oddshocks committed Aug 10, 2013
Showing with 38 additions and 0 deletions.
  1. +7 −0 docs/index.rst
  2. +31 −0 docs/installation.rst
View
@@ -1,6 +1,11 @@
Tahrir Documentation
====================
+**This documentation is under construction.** In the meantime, you can
+check out the
+`readme <https://raw.github.com/fedora-infra/tahrir/develop/README.rst>`_,
+which this starting documentation is being based on.
+
Tahrir is `Arabic for Liberation
<http://en.wikipedia.org/wiki/Tahrir_Square>`_.
@@ -18,6 +23,8 @@ Contents:
.. toctree::
:maxdepth: 2
+ installation
+
Indices and tables
==================
View
@@ -0,0 +1,31 @@
+Installing Tahrir
+=================
+
+You can install Tahrir to test it out with ``pip``::
+
+ pip install tahrir
+
+Deploying a Tahrir Instance
+---------------------------
+
+If you want to deploy your own Tahrir instance for reals, these are the
+instructions you want.
+
+Tahrir is `packaged for Fedora and epel6
+<https://apps.fedoraproject.org/packages/python-tahrir>`_. The authors use an
+`Ansible <http://ansibleworks.com>`_ playbook to deploy Tahrir in production.
+
+You can find our repo `here
+<http://infrastructure.fedoraproject.org/infra/ansible/>`_, our playbook `here
+<http://infrastructure.fedoraproject.org/infra/ansible/playbooks/groups/badges-web.yml>`_,
+and our Tahrir Ansible role `here
+<http://infrastructure.fedoraproject.org/infra/ansible/roles/badges-frontend/>`_.
+
+Configuration
+-------------
+
+You can get a sample configuration file suitable for production instances
+like so::
+
+ $ wget https://raw.github.com/fedora-infra/tahrir/master/production.ini -O
+ tahrir.ini

0 comments on commit b8c2b9b

Please sign in to comment.