* Restucture the user documentation and add an overview of the high l…

…evel design of Kala.

docs/user/documents.rst

@@ -0,0 +1,11 @@
++++++++++++++
+Document Page
++++++++++++++
+
+On the Document page you can **upload** a new version by following the same steps as above, choose the file, fill out
+the description, click upload.
+
+If you are a document manager, you can also **move** a Document to a different Project by selecting the Project in the
+"Projects" select box, then clicking the "Move Document" button.
+
+You can also **delete** Documents from this page if you are an administrator.

docs/user/home.rst

@@ -0,0 +1,18 @@
+----
+Home
+----
+
+Once logged in the user will be presented with the "Home Page". From this page the user will see a list of all of the
+documents that they have worked on recently. In the middle of the page there is a list of projects that the user has 
+access too.
+
+From the Home Page, one can click on any of the links in the **navigation bar**. To access **Projects** and the
+associated resources, click on the Projects button.
+
+To get **information about Users** that you are working, such as email or phone number you can click on the Users
+button. The Users section of the application is also where and administrator can create and manage Users, more
+on this below.
+
+In **My Accounts** you can use the **Edit Profile** link to edit your personal information, such as email address, name,
+phone, etc... you can also use the My Accounts to logout of the application.
+

docs/user/index.rst

@@ -1,132 +1,30 @@
-
 ==========
 User Guide
 ==========
 
-Every person that requires access to the system must be invited by an administrator or resource owner.
-Once the user has an email registered with a password, they can then go the login page, which will be 
-the default landing page if the user is not logged in. On the login page the user can then log into the system.
-
-----
-Home
-----
-
-Once logged in the user will be presented with the "Home Page". From this page the user will see a list of all of the
-documents that they have worked on recently. In the middle of the page there is a list of projects that the user has 
-access too.
-
-From the Home Page, one can click on any of the links in the **navigation bar**. To access **Projects** and the
-associated resources, click on the Projects button.
-
-To get **information about Users** that you are working, such as email or phone number you can click on the Users
-button. The Users section of the application is also where and administrator can create and manage Users, more
-on this below.
-
-In **My Accounts** you can use the **Edit Profile** link to edit your personal information, such as email address, name,
-phone, etc... you can also use the My Accounts to logout of the application.
-
---------
-Projects
---------
-
-The Projects page is where you select which project you would like to work with. When you first start on this page you
-will be presented with a list of Organizations that you are associated with, and a list of the Projects that you are
-working on for the Organizations.
-
-If you are a manager (or administrator) you will also be able to **create** new projects from this page. To create a new Project,
-you can enter the name of the new Project and select which Organization you want to create the Project under. Then click the
-"Create Project" button and the new Project will be created.
-
-
-++++++++++++
-Project Page
-++++++++++++
-
-Once you have selected a Project to work on from the Projects Page, you will be taken to the Project page. This is
-where you can interact with the Project's resources. In the Documents tab, you can **upload** a new Document by choosing
-the file to upload, the giving the file a description. Once you have done this, you can click the "Upload Document"
-button to upload the new Document.
-
-You can also **sort** the Documents either by Date - newest to oldest - or you can sort the Documents alphabetically - A
-to Z -. You will need to click the "Sort Documents" button to have the sorting take effect. You can also filter the
-Documents by the files type. If you only want to see images in click the "Filter by Category" select box, select images
-then click "Sort Documents".
-
-If you would like to **create a new version** of a Document, you can do that from this page as well. To do this, find
-the Document that you would like to upload a new version to, then click the "Add Version" link. Follow the same
-instructions for uploading a Document as listed above.
-
-If you are a project manager you can also **move** the Project to another Organization by click the "Organization" select box,
-selecting the new Organization, then clicking the "Move Project" button.
-
-Administrators can also **change the permissions** for the Project by clicking on the "Edit Permissions" link in the
-breadcrumb below the navigation bar.
-
-
-+++++++++++++
-Document Page
-+++++++++++++
-
-On the Document page you can **upload** a new version by following the same steps as above, choose the file, fill out
-the description, click upload.
-
-If you are a document manager, you can also **move** a Document to a different Project by selecting the Project in the
-"Projects" select box, then clicking the "Move Document" button.
-
-You can also **delete** Documents from this page if you are an administrator.
-
-++++++++++++++++
-Edit Permissions
-++++++++++++++++
-
-The Edit Permissions page allows an administrator to **grant access** to Users for a given Project. The page will
-present the administrator with an accordion list of Organizations. To grant access to Users, click on a Organization name, this
-will open the accordion, and display a the list of Users within the Organization. You can then either select/unselect an
-individual Person, or you can select/unselect the entire Organization. When you have completed your changes, click on the
-"Update Permissions" button at the bottom of the page to save the changes you have made.
-
-------
-Users
-------
-
-The Users page allows a user to view all of the Users that they work with. **If you need to know contact information**
-this is the page to look in.
-
-If you are an administrator this page also allows you to **create new Organizations** by filling in the Organization name, then
-clicking on the "Create Organization" button. Once the Organization has been created an admin can then click on the "Edit" link
-next to the Organization name to edit the details of the Organization.
+Welcome to the Kala documentation. This guide describes the general philosophy
+of the application, as well as, detailing the specific operations of each section
+of the application.
 
