Merge pull request #54 from radinamatic/0.11-update

Release 0.11 updates

docs/_static/theme_overrides.css

@@ -1,13 +1,44 @@
 
 @import url("https://fonts.googleapis.com/icon?family=Material+Icons");
 
+.rst-content blockquote {
+	margin-left: 5px;
+}
+
+div.figure {
+    padding: 4px;
+    /*background-color: #fff;*/
+    border: 1px solid #ddd;
+    border-radius: 4px;
+    margin: auto 5px;
+}
+
+.rst-content div.figure p.caption {
+    border-top: 1px solid #ddd;
+    margin: auto 5px;
+    padding-top: 5px;
+}
  .wy-table-responsive table td {
     /* !important prevents the common CSS stylesheets from overriding
        this as on RTD they are loaded after this stylesheet */
     white-space: normal !important;
     vertical-align: top !important;
  }
 
+/* Change background color to match Kolibri brand */
+ .wy-side-nav-search {
+    background-color: #996189 !important;
+ }
+
+.wy-nav-top {
+    background: #996189 !important;   
+}
+
+/* Improve the contrast for the version number.*/
+.wy-side-nav-search > div.version {
+    color: rgba(255,255,255,0.9);
+}
+
 .material-icons {
     display: inline-flex;
     vertical-align: middle !important;
@@ -19,6 +50,12 @@
 	color: #2196f3;
 }
 
