Merge pull request #105 from radinamatic/update-0.12.5

Updates for 0.12.5
learningequality · Jun 21, 2019 · 7796670 · 7796670
2 parents 775426d + 7963ec5
commit 7796670
Show file tree

Hide file tree

Showing 11 changed files with 47 additions and 18 deletions.
diff --git a/docs/coach.rst b/docs/coach.rst
@@ -85,9 +85,11 @@ Use the options in the **Plan** tab to create and manage the lessons, quizzes, a
 .. _coach_resource:
 
 Coach Support Resources
------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
 
-`Kolibri Studio <https://studio.learningequality.org/>`_ supports the option to set visibility for any resource added to content channels as a **Coach resource**. When content curators set the visibility this way, the resource in Kolibri will not be visible to learners, but only to admins, facility coaches, or other users assigned to coach classes. These materials can be lesson plans, professional development readings, training materials, etc. only viewable by coaches and not learners. 
+`Kolibri Studio <https://studio.learningequality.org/>`_ supports the option to set visibility for any resource added to content channels as a **Coach resource**. These materials can be lesson plans, professional development readings, training materials, etc. only viewable by coaches and not learners. When content curators set the visibility this way, the resource will not be visible by learners while browsing Kolibri **Channels**, but only to admins, facility coaches, or other users assigned to coach classes. 
+
+However, coach can decide to include any of these resources in :ref:`lessons <manage_lessons>` or :ref:`quizzes <manage_quizzes>`, in which case they will be visible to learners in the context of that lesson or a quiz.
 
 	.. figure:: img/coach-resource-studio.png
 	  :alt: In Kolibri Studio content curators can set the visibility for a single resource, or for the entire topic.

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.3"
+DISPLAY_VERSION = "0.12.5"
 
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -65,6 +65,7 @@
 # The full version, including alpha/beta/rc tags.
 release = DISPLAY_VERSION
 
+
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build', '**/_*.rst']

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -32,13 +32,21 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 +---------------------------+-----------------+-----------------+ 
 | Bengali                   | ✓               |                 |
 +---------------------------+-----------------+-----------------+
+| Bulgarian                 | ✓               |                 |
++---------------------------+-----------------+-----------------+
+| Burmese                   | ✓               |                 |
++---------------------------+-----------------+-----------------+
 | Chinyanja                 | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Farsi                     | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | French                    | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Hindi                     | ✓               |                 |
+| Fulfulde Mbororoore       | ✓               |                 |
++---------------------------+-----------------+-----------------+
+| Hindi (India)             | ✓               |                 |
++---------------------------+-----------------+-----------------+
+| Gujarati                  | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Marathi                   | ✓               |                 |
 +---------------------------+-----------------+-----------------+
@@ -50,7 +58,7 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 +---------------------------+-----------------+-----------------+
 | Swahili (Tanzania)        | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Tamil                     | ✓               |                 |
+| Telugu                    | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Bulgarian                 | ✓               |                 |
 +---------------------------+-----------------+-----------------+

