Merge pull request #116 from radinamatic/0.12.6-updates

Update docs for 0.12.6/7 release
learningequality · Jul 30, 2019 · 944c835 · 944c835
2 parents 237c490 + 4749232
commit 944c835
Show file tree

Hide file tree

Showing 17 changed files with 280 additions and 87 deletions.
diff --git a/docs/manage/_advanced.rst → docs/advanced.rst b/docs/manage/_advanced.rst → docs/advanced.rst
@@ -1,13 +1,14 @@
-.. _command_line:
+.. _manage_advanced:
 
-Advanced Manage Options
-~~~~~~~~~~~~~~~~~~~~~~~
+Advanced Management
+~~~~~~~~~~~~~~~~~~~
 
+.. _command_line:
 
 Working with Kolibri from the Command Line
 ------------------------------------------
 
-* In Windows you need to open the command prompt (for example with the :guilabel:`WIN` + :guilabel:`R` shortcut, and typing ``cmd``) in the folder where Kolibri executable is located. When Python is installed on drive ``C:`` the correct path will most probably be ``C:/Python27/Scripts`` in Kolibri up to version 0.9, and ``C:/Python34/Scripts`` in version 0.10 or above.
+* In Windows you need to open the command prompt, for example by using the :guilabel:`WIN` + :guilabel:`R` shortcut, and then typing ``cmd``.
 
       .. figure:: img/cmd.exe.png
         :alt: 
@@ -217,49 +218,49 @@ Change Language
 
   kolibri language setdefault <langcode>
 
-+-----------------------+-----------------+ 
-| Language              | <langcode>      |
-+=======================+=================+ 
-| English               | ``en``          |
-+-----------------------+-----------------+
-| Spanish (Spain)       | ``es-es``       | 
-+-----------------------+-----------------+ 
-| Spanish (Mexico)      | ``es-mx``       | 
-+-----------------------+-----------------+ 
-| French                | ``fr``          | 
-+-----------------------+-----------------+
-| Swahili (Tanzania)    | ``sw-tz``       | 
-+-----------------------+-----------------+
-| Arabic                | ``ar``          | 
-+-----------------------+-----------------+
-| Bulgarian             | ``bg``          | 
-+-----------------------+-----------------+
-| Farsi                 | ``fa``          | 
-+-----------------------+-----------------+
-| Hindi (India)         | ``hi-in``       | 
-+-----------------------+-----------------+
-| Urdu (Pakistan)       | ``ur-pk``       | 
-+-----------------------+-----------------+
-| Marathi               | ``mr``          | 
-+-----------------------+-----------------+
-| Chinyanja             | ``nyn``         | 
-+-----------------------+-----------------+
-| Portuguese (Brasil)   | ``pt-br``       | 
-+-----------------------+-----------------+
-| Telugu                | ``te``          | 
-+-----------------------+-----------------+
-| Vietnamese            | ``vi``          | 
-+-----------------------+-----------------+
-| Yoruba                | ``yo``          | 
-+-----------------------+-----------------+
-| Fulfulde Mbororoore   | ``ff-cm``       | 
-+-----------------------+-----------------+
-| Bengali               | ``bn-bd``       | 
-+-----------------------+-----------------+
-| Gujarati              | ``gu-in``       | 
-+-----------------------+-----------------+
-| Burmese               | ``my``          | 
-+-----------------------+-----------------+
++--------------------------+-----------------+ 
+| Language                 | <langcode>      |
++==========================+=================+ 
+| English                  | ``en``          |
++--------------------------+-----------------+
+| Spanish (Spain)          | ``es-es``       | 
++--------------------------+-----------------+ 
+| Spanish (Latin America)  | ``es-419``      | 
++--------------------------+-----------------+ 
+| French                   | ``fr``          | 
++--------------------------+-----------------+
+| Swahili (Tanzania)       | ``sw-tz``       | 
++--------------------------+-----------------+
+| Arabic                   | ``ar``          | 
++--------------------------+-----------------+
+| Bulgarian                | ``bg``          | 
++--------------------------+-----------------+
+| Farsi                    | ``fa``          | 
++--------------------------+-----------------+
+| Hindi (India)            | ``hi-in``       | 
++--------------------------+-----------------+
+| Urdu (Pakistan)          | ``ur-pk``       | 
++--------------------------+-----------------+
+| Marathi                  | ``mr``          | 
++--------------------------+-----------------+
+| Chinyanja                | ``nyn``         | 
++--------------------------+-----------------+
+| Portuguese (Brasil)      | ``pt-br``       | 
++--------------------------+-----------------+
+| Telugu                   | ``te``          | 
++--------------------------+-----------------+
+| Vietnamese               | ``vi``          | 
++--------------------------+-----------------+
+| Yoruba                   | ``yo``          | 
++--------------------------+-----------------+
+| Fulfulde Mbororoore      | ``ff-cm``       | 
++--------------------------+-----------------+
+| Bengali                  | ``bn-bd``       | 
++--------------------------+-----------------+
+| Gujarati                 | ``gu-in``       | 
++--------------------------+-----------------+
+| Burmese                  | ``my``          | 
++--------------------------+-----------------+
 
 
 
