Merge pull request #238 from radinamatic/docs-0.15-updates

Docs updates for the 0.15 release, ready for Imps review.
learningequality · Jan 10, 2022 · 446f581 · 446f581
2 parents 8b19612 + dec6949
commit 446f581
Show file tree

Hide file tree

Showing 51 changed files with 346 additions and 244 deletions.
diff --git a/docs/access/access_lan.rst b/docs/access/access_lan.rst
@@ -1,9 +1,19 @@
 .. _access_lan:
 
-Accessing Kolibri from Other Devices
-####################################
+Accessing Kolibri device from other client 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 resources on the server.
+Here are definitions of concepts necessary to understand how Kolibri works in your local network.
+
+.. glossary::
+
+    Server
+      Any device that can make digital data (videos, files, etc.) available for browsing, either to other clients and peers on the local network, or publicly on the Internet. When Kolibri is installed and run on a device, it effectively turns that device into a ‘Kolibri server’, which means that device is capable of transmitting (‘serving’) educational resources. 
+
+    Client
+      TO-DO
+
+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 as clients the learning resources on the server.
 
 Compatibility
 *************
@@ -20,7 +30,7 @@ Kolibri currently supports the following combinations of operating systems and b
   *	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
+Set up access on other devices
 ******************************
 
 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.

diff --git a/docs/access/change_language.rst b/docs/access/change_language.rst
@@ -1,6 +1,6 @@
 .. _change_language:
 
-Change Language
+Change language
 ###############
 
 To change language in which the **Kolibri** user interface is displayed, follow these steps:
@@ -13,7 +13,7 @@ To change language in which the **Kolibri** user interface is displayed, follow
 .. figure:: /img/change-language.png
     :alt: 
 
-    Kolibri flies in 23 languages!
+    Kolibri flies in 29 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.
diff --git a/docs/access/linux.rst b/docs/access/linux.rst
@@ -11,7 +11,7 @@ Starting Kolibri on Linux will differ depending on the method you used to instal
 
 * If you installed Kolibri through the :ref:`PPA <ppa>`, or :ref:`generic installation <pip-installation>` with ``pip install`` command, follow these steps.
 
-  1. Run this command in Terminal to start Kolibri:
+  1. Run this command in Terminal to **start Kolibri**:
 
     .. code-block:: bash
 
@@ -23,7 +23,7 @@ Starting Kolibri on Linux will differ depending on the method you used to instal
     .. note::
       Remember to :ref:`configure other computers <access_LAN>` in the network to access **Kolibri**.
 
-  3. Run this command in Terminal to stop Kolibri:
+  3. Run this command in Terminal to **stop Kolibri**:
 
     .. code-block:: bash
 

diff --git a/docs/access/windows.rst b/docs/access/windows.rst
@@ -8,7 +8,7 @@ To start the **Kolibri** server on Windows, just double-click the desktop shortc
 When you see the notification *Kolibri is running...*, **Kolibri** will open in the browser with the URL http://127.0.0.1:8080.
 
 
-Kolibri Taskbar Options
+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.  

diff --git a/docs/coach/groups.rst b/docs/coach/groups.rst
@@ -1,7 +1,7 @@
 
 .. _manage_groups:
 
-Manage Groups
+Manage groups
 -------------
 
 In case you need to further divide learners inside classes, for example to address the different progress needs, you can use the **groups** feature. Create and delete groups, as well as assign learners to them from the |group| **Groups** sub-tab in the |edit| **Plan** tab of your |coach| **Coach** dashboard. Default view displays the list of all groups for the selected class, with the number of assigned learners for each group.
@@ -18,7 +18,7 @@ In case you need to further divide learners inside classes, for example to addre
 
 Captions for the video are available in English, French, Swahili, Arabic, Hindi, Marathi and Brazilian Portuguese.
 
-Create a New Group
+Create a new group
 """"""""""""""""""
 
 To create a new learner group, follow these steps.
@@ -28,7 +28,7 @@ To create a new learner group, follow these steps.
 #. Click :guilabel:`SAVE` to confirm, or :guilabel:`CANCEL` to exit without creating a group.
 
 
-Enroll Learners in a Group
+Enroll learners in a group
 """"""""""""""""""""""""""
 
 #. Click to open the desired group in the **Groups** sub-tab.
@@ -44,14 +44,14 @@ Enroll Learners in a Group
 #. Use checkboxes to select all the learners in the list, or the search field for specific learners you want to enroll in the group.
 #. Click :guilabel:`CONFIRM` to finish enrolling the selected learners and return to the group page.
 
-Remove Learners from Group
+Remove learners from group
 """"""""""""""""""""""""""
 
 #. Click :guilabel:`REMOVE` for the chosen learner.
 #. Click :guilabel:`REMOVE` to confirm, or :guilabel:`CANCEL` to exit without removing the learner.
 
 
-Rename Group
+Rename group
 """"""""""""
 
 To rename group, follow these steps.
@@ -62,7 +62,7 @@ To rename group, follow these steps.
 #. Click the :guilabel:`SAVE` button to proceed, or :guilabel:`CANCEL` to exit without renaming the group.
 
 
