Skip to content

Commit

Permalink
upgraded the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kwameboame committed Sep 27, 2017
1 parent 7821ed4 commit 6dabeb1
Show file tree
Hide file tree
Showing 23 changed files with 119 additions and 335 deletions.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/installation.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/user_management.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/using_kakum.doctree
Binary file not shown.
1 change: 0 additions & 1 deletion docs/build/html/_sources/index.rst.txt
Expand Up @@ -18,7 +18,6 @@ Guide

introduction
installation
settings
establishing_kakum
using_kakum
user_management
Expand Down
32 changes: 28 additions & 4 deletions docs/build/html/_sources/installation.rst.txt
@@ -1,9 +1,33 @@
Installation Guide
==================
* Settings
* Fetching
* Input (Social Media, SMS, WhatsApp Web) Feedback Authentication
* Generating Issues Tokens

You can get Kakum by cloning it in your local development environment. Make sure you have git installed and run the following command

``git clone https://bitbucket.org/penplusbytes/kakum``

Kakum runs on python 2.7 so if you don't have it, you need to get it. If you have 3.x and 2.7 installed, switch to 2.7 by giving it priority in your PATH settings in environment variables.

After switching to python 2.7, create a virtual environment by running:

``mkvirtual env envname``

'envname' should be replaced with your desired name.

Choose a secret key and export it to the environment:

``set SECRET_KEY=your_secret_key``

'your_secret_key' should be replaced with a key of your choice.

The next step is to install dependencies. Run this command:

``pip install -r requirements.txt``

Now, run the local server:

``python manage.py runserver``

You will see the app running at localhost:8000


* :ref:`genindex`
Expand Down
14 changes: 8 additions & 6 deletions docs/build/html/_sources/user_management.rst.txt
@@ -1,14 +1,16 @@
User Management
===============

User privileges
---------------
* Allows you to add Super user.
* Allows you to add other users.
* Gives information on all users.

Creating a New User
-------------------
**User roles:**
* Website Users
* Backend Users
* Kakum Adminstrators
* Stakeholder

Support
-------


* :ref:`genindex`
Expand Down
42 changes: 4 additions & 38 deletions docs/build/html/_sources/using_kakum.rst.txt
Expand Up @@ -107,28 +107,11 @@ This is the general comments tab

**View comments**
| View Status (3 actions)
* Change verification status
* Escalate to official
* Resolve
| * Change verification status
| * Escalate to official
| * Resolve

User Management
---------------
* Allows you to add Super user.
* Allows you to add other users.
* Gives information on all users.

**User roles:**
* Website Users
* Backend Users
* Kakum Adminstrators
* Stakeholder



Reports Page Activities
-----------------------

Issue Analysis
---------------