@@ -417,6 +418,10 @@ If you need Kolibri to start and run from a port different than the default ``80
      # Substitute 1234 with your desired port number
 
 
+.. tip::
+  If after setting the desired port in the ``options.ini`` file you still see Kolibri running from a different one, you probably have the environment variable ``KOLIBRI_HTTP_PORT`` from a previous installation, which takes precedence. Check the ``.bashrc`` file on Linux, or run the ``set`` command in Windows command prompt, to verify and correct if necessary.  
+
+
 .. _profile_requests_ini:
 
 
@@ -508,3 +513,9 @@ Each log line contains this information:
 
 .. warning::
   Profiling server requests can consume a lot of computer resources, and potentially slow it down. For this reason you need to explicitly allow it in the ``options.ini`` file. Without the ``PROFILE = 1`` key, command will not profile server requests (but just the current server state), and it will not create the second CSV file. 
+
+
+Hard drive provisioning for multiple Kolibri servers
+----------------------------------------------------
+
+For the recommended procedure to install and provision several Kolibri server devices, refer to our :ref:`hard drive provisioning tutorial <provision>`.
diff --git a/docs/conf.py b/docs/conf.py
@@ -14,7 +14,7 @@
 # FOR! DO NOT LET THEM BE TARGETTED AT MORE THAN ONE MINOR SERIES!
 # I.E.: 0.1.x -- important to add 'dev' suffix for docs targetting development
 # series.
-DISPLAY_VERSION = "0.12.5"
+DISPLAY_VERSION = "0.12.7"
 
 
 # If extensions (or modules to document with autodoc) are in another directory,

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -17,6 +17,7 @@ In a nutshell, Kolibri can run independently of internet availability, but you n
 
 One possibility is to have Kolibri installed in one location with internet connection, where you can import content channels from `Kolibri Studio <https://studio.learningequality.org/>`_ (curriculum tool and content curation server), and then export them to removable USB drives that you bring or send to offline locations (rural schools, refugee camps, etc.) to import locally.
 
+.. _languages:
 
 What languages is Kolibri available in?
 ---------------------------------------
@@ -52,9 +53,9 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 +---------------------------+-----------------+-----------------+
 | Portuguese (Brazil)       | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Spanish (Mexico)          |                 | ✓               |
+| Spanish (Latin America)   | ✓               | ✓               |
 +---------------------------+-----------------+-----------------+ 
-| Spanish (Spain)           | ✓               | ✓               |
+| Spanish (Spain)           | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Swahili (Tanzania)        | ✓               |                 |
 +---------------------------+-----------------+-----------------+

diff --git a/docs/img/IEUser.gif b/docs/img/IEUser.gif
diff --git a/docs/img/cmd.exe.png b/docs/img/cmd.exe.png
diff --git a/docs/img/db-and-content.gif b/docs/img/db-and-content.gif
diff --git a/docs/img/default-language.png b/docs/img/default-language.png
diff --git a/docs/img/linux.kolibri.png b/docs/img/linux.kolibri.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -91,6 +91,13 @@ Happy learning with Kolibri!
    :maxdepth: 3
    :hidden:
 
+   advanced
+
+.. toctree::
+   :maxdepth: 3
+   :hidden:
+
+
    coach
 
 .. toctree::