-Delete Group
+Delete group
 """"""""""""
 
 To delete a group, follow these steps.

diff --git a/docs/coach/index.rst b/docs/coach/index.rst
@@ -1,6 +1,6 @@
 .. _coach:
 
-Coach your Learners in Kolibri
+Coach your learners in Kolibri
 ##############################
 
 You can track progress of the **Learners**, create and assign **Lessons** and **Quizzes** to classes or learner groups from the |coach| **Coach** dashboard. The default view presents the list of |classes| **Classes** with their assigned coaches, and the number of learners enrolled in each class.
@@ -25,7 +25,7 @@ Captions for the video are available in English, French, Swahili, Arabic, Hindi,
 .. _track_progress:
 
 
-Class Home
+Class home
 ~~~~~~~~~~
 
 On the |dashboard| **Class Home** tab you can see the overview of the class activity and track progress of the learners on lessons and quizzes assigned to them.
@@ -59,7 +59,7 @@ You can review the progress of learners on the assigned lessons in the |lesson|
 * Click :guilabel:`VIEW ALL` to access the full list of notification about lessons (only the 3 most recent are displayed in the block).
 
 
-Class Activity
+Class activity
 --------------
 
 As learners interact with lessons and quizzes, you can track their progress in the **Class activity** block. 
@@ -94,7 +94,7 @@ Kolibri presents actionable reports for each lesson and quiz the class learners
 
 .. TO-DO (image)
 
-Print and Export Coach Reports
+Print and export coach reports
 ------------------------------
 
 On any coach report where you see the |print| (print) and |download| (download) buttons, you will be able to print on paper, save in a PDF format, or export as a CSV file, for further analysis or to share with others. Follow these steps.
@@ -121,7 +121,7 @@ Use the options in the |edit| **Plan** tab to create and manage the lessons, qui
 .. _coach_resource:
 
 
-Coach Support Resources
+Coach support resources
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 `Kolibri Studio <https://studio.learningequality.org/>`_ supports the option to set visibility for any resource added to channels as a |coachContent| **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 |channel| **Channels**, but only to admins, facility coaches, or other users assigned to coach classes. 

diff --git a/docs/coach/lessons.rst b/docs/coach/lessons.rst
@@ -1,7 +1,7 @@
 
 .. _manage_lessons:
 
-Manage Lessons
+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. 
@@ -20,7 +20,7 @@ To view, create or delete lessons, as well as assign them to learners, use the *
 
 Captions for the video are available in English, French, Swahili, Arabic, Hindi, Marathi and Brazilian Portuguese.
 
-Create New Lesson
+Create new lesson
 """""""""""""""""
 
 To create a new |lesson| lesson, follow these steps.
@@ -70,7 +70,7 @@ To create a new |lesson| lesson, follow these steps.
 9. To add more resources to the same lesson and keep editing if needed, follow the steps 4 to 9 again.
 
 
-Change Lesson Visibility
+Change lesson visibility
 """"""""""""""""""""""""
 
 A newly created lesson is by default *not visible to learners*, and they will not see it in the **Learn > Classes** view. 
@@ -85,7 +85,7 @@ A newly created lesson is by default *not visible to learners*, and they will no
   You can also change lesson visiblity from its own **Report**, and the list in the **Reports > Lessons** subtab.
 
 
-Change Lesson Recipients
+Change lesson recipients
 """"""""""""""""""""""""
 
 You can change the recipients of the lesson, reassigning the lesson to a different group or the entire class. Follow these steps.
@@ -96,7 +96,7 @@ You can change the recipients of the lesson, reassigning the lesson to a differe
 #. Click :guilabel:`SAVE CHANGES` to confirm, or :guilabel:`CANCEL` to exit without change.
 
 
-Copy Lesson
+Copy lesson
 """""""""""
 
 To copy a lesson to a different group or another class of your facility, follow these steps.
@@ -110,7 +110,7 @@ To copy a lesson to a different group or another class of your facility, follow
 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.
 
 
-Rename Lesson
+Rename lesson
 """""""""""""
 
 To rename a lesson, follow these steps.
@@ -121,7 +121,7 @@ To rename a lesson, follow these steps.
 #. Click :guilabel:`SAVE` to confirm, or :guilabel:`CANCEL` to exit without renaming the lesson.
 
 
-Delete Lesson
+Delete lesson
 """""""""""""
 
 To delete a lesson, follow these steps.

diff --git a/docs/coach/quizzes.rst b/docs/coach/quizzes.rst
@@ -1,7 +1,7 @@
 
 .. _manage_quizzes:
 
-Manage Quizzes
+Manage quizzes
 --------------
 
 You can view, create and delete quizzes, as well as assign them to learners, using the **Quizzes** sub-tab in the |edit| **Plan** tab of your |coach| **Coach** dashboard. The default view displays the list of all quizzes in a selected class, with indicators of their visibility status and groups they are assigned to.
@@ -18,7 +18,7 @@ You can view, create and delete quizzes, as well as assign them to learners, usi
 
 Captions for the video are available in English, French, Swahili, Arabic, Hindi, Marathi and Brazilian Portuguese.
 