diff --git a/docs/install.rst b/docs/install.rst
@@ -5,8 +5,9 @@ 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/>`_.
 
-.. toctree::
-   :maxdepth: 2
+.. leaving tutorials out of the TOC for now
+.. toctree:
+   :maxdepth: 1
    :hidden:
 
    install/tutorials/index

diff --git a/docs/install/_linux.rst b/docs/install/_linux.rst
@@ -6,7 +6,7 @@ Debian/Ubuntu
 Compatibility
 -------------
 
-Debian 8 (Jessie), Debian 9 (Stretch), Ubuntu 16.04+ and up - anything that's *not* end-of-life. Ubuntu-based distributions count a number of flavours, for instance Xubuntu and Mint.
+Debian 8 (Jessie), Debian 9 (Stretch), Ubuntu 16.04+ and up - anything that's *not* end-of-life. Ubuntu-based distributions count a number of flavors, for instance Xubuntu and Mint.
 
 .. _ppa:
 

diff --git a/docs/install/tutorials/index.rst b/docs/install/tutorials/index.rst
@@ -1,3 +1,4 @@
+:orphan:
 Tutorials
 #########
 

diff --git a/docs/install/tutorials/rpi.rst b/docs/install/tutorials/rpi.rst
@@ -1,11 +1,12 @@
+:orphan:
 .. _tutorial_rpi:
 
 An offline Raspberry Pi server
 ==============================
 
 This guide shows you how to configure a Raspberry Pi as a local Wi-Fi hotspot serving Kolibri.
 
-There are several varieties of operating systems for Raspberry Pi. This guide is intended for and tested on `Raspian <https://www.raspberrypi.org/>`__, the most popular choice of OS, based on Debian.
+There are several varieties of operating systems for Raspberry Pi. This guide is intended for and tested on `Raspbian <https://www.raspberrypi.org/>`__, the most popular choice of OS, based on Debian.
 
 .. warning:: These steps require an internet connection during the installation. After completing the installation, it's possible :ref:`to replicate an image <rpi_replication>` for offline installation.
 
@@ -29,7 +30,7 @@ Prerequisites
   * `Raspbian Lite <http://downloads.raspberrypi.org/raspbian_lite/>`__
   * **Or** `Installation of Raspbian via NOOBS <https://www.raspberrypi.org/documentation/installation/noobs.md>`__
 * Internet connectivity (for setting up the device)
-* An internal MicroSD card is used for the base system, and an external storage media for contents (for instance a 64 GB USB flash). We recommend that you have an ethernet cable for online connectivity while installing and fetching contents for Kolibri.
+* An internal MicroSD card is used for the base system, and an external storage media for contents (for instance a 64 GB USB flash). We recommend that you have an Ethernet cable for online connectivity while installing and fetching contents for Kolibri.
 
 .. tip:: The standard Raspbian OS has a graphical desktop. You can also install Raspbian Lite which uses fewer resources, but only has a command line interface. The instructions in this documentation work seamlessly on both.
 
@@ -85,12 +86,12 @@ Setting up a hotspot
 
 The Raspberry Pi 3 has an internal Wi-Fi adapter which can serve as an access point, thus giving other devices the ability to connect to the Raspberry Pi through Wi-Fi. In this case, we call the Raspberry Pi a *hotspot*.
 
-We assume that you will need to connect the Raspberry Pi to the internet both before and after setting up the hotspot. The easiest way to achieve this is through the Raspberry Pi's ethernet cable connection. In this way, you don't have to disable and enable the Wi-Fi configuration each time.
+We assume that you will need to connect the Raspberry Pi to the internet both before and after setting up the hotspot. The easiest way to achieve this is through the Raspberry Pi's Ethernet cable connection. In this way, you don't have to disable and enable the Wi-Fi configuration each time.
 
-* The device can be set up such that it automatically uses the ethernet interface as a *gateway* to the internet when a cable is connected.
+* The device can be set up such that it automatically uses the Ethernet interface as a *gateway* to the internet when a cable is connected.
 * If you need to connect to the internet through Wi-Fi, you will have to disable the hotspot and connect through the normal network management.
 
-.. note: If you already have a Wi-Fi network at the location where the device will be set up, you should NOT set up an additional hotspot. You can connect the Raspberry Pi to an existing network and access it from there. Skip this step and the Capitive Portal step.
+.. note: If you already have a Wi-Fi network at the location where the device will be set up, you should NOT set up an additional hotspot. You can connect the Raspberry Pi to an existing network and access it from there. Skip this step and the Captive Portal step.
 
 Installing hostapd and dnsmasq
 ******************************
@@ -164,7 +165,7 @@ Copy and paste the following text, then press :guilabel:`CTRL` + :guilabel:`X` t
 
 .. warning::
 
