Reestructured documentation and extended some content

Oscar Carballal Prego · Oscar Carballal Prego · commit 38698982637a · 2013-07-17T08:42:36.000+02:00
diff --git a/source/LICENSE.rst b/source/LICENSE.rst
diff --git a/source/index.rst b/source/index.rst
@@ -1,11 +1,6 @@
-.. OpenMOOC documentation master file, created by
-   sphinx-quickstart on Tue Jun 11 09:42:28 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-====================================
-Welcome to OpenMOOC's documentation!
-====================================
+========
+OpenMOOC
+========
 
 OpenMOOC is an open source Massive Open Online Course system built on top of the
 django framework with Apache 2.0 license (see )
@@ -15,45 +10,54 @@ django framework with Apache 2.0 license (see )
 
 Installation
 ============
-.. toctree::
-   :maxdepth: 2
+   .. toctree::
+    :maxdepth: 2
 
-   install/general
-   install/idp
-   install/engine
-   install/askbot
+    install/install
+    install/idp
+    install/engine
+    install/askbot
+    install/installfaq
 
 Configuration
 =============
-.. toctree::
-   :maxdepth: 2
 
-   configure/idp
-   configure/moocng
-   configure/askbot
+   .. toctree::
+    :maxdepth: 2
+
+    configure/idp
+    configure/moocng
+    configure/askbot
 
 Manuals
 =======
-.. toctree::
-   :maxdepth: 2
 
-   manual/teacher
-   manual/student
-   manual/sentry
+   .. toctree::
+    :maxdepth: 2
+
+    manual/demostrator
+    manual/teacher
+    manual/student
+    manual/sentry
 
 Reference
 =========
-.. toctree::
-   :maxdepth: 2
+   .. toctree::
+    :maxdepth: 2
+
+    reference/mongo_structure
+
+License
+=======
 
-   reference/mongo_structure
+OpenMOOC is licensed under the terms of `Apache 2.0 <http://www.apache.org/licenses/LICENSE-2.0.html>`_.
 
-:doc:`LICENSE`
+The main header image used on OpenMOOC platform and blog was created by `Ana Isabel Rey Botello <https://github.com/anarey>`_.
 
 Indices and tables
 ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+    * :ref:`genindex`
+    * :ref:`modindex`
+    * :ref:`search`
 
diff --git a/source/install/askbot.rst b/source/install/askbot.rst
@@ -1,5 +1,5 @@
 ===============
-openmooc-askbot
+OpenMOOC Askbot
 ===============
 
 The Askbot component of OpenMOOC serves as a way to ask questions about a course.
diff --git a/source/install/engine.rst b/source/install/engine.rst
@@ -1,5 +1,5 @@
 ===============
-openmooc-engine
+OpenMOOC Engine
 ===============
 
 This is the core of the OpenMOOC platform, here you can create the courses,
diff --git a/source/install/general.rst b/source/install/general.rst
@@ -1,18 +1,5 @@
-General
-=======
-
-This documentation will help you to install OpenMOOC on your machine or virtual
-machine.
-
-Installing via RPM (Yaco repository)
-------------------------------------
-
-The preferred form of installation is via de RPM packages that are specifically
-prepared for OpenMOOC. You will need to add a new package repository to your
-repositories.
-
 Adding Yaco repository
-``````````````````````
+======================
 
 To add the Yaco repository...
 
@@ -26,7 +13,8 @@ Update your package index and system packages:
           working.
 
 Prerequisites
-`````````````
+=============
+
 The minimum version of Python needed to run OpenMOOC is 2.6. We do not support Python 3.x yet.
 
 In the process of installing moocng, both in the standard installation and
@@ -45,7 +33,7 @@ compiles a couple of Python modules.
   $ apt-get install build-essential python-dev libpq-dev libjpeg-turbo8-dev libpng12-dev
 
 Installing the web server
-`````````````````````````
+=========================
 
 The packages needed for installing Apache and wsgi support are:
 
@@ -61,7 +49,7 @@ The packages needed for installing Apache and wsgi support are:
           of your web server about how to integrate it with a WSGI application.
 
 OpenMOOC virtual package
-````````````````````````
+========================
 
 There is a virtual package that should help you to install the complete OpenMOOC
 platform without any trouble.
@@ -77,14 +65,4 @@ Run this command in the command line:
 
 .. note:: Put link to configuration of moocng here
 
-After it's installed, please follow to :doc:`../coonfigConfiguration
-
-Installing package by package
------------------------------
-
-.. toctree::
-   :maxdepth: 1
-
-   idp
-   engine
-   askbot
+After it's installed, please follow to :doc:`Configuration <../configure/idp>`
diff --git a/source/install/idp.rst b/source/install/idp.rst
@@ -14,8 +14,8 @@ In a development enviroment you can disable both:
 
 .. code-block:: bash
 
-   lokkit --selinux=disabled
-   lokkit --disabled
+  $ lokkit --selinux=disabled
+  $ lokkit --disabled
 
 In a production enviroment contact a sysadmin to configure correctly SELinux.
 
@@ -40,13 +40,13 @@ Install the packages:
 
 .. code-block:: bash
 
-   yum install openldap openldap-clients openldap-servers
+  $ yum install openldap openldap-clients openldap-servers
 
 Copy the CONFIG_BASE file:
 
 .. code-block:: bash
 