-Create New Quiz
+Create new quiz
 """""""""""""""
 
 To create a new |quiz| quiz, click the :guilabel:`NEW QUIZ` button.
@@ -61,7 +61,7 @@ To create a new |quiz| quiz, click the :guilabel:`NEW QUIZ` button.
 * When you are satisfied with the question order click the :guilabel:`FINISH` button, and you will see a confirmation notification at the bottom.
 
 
-Change Quiz Recipients
+Change quiz recipients
 """"""""""""""""""""""
 
 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.
@@ -74,7 +74,7 @@ Newly created quizzes are by default visible to entire class. To change quiz *Re
   .. figure:: /img/exam-visibility.png
     :alt: 
 
-Start and End Quiz
+Start and end quiz
 """"""""""""""""""
 
 Newly created quizzes are by default *not started*, meaning that learners will not see it in the **Learn > Classes** view. 
@@ -90,7 +90,7 @@ Newly created quizzes are by default *not started*, meaning that learners will n
   You can also start and end the quiz from its **Report** page, and the list in the **Reports > Quizzes** subtab.
 
 
-Copy Quiz
+Copy quiz
 """""""""
 
 To copy a quiz to a different group or another class, follow these steps.
@@ -112,7 +112,7 @@ To rename quiz, follow these steps.
 #. Change the quiz title in the confirmation window.
 #. Click :guilabel:`SAVE CHANGES` to confirm, or :guilabel:`CANCEL` to exit without renaming the quiz.
 
-Delete Quiz
+Delete quiz
 """""""""""
 
 To delete quiz, follow these steps.

diff --git a/docs/conf.py b/docs/conf.py
@@ -15,7 +15,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.14"
+DISPLAY_VERSION = "0.15"
 
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -177,6 +177,8 @@ def setup(app):
      :format: html
 
 .. |br| replace:: :raw-html:`<br /><br />`
+.. |version| replace:: 0.15
+.. |version-b| replace:: :raw-html:`<strong>0.15</strong>`
 
 
 """

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -58,12 +58,20 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 +---------------------------+-----------------+-----------------+
 | Fulfulde Mbororoore       | ✓               |                 |
 +---------------------------+-----------------+-----------------+
+| Georgian                  | ✓               |                 |
++---------------------------+-----------------+-----------------+
 | German                    | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Gujarati                  | ✓               |                 |
 +---------------------------+-----------------+-----------------+
+| Greek                     | ✓               |                 |
++---------------------------+-----------------+-----------------+
+| Hausa                     | ✓               |                 |
++---------------------------+-----------------+-----------------+
 | Hindi (India)             | ✓               |                 |
 +---------------------------+-----------------+-----------------+
+| Indonesian                | ✓               |                 |
++---------------------------+-----------------+-----------------+
 | Italian                   | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Khmer                     | ✓               |                 |
@@ -72,11 +80,13 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 +---------------------------+-----------------+-----------------+
 | Marathi                   | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Portuguese (Brazil)       | ✓               |                 |
+| Portuguese (Brazil)       | ✓               | ✓               |
++---------------------------+-----------------+-----------------+
+| Portuguese (Mozambique)   | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Spanish (Latin America)   | ✓               | ✓               |
+| Spanish (Latin America)   | ✓               |                 |
 +---------------------------+-----------------+-----------------+
-| Spanish (Spain)           | ✓               |                 |
+| Spanish (Spain)           | ✓               | ✓               |
 +---------------------------+-----------------+-----------------+
 | Swahili (Tanzania)        | ✓               |                 |
 +---------------------------+-----------------+-----------------+

diff --git a/docs/img/breadcrumbs-folded.png b/docs/img/breadcrumbs-folded.png
diff --git a/docs/img/breadcrumbs.png b/docs/img/breadcrumbs.png
diff --git a/docs/img/change-language.png b/docs/img/change-language.png
diff --git a/docs/img/channels.png b/docs/img/channels.png
diff --git a/docs/img/exams-lessons.png b/docs/img/exams-lessons.png
diff --git a/docs/img/import-individual-user-accounts.png b/docs/img/import-individual-user-accounts.png
diff --git a/docs/img/initial-setup-add-device.png b/docs/img/initial-setup-add-device.png
diff --git a/docs/img/initial-setup-select-device.png b/docs/img/initial-setup-select-device.png
diff --git a/docs/img/learn-classes.png b/docs/img/learn-classes.png
diff --git a/docs/img/learn-only-select-device.png b/docs/img/learn-only-select-device.png
diff --git a/docs/img/navbar-learner.png b/docs/img/navbar-learner.png
diff --git a/docs/img/points.png b/docs/img/points.png
diff --git a/docs/img/resource-topbar.png b/docs/img/resource-topbar.png
diff --git a/docs/img/search.png b/docs/img/search.png
diff --git a/docs/img/select-facility-import-individual-user-accounts.png b/docs/img/select-facility-import-individual-user-accounts.png
diff --git a/docs/img/select-facility-setup.png b/docs/img/select-facility-setup.png
diff --git a/docs/img/video-metadata.png b/docs/img/video-metadata.png
diff --git a/docs/img/video.png b/docs/img/video.png