diff --git a/docs/install.rst b/docs/install.rst
@@ -5,13 +5,14 @@ Install Kolibri
 
 See the `Kolibri changelog here <https://learningequality.org/r/kolibri-changes>`_ to review specific changes in each version of Kolibri. Documentation for `previous Kolibri versions are available here <https://readthedocs.org/projects/kolibri/>`_.
 
-.. leaving tutorials out of the TOC for now
-.. toctree:
+.. putting back tutorials in the TOC
+.. toctree::
    :maxdepth: 1
    :hidden:
 
    install/tutorials/index
 
+
 .. include:: install/_system_requirements.rst
 
 

diff --git a/docs/install/_linux.rst b/docs/install/_linux.rst
@@ -41,33 +41,6 @@ Upgrade
 
 When you use the PPA installation method, upgrades to newer versions will be automatic, provided there is internet access available.
 
-kolibri-server
---------------
-
-We finalized the release of an optimized version of Kolibri for Linux systems called **kolibri-server**. This version is recommended for:
-
-* Clear server-client setup for implementations with many client devices
-* When the server device has more than one CPU core
-
-**kolibri-server** has some specific features like **static content cache** and **optimized usage of the CPU processing power** in multi core devices. Typical use case would be a *Raspberry Pi 3+* device with 4 CPU cores, which will perform much better and faster with **kolibri-server** compared to base Kolibri.
-
-To install **kolibri-server** follow these steps.
-
-#. Run these commands in the Terminal:
-
-	.. code-block:: bash
-
-                sudo apt-get install software-properties-common dirmngr
-		sudo add-apt-repository ppa:learningequality/kolibri-proposed
-		sudo apt-get update
-		sudo apt-get install kolibri-server
-
-   During the installation you will be offered the option to choose the port (8000, 80 or leave the default 8080).
-
-#. Restart the system.
-
-.. warning:: * Be advised that this procedure also switches the setup to use the latest built Kolibri pre-release.
-	* Keep in mind that the **kolibri-server** system performance will depend not only on server device features, but on local WiFi access point characteristics.
 
 .. _lin_deb:
 
@@ -136,6 +109,32 @@ To change the system service owner, you need to change the configuration of the
 .. note:: Replace the ``$USER`` in commands above with the name of the user you wish to be the new Kolibri system service owner.
 
 
+Higher Performance with the ``kolibri-server`` package
+------------------------------------------------------
+
+We have of a higher-performance wrapper around the ``kolibri`` package for Ubuntu and Debian systems called ``kolibri-server``. 
+
+``kolibri-server`` has some specific features like **static content cache** and **optimized usage of the CPU processing power** in multi core devices. For example, a *Raspberry Pi 3+* device has 4 CPU cores, and with ``kolibri-server`` it will likely be able to serve 2-3 times more client devices compared to base Kolibri.
+
+To install ``kolibri-server`` follow these steps.
+
+#. Run these commands in the Terminal:
+
+  .. code-block:: bash
+
+    sudo apt-get install software-properties-common dirmngr
+    sudo add-apt-repository ppa:learningequality/kolibri-proposed
+    sudo apt-get update
+    sudo apt-get install kolibri-server
+
+  During the installation you will be offered the option to choose the port (8000, 80 or leave the default 8080).
+
+2. Restart the system.
+
+.. warning:: * Be advised that this procedure also switches the setup to use the latest built Kolibri pre-release.
+  * Keep in mind that the ``kolibri-server`` system performance will depend not only on server device features, but on local WiFi access point characteristics.
+
+
 Raspberry Pi
 ------------
 

diff --git a/docs/install/_system_requirements.rst b/docs/install/_system_requirements.rst
@@ -12,7 +12,7 @@ Servers
 
 Minimum hardware requirements to run Kolibri as a server:
 
- - 500 MB RAM (1 GB recommended)
+ - 500 MB RAM (1 GB recommended on Linux, 2GB or more on Windows devices)
  - 500 MHz CPU (1 GHz recommended)
  - Hard drive space depends on the size of the content channels you intend to import from `Kolibri Studio <https://studio.learningequality.org/>`_ or a local storage device.
 

diff --git a/docs/install/tutorials/index.rst b/docs/install/tutorials/index.rst
@@ -9,3 +9,7 @@ Step-by-step guides with more details.
 
    rpi
 
+.. toctree::
+   :maxdepth: 1
+
+   provision