Expand All @@ -138,21 +121,4 @@ Search Page

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. +------------------------+------------------+---------------+
.. | NAME OF LINK | CHARACTERISTICS | CONTENT |
.. +========================+==================+===============+
.. | Dashboard | column 2 | column 3 |
.. +------------------------+------------------+---------------+
.. | Projects | ... | ... |
.. +------------------------+------------------+---------------+
.. | Issues | ... | ... |
.. +------------------------+------------------+---------------+
.. | Knowledge Center | ... | ... |
.. +------------------------+------------------+---------------+
.. | Comments | ... | ... |
.. +------------------------+------------+----------+
.. | User Management | ... | ... |
.. +------------------------+------------+----------+
* :ref:`search`
1 change: 0 additions & 1 deletion docs/build/html/genindex.html
Expand Up @@ -66,7 +66,6 @@ <h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="establishing_kakum.html">Establishing Kakum</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_kakum.html">Using Kakum</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_management.html">User Management</a></li>
Expand Down
16 changes: 1 addition & 15 deletions docs/build/html/index.html
Expand Up @@ -56,12 +56,6 @@ <h1>Guide<a class="headerlink" href="#guide" title="Permalink to this headline">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="settings.html#fetching">Fetching</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html#input-social-media-sms-whatsapp-web-feed-authentication">Input (Social Media, SMS, WhatsApp Web) Feed Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html#generating-issues-tokens">Generating Issues Tokens</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="establishing_kakum.html">Establishing Kakum</a><ul>
<li class="toctree-l2"><a class="reference internal" href="establishing_kakum.html#feedback-monitoring-checklist">Feedback Monitoring Checklist</a></li>
</ul>
Expand All @@ -72,18 +66,11 @@ <h1>Guide<a class="headerlink" href="#guide" title="Permalink to this headline">
<li class="toctree-l2"><a class="reference internal" href="using_kakum.html#issues">Issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_kakum.html#knowledge-center">Knowledge Center</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_kakum.html#comments">Comments</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_kakum.html#user-management">User Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_kakum.html#reports-page-activities">Reports Page Activities</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_kakum.html#issue-analysis">Issue Analysis</a></li>
<li class="toctree-l2"><a class="reference internal" href="using_kakum.html#search-page">Search Page</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_management.html">User Management</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_management.html#user-privileges">User privileges</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_management.html#creating-a-new-user">Creating a New User</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_management.html#support">Support</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_management.html">User Management</a></li>
<li class="toctree-l1"><a class="reference internal" href="indices_tables.html">Indices and Tables</a></li>
</ul>
</div>
Expand Down Expand Up @@ -116,7 +103,6 @@ <h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="establishing_kakum.html">Establishing Kakum</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_kakum.html">Using Kakum</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_management.html">User Management</a></li>
Expand Down
25 changes: 14 additions & 11 deletions docs/build/html/installation.html
Expand Up @@ -24,7 +24,6 @@
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Settings" href="settings.html" />
<link rel="prev" title="Introduction" href="introduction.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />
Expand All @@ -43,14 +42,20 @@

<div class="section" id="installation-guide">
<h1>Installation Guide<a class="headerlink" href="#installation-guide" title="Permalink to this headline"></a></h1>
<blockquote>
<div><ul class="simple">
<li>Settings</li>
<li>Fetching</li>
<li>Input (Social Media, SMS, WhatsApp Web) Feedback Authentication</li>
<li>Generating Issues Tokens</li>
</ul>
</div></blockquote>
<p>You can get Kakum by cloning it in your local development environment. Make sure you have git installed and run the following command</p>
<p><code class="docutils literal"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://bitbucket.org/penplusbytes/kakum</span></code></p>
<p>Kakum runs on python 2.7 so if you don’t have it, you need to get it. If you have 3.x and 2.7 installed, switch to 2.7 by giving it priority in your PATH settings in environment variables.</p>
<p>After switching to python 2.7, create a virtual environment by running:</p>
<p><code class="docutils literal"><span class="pre">mkvirtual</span> <span class="pre">env</span> <span class="pre">envname</span></code></p>
<p>‘envname’ should be replaced with your desired name.</p>
<p>Choose a secret key and export it to the environment:</p>
<p><code class="docutils literal"><span class="pre">set</span> <span class="pre">SECRET_KEY=your_secret_key</span></code></p>
<p>‘your_secret_key’ should be replaced with a key of your choice.</p>
<p>The next step is to install dependencies. Run this command:</p>
<p><code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code></p>
<p>Now, run the local server:</p>
<p><code class="docutils literal"><span class="pre">python</span> <span class="pre">manage.py</span> <span class="pre">runserver</span></code></p>
<p>You will see the app running at localhost:8000</p>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
Expand All @@ -77,7 +82,6 @@ <h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="establishing_kakum.html">Establishing Kakum</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_kakum.html">Using Kakum</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_management.html">User Management</a></li>
Expand All @@ -89,7 +93,6 @@ <h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="introduction.html" title="previous chapter">Introduction</a></li>
<li>Next: <a href="settings.html" title="next chapter">Settings</a></li>
</ul></li>
</ul>
</div>
Expand Down
Binary file modified docs/build/html/objects.inv
Binary file not shown.
1 change: 0 additions & 1 deletion docs/build/html/search.html
Expand Up @@ -89,7 +89,6 @@ <h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="establishing_kakum.html">Establishing Kakum</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_kakum.html">Using Kakum</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_management.html">User Management</a></li>
Expand Down

0 comments on commit 6dabeb1

Please sign in to comment.