-  These settings override the possibility to connect to an online source using the Wi-Fi. It is still possible to connect to the internet **through the cabled ethernet**, however you will need to configure a DNS server manually every time you reboot the device. Put the IP of your DNS provider in ``/etc/resolve.conf``. If you don't know it, you can use Google's OpenDNS address ``8.8.8.8`` as in this example:
+  These settings override the possibility to connect to an online source using the Wi-Fi. It is still possible to connect to the internet **through the cabled network**, however you will need to configure a DNS server manually every time you reboot the device. Put the IP of your DNS provider in ``/etc/resolve.conf``. If you don't know it, you can use Google's OpenDNS address ``8.8.8.8`` as in this example:
 
   .. code-block:: console
 
@@ -227,9 +228,9 @@ Setting up a "Captive portal"
 You don't have to set up a "Captive Portal", but it's a good idea, since the behavior will make the user experience better. Users won't have to guess the location (hostname / domain) of services on the Raspberry Pi, and many devices support displaying your welcome page automatically upon connecting to the Wi-Fi.
 
 .. figure:: /img/captive_portal_screenshot.png
-    :alt: Hotspot login dialogue
+    :alt: Hotspot login dialog
 
-    This type of dialogue will appear on many devices when they detect a successful Wi-Fi connection without an internet connection.
+    This type of dialog will appear on many devices when they detect a successful Wi-Fi connection without an internet connection.
 
 In the previous step, we have configured the Raspberry Pi to tell devices on the local offline hotspot that whatever resource they request such as ``http://domain.com``, it should resolve to the Raspberry Pi's static IP address ``192.168.4.1``.
 

diff --git a/docs/manage/_classes.rst b/docs/manage/_classes.rst
@@ -41,7 +41,7 @@ Edit Class, Learners and Coaches
 A newly created class does not have any learners or coaches. To edit a class select it from the default view in the **Classes** tab. In this view, you can change class name, add or remove currently enrolled learners and assign or remove coaches from the class.
 
   .. figure:: img/new-class.png
-    :alt: New class will have no enrolled learners and no asigned coaches.
+    :alt: New class will have no enrolled learners and no assigned coaches.
 
 
 .. _enroll_learners:

diff --git a/docs/manage/_content.rst b/docs/manage/_content.rst
@@ -91,7 +91,7 @@ If the computer where Kolibri is running has an Internet connection with the suf
 #. Wait for the content to be downloaded and click :guilabel:`CLOSE` for the new channel to appear under the **Channel** heading.
 
     .. figure:: img/import-CC.png
-  	  :alt: Content import progress bar will display the percentage of the donwload, and the Close button once it's finished 
+  	  :alt: Content import progress bar will display the percentage of the download, and the Close button once it's finished 
 
 #. If you need to import content from a **private/unlisted** channel, click on **Try adding the token** link above the channel list.  
 #. Enter the **channel token/ID** received from the channel curator on Kolibri Studio.

diff --git a/docs/manage/_get_support.rst b/docs/manage/_get_support.rst
@@ -52,6 +52,20 @@ Videos are not playing
 Make sure to check the :ref:`system requirements <sys_reqs>` to see if you can support video playback. Please report any issues on our `Community Forums <https://community.learningequality.org/>`_, stating the operating system and browser you are using.
 
 
+Antivirus
+---------
+
+Some overzealous antivirus programs on Windows platform may preventively impede Kolibri or some of its components (for example ``python.exe``) from running correctly. If that happens you need to add them to the antivirus exclusion list. Below steps refer to the program **Avast**, but should be similar in other antivirus applications.
+
+1. Open **Avast**.
+2. Click on **Protection** in the sidebar.
+3. Click on **Virus Chest**.
+4. Find the file `python.exe` in the list.
+5. Right click on the file and select *Scan*.
+6. If the scan is inconclusive the ``python.exe`` file is not infected with a virus.
+7. Right click on the file and select *Restore and add to exclusions*.
+
+
 Problems with import and export from USB drives
 -----------------------------------------------
 

diff --git a/requirements.txt b/requirements.txt
@@ -3,3 +3,4 @@ sphinx<2
 sphinx_rtd_theme
 sphinx-intl
 sphinx-autobuild
+sphinx-version-warning