-   cp /usr/share/openldap-servers-xxxx/DB_CONFIG.example /var/lib/ldap/DB_CONFIG
+  $ cp /usr/share/openldap-servers-xxxx/DB_CONFIG.example /var/lib/ldap/DB_CONFIG
 
 Edit the ldap config file ``/etc/openldap/ldap.conf``: ::
 
@@ -61,10 +61,10 @@ Create the root password:
 
 Create the config file (``/etc/openldap/slapd.conf``): ::
 
-  include         /etc/openldap/schema/core.schema
-  include         /etc/openldap/schema/cosine.schema
-  include         /etc/openldap/schema/inetorgperson.schema
-  include         /etc/openldap/schema/nis.schema
+  include     /etc/openldap/schema/core.schema
+  include     /etc/openldap/schema/cosine.schema
+  include     /etc/openldap/schema/inetorgperson.schema
+  include     /etc/openldap/schema/nis.schema
   include     /etc/openldap/schema/eduperson.schema
   include     /etc/openldap/schema/schac.schema
   include     /etc/openldap/schema/iris.schema
@@ -106,15 +106,15 @@ Delete the old slap.d directory to avoid conflicts with our new configuration:
 
 .. code-block:: bash
 
-   rm -rf /etc/openldap/slapd.d
+  # rm -rf /etc/openldap/slapd.d
 
 
 Start and stop the LDAP server:
 
 .. code-block:: bash
 
-   service slapd start
-   service  slapd stop
+  # service slapd start
+  # service slapd stop
 
 Create the root-path file (``/etc/openldap/root.ldif``): ::
 
@@ -493,14 +493,15 @@ that build the OpenMOOC platform.
 Enable the metarefresh module and its dependences:
 
 .. code-block:: bash
-   touch /var/www/idp/simplesamlphp/modules/cron/enable
-   touch /var/www/idp/simplesamlphp/modules/metarefresh/enable
+
+  # touch /var/www/idp/simplesamlphp/modules/cron/enable
+  # touch /var/www/idp/simplesamlphp/modules/metarefresh/enable
 
 Copy the sanitycheck config file:
 
 .. code-block:: bash
 
-   cp /var/www/idp/simplesamlphp/modules/sanitycheck/config-templates/config-sanitycheck.php /var/www/idp/simplesamlphp/config/config-sanitycheck.php
+  # cp /var/www/idp/simplesamlphp/modules/sanitycheck/config-templates/config-sanitycheck.php /var/www/idp/simplesamlphp/config/config-sanitycheck.php
 
 
 Configure the cron:
@@ -973,7 +974,7 @@ Reload iptables service to apply changes:
 
 
 Sync others clocks systems with IDP clock
-----------------------------------------
+-----------------------------------------
 
 Install ntpd package
 
diff --git a/source/install/install.rst b/source/install/install.rst
@@ -0,0 +1,43 @@
+===================
+Installing OpenMOOC
+===================
+
+Requirements
+============
+
+* RPM based system (recommended Centos 6)
+* Python >= 2.6 (we do not support python 3 yet)
+
+Adding OpenMOOC package repository
+==================================
+
+You will have to add the OpenMOOC package repository to have access to the OpenMOOC
+RPMs.
+
+Update your package index and system packages:
+
+.. code-block:: bash
+
+    # yum update
+
+.. note:: This information cannot be finished until we have the Yaco repository
+          working.
+
+
+OpenMOOC virtual package
+========================
+
+There is a virtual package that should help you to install the complete OpenMOOC
+platform without any trouble.
+
+.. warning:: Some packages are specific for OpenMOOC and can overwrite your current
+             installed versions. Please make sure that you do a backup before starting.
+
+Run this command in the command line:
+
+.. code-block:: bash
+
+    # yum install openmooc
+
+If the installation was successful, please follow to :doc:`Configuration <../configure/idp>`
+If you had any trouble please check the :doc:`FAQ <installfaq>`
diff --git a/source/install/installfaq.rst b/source/install/installfaq.rst
@@ -0,0 +1,14 @@
+==========================
+Frequently Aksed Questions
+==========================
+
+.. note:: This section is live.
+
+.. warning:: This section is in development.
+
+
+I can't do the openmooc-engine (moocng) migrations!
+---------------------------------------------------
+
+Is there any automated way of deploying?
+----------------------------------------
diff --git a/source/manual/demostrator.rst b/source/manual/demostrator.rst
@@ -54,13 +54,13 @@ called `eth0` that is a very common interface in Unix systems.
 VirtualBox will complain **when the machine boots the first time**. It will show
 this error message:
 
-.. image:: ../images/oMOOC-demo-Win-1.jpg
+.. image:: ../../images/oMOOC-demo-Win-1.jpg
 
 Click on the "Change network preferences" button, it will open the machine's
 preferences. VirtualBox will automatically fill the network adapter field
 with the real one present on your Windows machine.
 
-.. image:: ../images/oMOOC-demo-Win-2.jpg
+.. image:: ../../images/oMOOC-demo-Win-2.jpg
 
 So, without changing anything, just click on the "Accept" button and now the
 machine will have a correct network adapter, and will boot properly.
