Merge pull request #179 from radinamatic/updates-0.14

0.14 updates

docs/404.rst

@@ -0,0 +1,8 @@
+:orphan:
+
+404
+===
+
+We looked everywhere but we couldn't find that page!
+
+Try using the links in the sidebar or the search box to find what you are looking for, or go to the homepage.

docs/_static/theme_overrides.css

@@ -218,3 +218,8 @@ img {
 .admonition {
   clear: both;
 }
+
+/* push down the RTD banner so it's not confused with menu */
+.keep-us-sustainable {
+  margin-top: 20em !important;
+}

docs/access/access_lan.rst

@@ -3,7 +3,7 @@
 Accessing Kolibri from Other Devices
 ####################################
 
-After you have installed and started Kolibri on the computer that will act as a server, you need to configure other devices in the same `Local Area Network <https://en.wikipedia.org/wiki/Local_area_network>`_ (LAN), such as other computers, tablets or phones, so they can access the the learning content on the server.
+After you have installed and started Kolibri on the computer that will act as a server, you need to configure other devices in the same `Local Area Network <https://en.wikipedia.org/wiki/Local_area_network>`_ (LAN), such as other computers, tablets or phones, so they can access the the learning resources on the server.
 
 Compatibility
 *************
@@ -17,13 +17,13 @@ Kolibri currently supports the following combinations of operating systems and b
 * iOS 10+: Safari, Chrome and Firefox
 
 .. warning:: 
-  *	Videos in Kolibri are in MP4 file format. While most browsers do not require additional plugins or codecs, open source platforms and browsers will require you to install codecs separately. To be able to view videos in Firefox on Ubuntu for example, you must install the `restricted extras package <https://help.ubuntu.com/community/RestrictedFormats>`__.
+  *	Videos in Kolibri are in MP4 file format. While most browsers do not require additional plugins or codecs, open source platforms and browsers will require you to install codecs separately. If you encounter the error *No compatible source was found for this media* when you try to play videos in Firefox on Ubuntu for example, you must install the `restricted extras package <https://help.ubuntu.com/community/RestrictedFormats>`__.
   *	**If you are still unable to view videos in fully open source browsers like Chromium or Firefox, try using Google Chrome**.
 
 Set up Access on Other Devices
 ******************************
 
-To access content from other devices in the same network, you need to know the :ref:`IP address <ips>` of the computer where Kolibri is running. The default port is **8080**, and you must add it after the IP address.
+To access resources from other devices in the same network, you need to know the :ref:`IP address <ips>` of the computer where Kolibri is running. The default port is **8080**, and you must add it after the IP address.
 
 For example, if Kolibri is installed and started on a computer with the address **192.168.8.134:8080**, you can access it from an Android tablet connected to the same network by opening the browser on the tablet and typing the address ``http://192.168.8.134:8080``.
 
@@ -36,7 +36,7 @@ For example, if Kolibri is installed and started on a computer with the address
 
       Find the IP/Server URL in the Device > Info tab.
 
-  * You can also use the ``ipconfig`` command on Windows or ``ifconfig`` command on Linux/OSX to find the externally visible IP address of the device running the Kolibri.
+  * You can also use the ``ipconfig`` command on Windows or ``ifconfig`` command on Linux and macOS to find the externally visible IP address of the device running the Kolibri.
 
 
 .. warning::

docs/access/change_language.rst

@@ -9,6 +9,11 @@ To change language in which the **Kolibri** user interface is displayed, follow
 #. Select the **Change language** option.
 #. Choose the desired language.
 #. Click :guilabel:`CONFIRM` and Kolibri will be displayed in the selected language.
+
+.. figure:: /img/change-language.png
+    :alt: 
+
+    Kolibri flies in 22 languages!
 
 .. warning::
-  The default language configured in your browser preferences might override the language configured in Kolibri. To ensure that Kolibri displays in the desired language, make sure to configure it as default in the browsers of all the devices that will be used to view Kolibri content.
+  The default language configured in your browser preferences might override the language configured in Kolibri. To ensure that Kolibri displays in the desired language, make sure to configure it as default in the browsers of all the devices that will be used to view Kolibri.

docs/access/linux.rst

@@ -21,7 +21,7 @@ Starting Kolibri on Linux will differ depending on the method you used to instal
   2. Open the default browser at ``http://127.0.0.1:8080``, and it will display the **Kolibri** start page.
 
     .. note::
-      Remember to :ref:`configure other computers <access_LAN>` in the network to access **Kolibri** content.
+      Remember to :ref:`configure other computers <access_LAN>` in the network to access **Kolibri**.
 
   3. Run this command in Terminal to stop Kolibri:
 

docs/access/macos.rst

@@ -3,19 +3,10 @@
 MacOS
 #####
 
-#. **The first time you start the Kolibri application, do NOT use Launchpad**. Instead use the **Finder** on your Mac to locate Kolibri in the **Applications** folder. This is because the application is unsigned and needs your permission to run.
-
-#. Control-click the app icon, then choose **Open** from the shortcut menu.
-
-   After completing these steps, your security settings are updated for this version of Kolibri, and you can launch Kolibri like any other application. You may need to repeat this process when you upgrade Kolibri.
-
-
-   .. note:: Read this for `more details about opening unsigned apps <https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac>`_.
-
-.. TO-DO (image)
+Use the Kolibri icon in the Launchpad to open the app on macOS.
 
 .. warning::
-   If you are using keyboard navigation on macOS, be sure to `enable 'All Controls' in the 'System Preferences' <https://a11yproject.com/posts/macos-browser-keyboard-navigation/>`_.
+   If you are using keyboard navigation on macOS, be sure to `enable 'All Controls' in the 'System Preferences' <https://a11yproject.com/posts/2017-12-29-macos-browser-keyboard-navigation/>`_.
 
 .. note::
-  Remember to :ref:`configure other computers <access_LAN>` in the network to access **Kolibri** content.
+  Remember to :ref:`configure other computers <access_LAN>` in the network to access **Kolibri**.

docs/access/rpi.rst

@@ -8,7 +8,7 @@ Raspberry Pi
 Open the default browser at ``http://10.10.10.10``, and it will display the **Kolibri** start page.
 
 .. note::
-  Remember to :ref:`configure other computers <access_LAN>` in the network to access **Kolibri** content.  
+  Remember to :ref:`configure other computers <access_LAN>` in the network to access **Kolibri**.  
 
 
 .. TO-DO (image)

docs/access/windows.rst

@@ -33,12 +33,12 @@ While it is running, **Kolibri** will display an icon in the Windows taskbar (us
 .. warning::
   In some Windows multi-user environments (for example NComputing), you need to make sure that Kolibri is running **only from the admin account** to avoid having Kolibri started for each login/session. Confirm that the **Run Kolibri at system startup** taskbar option is checked only when the admin logs in, but unchecked when any other user of virtual desktops is logged in.
 
-  It is also recommended that you remove the Kolibri desktop laucher icon from all non admin accounts in this type of setup, and substitute it with a regular shortcut that opens the Kolibri server IP. To add the desktop shortcut follow these steps.
+  It is also recommended that you remove the Kolibri desktop launcher icon from all non admin accounts in this type of setup, and substitute it with a regular shortcut that opens the Kolibri server IP. To add the desktop shortcut follow these steps.
 
   #. Right click anywhere on the desktop.
   #. Select *New > Shortcut*.
   #. Type in the Kolibri server IP (most probably ``http://127.0.0.1``), save and exit.
   #. Double-click the shortcut to test if it opens the browser and loads Kolibri.
 
 .. note::
-  Remember to :ref:`configure other computers <access_LAN>` in the network to access **Kolibri** content.
+  Remember to :ref:`configure other computers <access_LAN>` in the network to access **Kolibri**.

docs/coach/index.rst

@@ -14,6 +14,7 @@ Click on a class to access the progress-tracking features and create lessons, qu
 
 .. _track_progress:
 
+
 Class Home
 ~~~~~~~~~~
 
@@ -25,7 +26,6 @@ On the **Class Home** tab (|class-home| icon) you can see the overview of the cl
 	  Class Home presents an overview of learner progress and activity.
 
 
-
 Quizzes
 -------
 
@@ -60,9 +60,9 @@ As learners interact with lessons and quizzes, you can track their progress in t
 * You can click each notification link to review the complete resource data in the **Reports** tab.
 * Click :guilabel:`VIEW ALL` to access the full list of activity notifications (only the 5 most recent are displayed in the block).
 
-
 .. _reports:
 
+
 Reports
 ~~~~~~~
 
@@ -108,25 +108,24 @@ Use the options in the **Plan** tab to create and manage the lessons, quizzes, a
   quizzes
   groups
 
-
-
 .. _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**. 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. 
+`Kolibri Studio <https://studio.learningequality.org/>`_ supports the option to set visibility for any resource added to 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.
 
-	  Setting the visibility of content in Kolibri Studio.
+	  Setting the visibility of resources in Kolibri Studio.
 
-Coach resources and content channels that contain them are marked with the |coach-resource| icon in Kolibri.
+Coach resources and channels that contain them are marked with the |coach-resource| icon in Kolibri.
 
 	.. figure:: /img/coach-resource.png
 	  :alt: Indicators of the number of available coach support resources for all the channels are visible on the Kolibri Learn page, inside each channel card.
 
-	  Content channel with 4 support resources for coaches in Kolibri.
+	  Channel with 4 support resources for coaches in Kolibri.

docs/coach/lessons.rst

@@ -7,7 +7,6 @@ Manage Lessons
 Kolibri **Lessons** offer you the possibility to prepare smaller selections of available learning resources and assign them to learners on a temporary basis. You can select resources from multiple channels, and copy the created lessons to other classes or groups as needed. 
 
 To view, create or delete lessons, as well as assign them to learners, use the **Lessons** sub-tab in the **Plan** tab (|edit| icon) of your **Coach** dashboard. Default view displays the list of all lessons created for the selected class, the number of resources they contain, groups they are assigned to, and their status indicator. 
-.. You can filter the lessons in order to see all, or just active/inactive ones. 
 
 
 .. figure:: /img/lessons.png
@@ -23,22 +22,22 @@ Create New Lesson
 To create a new lesson |lessons|, follow these steps.
 
 1. Click the :guilabel:`NEW LESSON` button.
-2. Fill in the field for the lesson title, description and choose the group(s) or the entire class as the recipients. 
+2. Fill in the field for the lesson title, description and choose individual learners, groups or the entire class as the recipients. 
 
   .. figure:: /img/new-lesson.png
     :alt: 
 
-3. Click :guilabel:`CONTINUE`. In this step, the lesson does not have any learning resources yet, but you can see and edit some options.
+3. Click :guilabel:`SAVE CHANGES`. In this step, the lesson does not have any learning resources yet, but you can see and edit some options.
 
   .. figure:: /img/lesson-options.png
     :alt: New lesson with no resources added; navigate to Options button and click to open it for more actions.
 
-4. Click :guilabel:`MANAGE RESOURCES` and select the content channel from which you wish to select resources for the lesson.
+4. Click :guilabel:`MANAGE RESOURCES` and select the channel from which you wish to select resources for the lesson.
 
   .. figure:: /img/select-lesson-resources.png
     :alt: This window presents a list of channels from which you can choose to add resources to the lesson.
 
-5. Keep navigating the topic tree of the selected content channel until you arrive to single content items. Use the checkboxes to select the resources you want to include in the lesson, and you will see a notification at the bottom of the page that the resource has been added.
+5. Keep navigating the topic tree of the selected channel until you arrive to single resources. Use the checkboxes to select the resources you want to include in the lesson, and you will see a notification at the bottom of the page that the resource has been added.
 
   .. figure:: /img/select-lesson-resources2.png
     :alt: 
@@ -51,7 +50,7 @@ To create a new lesson |lessons|, follow these steps.
     You can filter the search results by *type* of resource (video, document, exercise...), include only those from a specific *channel*, or exclude :ref:`resources for coaches <coach_resource>`.
 
 
-7. Click the :guilabel:`FINISH` button to close the **Manage resources** window and return to the main view of the lesson.
+7. Click the :guilabel:`CLOSE` button to close the **Manage resources** window and return to the main view of the lesson.
 
 8. After you've selected the resources for the lesson, you can:
 
@@ -75,7 +74,8 @@ A newly created lesson is by default *not visible to learners*, and they will no
 * Click the **Visible to learners** switch in the summary block to enable learners to see the lesson and interact with its resources.
 * Click the switch again to make the lesson invisible to learners once the designated time had passed.
 
-.. TO-DO (image)
+      .. figure:: /img/lesson-visible.png
+        :alt:
 
 .. note::
   You can also change lesson visiblity from its own **Report**, and the list in the **Reports > Lessons** subtab.
@@ -88,7 +88,7 @@ You can change the recipients of the lesson, reassigning the lesson to a differe
 
 #. Select the desired lesson from the list in the **Lessons** tab.
 #. Click the :guilabel:`OPTIONS` button and select **Edit details**.
-#. Select **Entire class** or the group(s) of learners to whom you wish to assign the lesson under the *Recipients* heading.
+#. Select the entire class, groups or inidividual learners to whom you wish to assign the lesson under the *Recipients* heading.
 #. Click :guilabel:`SAVE CHANGES` to confirm, or :guilabel:`CANCEL` to exit without change.
 
 
@@ -99,12 +99,8 @@ To copy a lesson to a different group or another class of your facility, follow
 
 1. Select the desired lesson from the list in the **Lessons** tab.
 2. Click :guilabel:`OPTIONS` and select **Copy lesson**.
-
-    .. figure:: /img/copy-lesson.png
-      :alt: 
-
 3. Select the class to which you wish to copy the lesson to.
-4. If the destination class has more than one group, select **Entire class** or the group(s) of learners to whom you wish to assign the lesson.
+4. Select the entire class, groups or inidividual learners to whom you wish to assign the lesson.
 5. Click :guilabel:`COPY` to confirm, or :guilabel:`CANCEL` to exit without change.
 
 If the lesson is copied to another group in the same class, it will appear in the **Lessons** tab as the *Copy of...*. Follow the steps in the next heading to rename it.

docs/coach/quizzes.rst

@@ -9,6 +9,8 @@ You can view, create and delete quizzes, as well as assign them to learners, usi
   .. figure:: /img/manage-quizzes.png
     :alt: 
 
+.. TO-DO (icon)
+
 .. note::
   To manage **Quizzes** |exams| in Kolibri classes and groups you must sign in as **coach**, **admin** or **super admin**.
 
@@ -59,17 +61,16 @@ To create a new quiz |exams|, click the :guilabel:`NEW QUIZ` button.
 Change Quiz Recipients
 """"""""""""""""""""""
 
-Newly created quizzes are by default visible to entire class. To change quiz *Recipients*, that is select group(s) of learners instead of the whole class, follow these steps.
+Newly created quizzes are by default visible to entire class. To change quiz *Recipients*, that is select groups or individual learners instead of the whole class, follow these steps.
 
 #. Select the desired quiz from the list in the **Quizzes** subtab.
 #. Click the :guilabel:`OPTIONS` button and select the **Edit details** option.
-#. Select the group(s) of learners to whom you wish to assign the quiz under the *Recipients* heading.
+#. Select the learners and groups to whom you wish to assign the quiz under the *Recipients* heading.
 #. Click :guilabel:`SAVE CHANGES` to confirm, or :guilabel:`CANCEL` to exit without change.
 
   .. figure:: /img/exam-visibility.png
     :alt: 
 
-
 Start and End Quiz
 """"""""""""""""""
 
@@ -79,26 +80,22 @@ Newly created quizzes are by default *not started*, meaning that learners will n
 
 * Click the :guilabel:`END QUIZ` button once the designated time had passed, and you want to stop learners from interacting with it.
 
-.. TO-DO (image)
+  .. figure:: /img/start-end-quiz.png
+    :alt: 
 
 .. note::
   You can also start and end the quiz from its **Report** page, and the list in the **Reports > Quizzes** subtab.
 
 
-
 Copy Quiz
 """""""""
 
 To copy a quiz to a different group or another class, follow these steps.
 
 #. Select the desired quiz from the list in the **Quizzes** subtab.
 #. Click :guilabel:`OPTIONS` and select **Copy quiz**.
-
-    .. figure:: /img/copy-exam.png
-      :alt: Use the radio buttons to select the class where you want to copy the quiz to.
-
 #. Select the class to which you wish to copy the quiz to and click :guilabel:`CONTINUE`.
-#. If the destination class has more than one group, select **Entire class** or the group(s) of learners to whom you wish to assign the lesson.
+#. Select the entire class, groups or inidividual learners to whom you wish to assign the quiz under the *Assign quiz to* heading.
 #. Click :guilabel:`COPY` to confirm, or :guilabel:`CANCEL` to exit without change.
 
 If the quiz is copied to another group in the same class, it will appear in the **Quizzes** tab as the *Copy of...*. Follow the steps in the next section to rename it.

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.13"
+DISPLAY_VERSION = "0.14"
 
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -28,6 +28,7 @@
     'sphinx.ext.todo',
     'sphinx.ext.autodoc',
     'sphinx_rtd_theme',
+    'notfound.extension',
 ]
 
 builddir = os.path.join(cwd, '_build')