-An administrator can also **create a new Person** by filling in the email address, first name, last name, and selecting
-a Organization that the Person will be in, then by clicking on the "Create Person" button, a new Person will be created. You
-can then edit the details of the Person by clicking the "Edit" link next to the Persons name. **Editing a Person** from
-this page will take you to the "Edit Profile" page, which is described below.
+The main concept of Kala is a hierarchical layout. At the top of the tree is the Organization. For smaller organizations or businesses there might be only one Organization (as shown in the diagram below) but Kala can be configured to have as many Organizations as you wish. For instance, you may want to give each functional unit it’s own Organization, or perhaps a sub contractor should be an Organization within the application. This guide will attempt to provide suggestions on how to divide the application, but it is left to the users and administrators to find the right balance between Organizations and Projects.
 
-An administrator can also un-delete a Organization by selecting the deleted Organization in the "Deleted Organizations" select box,
-and click the "Un-delete Organization" button. This will un-deleted all the Users, Projects and resources associated with
-the Organization.
+Projects always reside within an Organization. Any permissions given to a User at an Organizational level will be propagated through to all of the Projects in that Organization. Likewise all permissions at the Project level will be passed on to all of the Projects Documents.
 
-+++++++++++++++
-Organization Details
-+++++++++++++++
+Documents are a collection of uploaded artifacts to the application. Documents can have associated Users and Permissions of their own. Each Document also has one or more Versions. Each Version has it’s own metadata, such as who was the User that uploaded the Version, comments about the Version and a timestamp of when the Version was uploaded.
 
-If you click the "Edit" link for a Organization, the Organization details page will come up. From here you can **edit the
-Organizations information** such as the website, address, timezone and other information.
+This diagram is a visual representation of how a small business might use Kala to organize their documents. In this example, the business has decided that one Organization “Custom Design Inc” is appropriate. In this case one could image that only upper management would have permissions at the Organization level. There are 3 Projects in this Organization, "Fiscal", "Engineering", and "HR". At the Project level it would be appropriate to give Project Managers, Leads, etc. permissions on the respective Project. At the Document level (the most fine grained) you might invite in house team members to work on a specific document, or maybe a 3rd party contractor would be invited to collaborate on a specific Document, by uploading new version for review.
 
-You can also **delete** a Organization on this page by clicking the "Delete Organization" button.
 
-------------
-Edit Profile
-------------
+.. image:: _imgs/kala_foundation.png
 
-The Edit Profile page is where you can **edit** either your own information or if you are an administrator, you can edit
-the information of other Users.
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
 
-You can also **change your password** or that of others as an administrator from this page, by filling in the password
-and confirm text boxes then clicking the "Update Profile" button.
+    Permissions <permissions>
+    Home Page & Navigation <home>
+    Organizations <organizations>
+    Projects <projects>
+    Documents & Versions <documents>
 
-As an administrator you can **delete** a Person here by clicking the "Delete Person", you can also **toggle the
-administrative privileges flag** for a Person click clicking the "Grant/Remove Admin" button.
 
-Finally you can grant a Person access to Projects by clicking on the projects tab, then selecting a Organization name from
-the accordion list, and selecting/unselecting either a single project or you can grant/remove access to all a Organizations
-projects by clicking the "Select/Unselect All" all checkbox. When you are done, click the "Save Permissions" button.

docs/user/organizations.rst

@@ -0,0 +1,8 @@
+++++++++++++++++++++
+Organization Details
+++++++++++++++++++++
+
+If you click the "Edit" link for a Organization, the Organization details page will come up. From here you can **edit the
+Organizations information** such as the website, address, timezone and other information.
+
+You can also **delete** a Organization on this page by clicking the "Delete Organization" button.