+.outline {
+    padding-bottom: 1px !important;
+    border: 2px solid;
+    border-radius: 50%;
+}
+
 .schedule {
 	padding-bottom: 1px !important;
 	background-color: #2196f3;
@@ -36,3 +73,25 @@
 img {
 	height: 1.2em;
 	vertical-align: text-bottom;
+}
+
+.rst-content span.guilabel {
+    background-color: #fafbfc;
+    border: 1px solid #c6cbd1;
+    border-bottom-color: #959da5;
+    border-radius: 3px;
+    box-shadow: inset 0 -1px 0 #959da5;
+    color: #444d56;
+    display: inline-block;
+    font-size: 80%;
+    font-weight: normal;
+    line-height: 10px;
+    padding: 4px 5px 3px;
+    margin-top: -2px;
+    vertical-align: middle;
+    font-family: Consolas, Menlo, Courier, "Courier New", monospace;
+}
+
+.rst-content div.highlight {
+    background: #feffe9 !important;
+}

docs/access.rst

@@ -18,7 +18,7 @@ Kolibri Taskbar Options
 While it is running, **Kolibri** will display an icon in the Windows taskbar (usually at bottom right, near the clock), that allows you to stop it and configure other settings.  
 
     .. figure:: img/taskbar-options.png
-     :alt: Kolibri taskbar options.
+     :alt: When you right click the Kolibri taskbar icon, you can see the taskbar options.
 
      Kolibri taskbar options.
 
@@ -37,7 +37,7 @@ Starting Kolibri on Linux or MacOS
 
 Starting Kolibri on Linux and MacOS will differ depending on the method you used to install it.
 
-* If you used the :ref:`PEX package <pex>`, Kolibri will be accessible as long as the process is running in the `Terminal <https://help.ubuntu.com/community/UsingTheTerminal>`_.  
+* If you used the **PEX** package, Kolibri will be accessible as long as the process is running in the `Terminal <https://help.ubuntu.com/community/UsingTheTerminal>`_. If you stop the process, close the Terminal window, or restart your system, you will need to :ref:`run the PEX again <pex>` to restart Kolibri. 
 
 * If you installed Kolibri as a system service with the :ref:`DEB installer <lin_deb>`, it will run automatically on each system restart, and you do not need to start it manually. Proceed to step 2 below.
 
@@ -51,7 +51,7 @@ Starting Kolibri on Linux and MacOS will differ depending on the method you used
 
     .. warning:: On macOS you may need to prefix the command with ``python``, and type ``python -m kolibri start`` instead.
 
-  2. Open the default browser at ``http://127.0.0.1:8080`` displaying the **Kolibri** start page.
+  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.
@@ -83,8 +83,8 @@ Kolibri currently supports the following combinations of operating systems and b
 
 .. warning:: Videos are MP4 encoded. While most browsers do not require additional plugins or codecs, open source platforms will often require you to install MP4 codecs separately: For instance on Ubuntu, install the `restricted extras package <https://help.ubuntu.com/community/RestrictedFormats>`__.
 
-Setup Access on Other Devices
-*****************************
+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. 
 
@@ -95,7 +95,7 @@ For example, if Kolibri is installed and started on a computer with the IP addre
   * You can check the IP (**Server URL**) of the device where Kolibri is running by going to **Info** tab in the **Device** dashboard.
 
     .. figure:: img/device-info.png
-      :alt: Find the IP/Server URL in the Device > Info tab.
+      :alt: Open the Device page and navigate to the Info tab to find the IP (Server URL) for your device.
 
       Find the IP/Server URL in the Device > Info tab.
 
@@ -128,7 +128,7 @@ To change language in which the **Kolibri** user interface is displayed, follow
 #. Open your user menu in the upper right corner.
 #. Select the **Change language** option.
 #. Choose the desired language.
-#. Click **Confirm** and Kolibri will be displayed in the selected language!
+#. Click :guilabel:`CONFIRM` and Kolibri will be displayed in the selected language!
 
 .. 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.

docs/coach.rst

@@ -7,8 +7,10 @@ You can track progress of the **Learners**, create and assign **Lessons** and **
 
 Click on a class to access the progress-tracking features and create lessons and exams.
 
-.. figure:: img/coach-home.png
-  :alt: default coach view with list of classes
+	.. figure:: img/coach-home.png
+	  :alt: Open the Coach page to view the list of classes
+
+	  Choose one of the classes from this view to access the learner reports
 
 .. _track_progress:
 
@@ -20,10 +22,10 @@ Click the desired class inside the initial view of the **Coach** dashboard, and
 
 When you click the username of a learner, you will see a list of content channels they accessed, and the last time they were active on each of them:
 
-.. figure:: img/learner-report-content.png
-  :alt: Learner Reports present a quick view of all the content accessed by a learner.
+	.. figure:: img/learner-report-content.png
+	  :alt: Learner Reports present a quick view of all the content channels accessed by a learner.
 
-  Learner Reports present a quick view of all the content accessed by a learner.
+	  Learner Reports present a quick view of all the content channels accessed by a learner.
 
 .. note::
   In a Learner report, the username of the selected learner will be the last item in the breadcrumb navigation menu.
@@ -32,10 +34,10 @@ Navigate the topic tree of each channel to see the progress of the selected lear
 
 In the image below, you can see that the learner **Abby L.** accessed and completed only one of the subtopics from the topic **Addition and Subtraction to 10**: 
 
-.. figure:: img/learner-report-topic.png
-  :alt: Learner Reports across topics for the selected content channel.
+	.. figure:: img/learner-report-topic.png
+	  :alt: Navigate between topics in the list, or use the breadcrumb links to move between levels.
 
-  Learner Reports across topics for the selected content channel.
+	  Learner Reports across topics for the selected content channel.
 
 
 .. _exercise_progress:
@@ -46,32 +48,29 @@ Review Exercise Progress
 When a learner answers exercise questions in Kolibri, the progress bar below the exercise is taking into account only the most recent given answers, meaning that the learner must complete the required number of correct answers (*check marks*) **in the row** for the exercise to be considered completed.
 
 	.. figure:: img/get-5-correct.png
-	    :alt: If the exercise requires 5 check marks, learner must provide 5 correct answers one after another.
+	    :alt: If the exercise requires 5 correct check marks, learner must provide 5 correct answers one after another. Marks for each answer are located behind the button Check
 
-	    The correct answers in the image above are not in a row; this exercise will be completed only after the learner gives 5 correct answers one after another.
+	    The correct answers (green check marks) in the image above are not in a row; this exercise will be completed only after the learner gives 5 correct answers one after another.
 
-In the example below, the progress bar for the exercise **Subtract within 5** will appear as 40%, because the student has given 2 correct answers within the most recent set of 5 attempts. For example: If this student had made 20 incorrect attempts before the 4 displayed attempts, those 20 incorrect attempts would not get factored into the progress bar.
+In the example below, the progress bar for the exercise **Subtract within 5** displays 40%, because the student has given 2 correct answers *within the most recent set of 5 attempts*. For example, if this student had made 20 incorrect attempts before the 4 displayed attempts, those 20 incorrect attempts would not get factored into the progress bar.
 
 	.. figure:: img/topic-view-detail.png
-	    :alt: View average progress for a single exercise or resource in a topic.
+	    :alt: 
 
 Click the exercise title to see all the answers and attempts on each question. In the figure below, you can see the progress of the learner **Hansen** for the exercise **Numbers to 120**. The exercise is still **In progress** as the learner has not completed the 5 correct answers in the row. You can also see that for the *Question 13*, the learner has given the correct answer only on the 4th attempt, which indicates that they are still struggling with the given concept.
 
-.. figure:: img/learner-exercise-attempts.png
-    :alt: Details for answers and attempts of a single exercise.
+	.. figure:: img/learner-exercise-attempts.png
+	    :alt: Navigate among questions in the chosen exercise, and observe weather the attempts on each one were correct or not.
 
-    Details for answers and attempts on a single exercise.
+	    Details for answers and attempts on a single exercise.
 
 
 How does it looks if learner A does 5 correct answers in a row on their first try, but learner B gets 10 wrong answers in a row before giving 5 correct ones in a row? In both cases, the progress would show as 100%, and you would have to click each learner's name to access their progress report and attempt history.
 
 In the figure below, you can see the progress of 5 learners for the exercise **Numbers to 120** in ascending order.
 
-.. figure:: img/exercise-view-detail.png
-    :alt: View the progress for a single exercise or resource in a topic.
-
-    View the progress for a single exercise or resource in a topic.
-
+	.. figure:: img/exercise-view-detail.png
+	    :alt: 
 
 
 .. include:: manage/_groups.rst
@@ -91,8 +90,8 @@ Recent Class Activity
 
 Use the **Recent** tab (|recent| icon) to access a report of channels and items (exercises and resources - videos, reading material, etc.) accessed during the last 7 days by learners of the selected class.
 
-	.. image:: img/coach-recent.png
-	  :alt: coach recent activity
+	.. figure:: img/coach-recent.png
+	  :alt: 
 
 If the enrolled learners have access to more than one channel, you will see the list of channels firstly. From there, you can navigate by topics and subtopics until you arrive to a specific item. In the item's view, you can review the progress of each learner in the class that accessed the item.
 
@@ -105,26 +104,25 @@ Class Activity by Channels
 Use this tab (|channels| icon) to access the full report of activity progress for the selected class. You can navigate channels by topics and subtopics until you see the progress of each class learner for a specific item.
 
 	.. figure:: img/topic-activity.png
-	  :alt: Use the topic view to see the average progress for exercises and resources for all the learners in the class.
-
-	  Use the channel view to see the average progress for exercises and resources for all the learners in the class.
-
+	  :alt: 
 
 When you navigate to the last level in the topic tree, you can see the average progress of all class learners for each exercise or resource (video, document, HTML5 activity) in that particular topic.
 
+.. _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. 
 
 	.. figure:: img/coach-resource-studio.png
-	  :alt: Setting the visibiility of content in Kolibri Studio.
+	  :alt: In Kolibri Studio content curators can set the visibility for a single resource, or for the entire topic.
 
-	  Setting the visibiility of content in Kolibri Studio.
+	  Setting the visibility of content in Kolibri Studio.
 
 Coach resources and content channels that contain them are marked with the |coach-resource| icon in Kolibri.
 
 	.. figure:: img/coach-resource.png
-	  :alt: Content channel with 4 support resources for coaches in Kolibri.
+	  :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.

docs/conf.py

@@ -153,7 +153,6 @@ def setup(app):
 .. role:: raw-html(raw)
       :format: html
 
-.. |content| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">apps</span><span class="visuallyhidden">Content</span>`
 .. |info| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">perm_device_information</span><span class="visuallyhidden">Info</span>`
 .. |permissions| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">https</span><span class="visuallyhidden">Permissions</span>`
 .. |edit| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">create</span><span class="visuallyhidden">Edit</span>`
@@ -179,6 +178,11 @@ def setup(app):
 .. |in-progress| replace:: :raw-html:`<span class="material-icons schedule" aria-hidden="true">schedule</span><span class="visuallyhidden">In progress</span>`
 .. |completed| replace:: :raw-html:`<span class="material-icons star" aria-hidden="true">star</span><span class="visuallyhidden">Completed</span>`
 .. |recommended| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">forum</span><span class="visuallyhidden">Recommended</span>`
+.. |toc| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">list</span><span class="visuallyhidden">Table of content</span>`
+.. |epub-settings| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">tune</span><span class="visuallyhidden">Ebook settings</span>`
+.. |fullscreen| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">fullscreen</span><span class="visuallyhidden">Enter fullscreen</span>`
+.. |previous-page| replace:: :raw-html:`<span class="material-icons outline" aria-hidden="true">keyboard_arrow_left</span><span class="visuallyhidden">Previous page</span>`
+.. |next-page| replace:: :raw-html:`<span class="material-icons outline" aria-hidden="true">keyboard_arrow_right</span><span class="visuallyhidden">Next page</span>`
 .. |on-device| image:: img/on-device.png
    :alt: On your device
 .. |green-check| image:: img/on-device.png

docs/contact.rst

@@ -3,7 +3,7 @@
 Get in touch
 ============
 
-
+.. _forums:
 .. _get_support_ref:
 
 Getting support from Learning Equality and our community
@@ -13,11 +13,12 @@ Due to the open-source nature of our work, we encourage that all inquiries, inpu
 
 The first thing you need to do is register on the forum. Once registered, please read the the first two pinned topics (*Welcome to LE’s Support Community* and *How do I post to this forum?* ) 
 
-You can add a new topic with the **+ New Topic** button on the right. Make sure to select the appropriate category in the **Create a New Topic** window to facilitate the triage and response processes.
+You can add a new topic with the :guilabel:`+ New Topic` button on the right. Make sure to select the appropriate category in the **Create a New Topic** window to facilitate the triage and response processes.
 
 .. image:: img/community-forums.png
   :alt: add new topic on community forums
 
+
 Feedback
 --------
 
@@ -31,6 +32,9 @@ new ideas to the `Community Forums <https://community.learningequality.org/>`_.
 Technical issues
 ~~~~~~~~~~~~~~~~~
 
+Try reading the :ref:`Troubleshooting <support>` section of this guide first.
+
+
 In order to report  a technical issue, you can either use the *Support* category in our forum, or open up an issue report in our public software repository, following the guidelines:
 
 `github.com/learningequality/kolibri <https://github.com/learningequality/kolibri/>`__

docs/faq.rst

@@ -32,8 +32,6 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 +---------------------------+-----------------+-----------------+ 
 | Bengali                   | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Burmese                   | ✓               |                 |
-+---------------------------+-----------------+-----------------+
 | Chinyanja                 | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Farsi                     | ✓               |                 |
@@ -42,8 +40,6 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 +---------------------------+-----------------+-----------------+
 | Hindi                     | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Kannada                   | ✓               |                 |
-+---------------------------+-----------------+-----------------+
 | Marathi                   | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Portuguese (Brazil)       | ✓               |                 |
@@ -56,13 +52,13 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 +---------------------------+-----------------+-----------------+
 | Tamil                     | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Telugu                    | ✓               |                 |
+| Bulgarian                 | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Urdu (Pakistan)           | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Yoruba                    | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Zulu                      | ✓               |                 |
+| Vietnamese                | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 
 To contribute to Kolibri and Kolibri Studio as a translator, you can get started over on our `translations and internationalization page <http://learningequality.org/translate/>`_.