docs/user/permissions.rst

@@ -0,0 +1,56 @@
+-----------
+Permissions
+-----------
+
+Every person that requires access to the system must be invited by an administrator or resource owner.
+Once the user has an email registered with a password, they can then go the login page, which will be 
+the default landing page if the user is not logged in. On the login page the user can then log into the system.
+
+++++++++++++++++
+Edit Permissions
+++++++++++++++++
+
+The Edit Permissions page allows an administrator to **grant access** to Users for a given Project. The page will
+present the administrator with an accordion list of Organizations. To grant access to Users, click on a Organization name, this
+will open the accordion, and display a the list of Users within the Organization. You can then either select/unselect an
+individual Person, or you can select/unselect the entire Organization. When you have completed your changes, click on the
+"Update Permissions" button at the bottom of the page to save the changes you have made.
+
+
++++++
+Users
++++++
+
+The Users page allows a user to view all of the Users that they work with. **If you need to know contact information**
+this is the page to look in.
+
+If you are an administrator this page also allows you to **create new Organizations** by filling in the Organization name, then
+clicking on the "Create Organization" button. Once the Organization has been created an admin can then click on the "Edit" link
+next to the Organization name to edit the details of the Organization.
+
+An administrator can also **create a new Person** by filling in the email address, first name, last name, and selecting
+a Organization that the Person will be in, then by clicking on the "Create Person" button, a new Person will be created. You
+can then edit the details of the Person by clicking the "Edit" link next to the Persons name. **Editing a Person** from
+this page will take you to the "Edit Profile" page, which is described below.
+
+An administrator can also un-delete a Organization by selecting the deleted Organization in the "Deleted Organizations" select box,
+and click the "Un-delete Organization" button. This will un-deleted all the Users, Projects and resources associated with
+the Organization.
+
+
+++++++++++++
+Edit Profile
+++++++++++++
+
+The Edit Profile page is where you can **edit** either your own information or if you are an administrator, you can edit
+the information of other Users.
+
+You can also **change your password** or that of others as an administrator from this page, by filling in the password
+and confirm text boxes then clicking the "Update Profile" button.
+
+As an administrator you can **delete** a Person here by clicking the "Delete Person", you can also **toggle the
+administrative privileges flag** for a Person click clicking the "Grant/Remove Admin" button.
+
+Finally you can grant a Person access to Projects by clicking on the projects tab, then selecting a Organization name from
+the accordion list, and selecting/unselecting either a single project or you can grant/remove access to all a Organizations
+projects by clicking the "Select/Unselect All" all checkbox. When you are done, click the "Save Permissions" button.

docs/user/projects.rst

@@ -0,0 +1,36 @@
+--------
+Projects
+--------
+
+The Projects page is where you select which project you would like to work with. When you first start on this page you
+will be presented with a list of Organizations that you are associated with, and a list of the Projects that you are
+working on for the Organizations.
+
+If you are a manager (or administrator) you will also be able to **create** new projects from this page. To create a new Project,
+you can enter the name of the new Project and select which Organization you want to create the Project under. Then click the
+"Create Project" button and the new Project will be created.
+
+
+++++++++++++
+Project Page
+++++++++++++
+
+Once you have selected a Project to work on from the Projects Page, you will be taken to the Project page. This is
+where you can interact with the Project's resources. In the Documents tab, you can **upload** a new Document by choosing
+the file to upload, the giving the file a description. Once you have done this, you can click the "Upload Document"
+button to upload the new Document.
+
+You can also **sort** the Documents either by Date - newest to oldest - or you can sort the Documents alphabetically - A
+to Z -. You will need to click the "Sort Documents" button to have the sorting take effect. You can also filter the
+Documents by the files type. If you only want to see images in click the "Filter by Category" select box, select images
+then click "Sort Documents".
+
+If you would like to **create a new version** of a Document, you can do that from this page as well. To do this, find
+the Document that you would like to upload a new version to, then click the "Add Version" link. Follow the same
+instructions for uploading a Document as listed above.
+
+If you are a project manager you can also **move** the Project to another Organization by click the "Organization" select box,
+selecting the new Organization, then clicking the "Move Project" button.
+
+Administrators can also **change the permissions** for the Project by clicking on the "Edit Permissions" link in the
+breadcrumb below the navigation bar.