Merge pull request #8 from radinamatic/docs-0.8-update

Belated changes for the 0.8 release
learningequality · Mar 29, 2018 · 3075188 · 3075188
2 parents 8d313c9 + 43f4e10
commit 3075188
Show file tree

Hide file tree

Showing 51 changed files with 234 additions and 55 deletions.
diff --git a/docs/access.rst b/docs/access.rst
@@ -35,9 +35,6 @@ While it is running, **Kolibri** will display an icon in the Windows taskbar (us
 Starting Kolibri on Linux
 =========================
 
-.. warning::
-  Final **Kolibri** installer for Linux and OSX is not released yet, so these steps are *Work in Progress*!
-
 1. Run this command in Terminal to start Kolibri:
 
   .. code-block:: bash

diff --git a/docs/coach.rst b/docs/coach.rst
@@ -3,74 +3,108 @@
 Coach your Learners in Kolibri
 ##############################
 
-You can track progress of the **Learner** users, create and assign **Exams** to classes or learner groups from the **Coach** dashboard. The default view of the **Coach** dashboard presents the list of **Classes** with number of learners enrolled to each class.
+You can track progress of the **Learner** users, create and assign **Lessons** and **Exams** to classes or learner groups from the **Coach** dashboard. The default view of the **Coach** dashboard presents the list of **Classes** with number of learners enrolled to each class.
 
 Select a class from the list to access the progress-tracking features and create exams.
 
-	.. image:: img/coach-home.png
+	.. figure:: img/coach-home.png
 	  :alt: default coach view with list of classes
 
+.. _track_progress:
 
-.. _recent_view:
 
-View Recent Activity
+View Learner Reports
 ~~~~~~~~~~~~~~~~~~~~
 
-This is the default view when you select a class from the **Coach** dashboard. It displays the list of channels and items (exercises and resources - videos, reading material, etc.) accessed during the last 7 days by learners of the selected class.
+This is the default view when you select a class from the **Coach** dashboard. It displays the list of learners in the class and the group they are asigned to.
 
-	.. image:: img/coach-recent.png
-	  :alt: coach recent activity
+When you click the username of a learner, you will see the list of content they accessed and when were they last active on each of the channels:
 
-If the class learners have access to more then one channel, you will first see the list of channels which you can navigate by topics and subtopics until you arrive to a specific item. In this view you can see the progress of each class learner for that specific item.
+	.. figure:: img/learner-report-content.png
+	  :alt: Learner Reports present a quick view of all the content accessed by a learner.
 
+	  Learner Reports present a quick view of all the content accessed by a learner.
 
-.. _topic_view:
 
-View Activity by Topic
-~~~~~~~~~~~~~~~~~~~~~~
+.. tip::
+  Username of the selected learner will be the last item in the breadcrumb menu on the top.
 
-Use this view 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 one 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.
+Navigate the topic tree of each channel to see the progress of the selected learner for the topics, subtopics and individual resources. In the image below you can see that the learner **abbyl** accessed and completed only one of the subtopics from the topic **Addition and Subtraction to 10**: 
 
-	  Use the topic view to see the average progress for exercises and resources for all the learners in the class.
+	.. figure:: img/learner-report-topic.png
+	  :alt: Learner Reports across topics for the selected content channel.
 
-.. _track_progress:
+	  Learner Reports across topics for the selected content channel.
 
-Track Learner Progress
-----------------------
 
-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.
+.. _exercise_progress:
+
+Review Exercise Progress
+------------------------
 
-When 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.
+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/correct-row.png
 	    :alt: If the exercise requires 5 check marks, learner must provide 5 correct answers one after another.
 
-	    The correct answers in the image above are not in a row; this exercise will be completed only after learner gives 5 correct answers one after another.
+	    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.
+
+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.
 
 	.. figure:: img/topic-view-detail.png
 	    :alt: View average progress for a single exercise or resource in a topic.
 
-In the example above, the progress bar for this exercise will appear as 40%, because the student has given 2 correct answers within the most recent set of 5 attempts. If this student had earlier made, for example, 20 incorrect attempts before the 4 displayed attempts, those 20 incorrect attempts don't get factored into the progress bar.
+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.
 
-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 see the attempt history.
+	.. figure:: img/learner-exercise-attempts.png
+	    :alt: View the details for all the answers and attempts for a single exercise.
+
+	    View the details for all the answers and attempts for 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.
+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.
 
-To see the progress of a single learner, click their name. 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: View the details for all the answers and attempts for a single exercise.
-
-	    View the details for all the answers and attempts for a single exercise.
 
 .. include:: manage/_groups.rst
 
+.. include:: manage/_lessons.rst
+
 .. include:: manage/_exams.rst
+
+
+.. _recent_view:
+
+View Class Recent Activity
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use this view to access the full report 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
+
+If the class 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.
+
+
+.. _topic_view:
+
+View Class Activity by Topic
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use this view 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 topic view to see the average progress for exercises and resources for all the learners in the class.
+
+
+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.
diff --git a/docs/conf.py b/docs/conf.py
@@ -158,6 +158,8 @@ def setup(app):
 .. |pencil| replace:: :raw-html:`<span class="fa fa-pencil" aria-hidden="true"></span><span class="visuallyhidden">Edit</span>`
 .. |arrow-right| replace:: :raw-html:`<span class="fa fa-arrow-right" aria-hidden="true"></span><span class="visuallyhidden">See next</span>`
 .. |arrow-left| replace:: :raw-html:`<span class="fa fa-arrow-left" aria-hidden="true"></span><span class="visuallyhidden">See previous</span>`
+.. |arrow-up| replace:: :raw-html:`<span class="fa fa-angle-up fa-lg fa-border" aria-hidden="true"></span><span class="visuallyhidden">Arrow up</span>`
+.. |arrow-down| replace:: :raw-html:`<span class="fa fa-angle-down fa-lg fa-border" aria-hidden="true"></span><span class="visuallyhidden">Arrow down</span>`
 
 """
 

diff --git a/docs/img/add-content-exam.png b/docs/img/add-content-exam.png
diff --git a/docs/img/add-new-account.png b/docs/img/add-new-account.png
diff --git a/docs/img/breadcrumbs.png b/docs/img/breadcrumbs.png
diff --git a/docs/img/change-lesson-status.png b/docs/img/change-lesson-status.png
diff --git a/docs/img/channels.png b/docs/img/channels.png
diff --git a/docs/img/coach-recent.png b/docs/img/coach-recent.png
diff --git a/docs/img/copy-lesson.png b/docs/img/copy-lesson.png
diff --git a/docs/img/env-vars.png b/docs/img/env-vars.png
diff --git a/docs/img/exam-menu.png b/docs/img/exam-menu.png
diff --git a/docs/img/exam-result.png b/docs/img/exam-result.png
diff --git a/docs/img/exam-visibility.png b/docs/img/exam-visibility.png
diff --git a/docs/img/exams-lessons.png b/docs/img/exams-lessons.png
diff --git a/docs/img/exams3.png b/docs/img/exams3.png
diff --git a/docs/img/exercise-view-detail.png b/docs/img/exercise-view-detail.png
diff --git a/docs/img/exercise.png b/docs/img/exercise.png
diff --git a/docs/img/explore.png b/docs/img/explore.png
diff --git a/docs/img/facility-setup-details.png b/docs/img/facility-setup-details.png
diff --git a/docs/img/facility-setup.png b/docs/img/facility-setup.png
diff --git a/docs/img/groups.png b/docs/img/groups.png
diff --git a/docs/img/import-internet.png b/docs/img/import-internet.png
diff --git a/docs/img/import-local-drive.png b/docs/img/import-local-drive.png
diff --git a/docs/img/import-local-drive2.png b/docs/img/import-local-drive2.png
diff --git a/docs/img/learn-admin.png b/docs/img/learn-admin.png
diff --git a/docs/img/learn-classes.png b/docs/img/learn-classes.png
diff --git a/docs/img/learn.png b/docs/img/learn.png
diff --git a/docs/img/learner-lesson-home.png b/docs/img/learner-lesson-home.png
diff --git a/docs/img/learner-report-content.png b/docs/img/learner-report-content.png
diff --git a/docs/img/learner-report-topic.png b/docs/img/learner-report-topic.png
diff --git a/docs/img/lesson-options.png b/docs/img/lesson-options.png
diff --git a/docs/img/lessons.png b/docs/img/lessons.png
diff --git a/docs/img/manage-content.png b/docs/img/manage-content.png
diff --git a/docs/img/manage-exams.png b/docs/img/manage-exams.png
diff --git a/docs/img/manage-permissions.png b/docs/img/manage-permissions.png
diff --git a/docs/img/new-lesson.png b/docs/img/new-lesson.png
diff --git a/docs/img/permissions-keys.png b/docs/img/permissions-keys.png
diff --git a/docs/img/preview-exam.png b/docs/img/preview-exam.png
diff --git a/docs/img/reorder-lesson-resources.png b/docs/img/reorder-lesson-resources.png
diff --git a/docs/img/search.png b/docs/img/search.png
diff --git a/docs/img/select-lesson-resources.png b/docs/img/select-lesson-resources.png
diff --git a/docs/img/select-lesson-resources2.png b/docs/img/select-lesson-resources2.png
diff --git a/docs/img/topic-activity.png b/docs/img/topic-activity.png
diff --git a/docs/img/video.png b/docs/img/video.png
diff --git a/docs/img/windows-firewall.png b/docs/img/windows-firewall.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -26,7 +26,7 @@
 Kolibri User Guide
 ==================
 
-**Kolibri** is an open-source educational platform specially designed to provide offline access to a wide range of quality, openly licensed educational content in low-resource contexts like rural schools, refugee camps, orphanages, and also in non-formal school programs.
+**Kolibri** is an open-source educational platform specially designed to provide offline access to a wide range of quality, openly licensed educational contents in low-resource contexts like rural schools, refugee camps, orphanages, and also in non-formal school programs.
 
 Kolibri can serve high quality education content from several publicly available **content channels**, collections of educational resources (exercises, videos, audio or document files) and associated metadata, prepared and organized for their use in Kolibri. It works in conjunction with `Kolibri Studio <https://studio.learningequality.org>`_, the curriculum tool used to organize content and build custom content channels, aligned to the local curricula, or according to specific learning needs.
 
@@ -52,7 +52,7 @@ Weather you are using Kolibri at your school, in a training center or at home, l
 For :ref:`Coaches and Tutors <coach>`
 *************************************
 
-Read how to :ref:`monitor activity <recent_view>` and :ref:`track the progress <track_progress>` of your learners on whole topics and exercises, all the way to single answer to a particular questions. Create and :ref:`manage different learner groups <manage_groups>`, administer :ref:`exams <manage_exams>` and view reports.
+Read how to :ref:`monitor activity <recent_view>` and :ref:`track the progress <track_progress>` of your learners on whole topics and exercises, all the way to single answers to particular questions. Create and :ref:`manage different learner groups <manage_groups>`, :ref:`assign lessons <manage_lessons>`, administer :ref:`exams <manage_exams>` and view reports.
 
 
 .. rst-class:: clearfix row
@@ -108,4 +108,4 @@ Happy learning with Kolibri!
 .. toctree::
    :maxdepth: 3
 
-   contact
+   contact
diff --git a/docs/install/_linux.rst b/docs/install/_linux.rst
@@ -7,7 +7,7 @@ Debian/Ubuntu Linux
 Install from PPA repository
 ---------------------------
 
-Use the following commands in Terminal to add the PPA and install Kolibri::
+Use the following commands in Terminal to add the PPA and install Kolibri:
 
 .. code-block:: bash
 
@@ -45,11 +45,8 @@ device to device.
 Uninstall
 ---------
 
-* Open up **Software** on Ubuntu and locate the Kolibri. Press **Remove**.
-
-OR
-
-* Use ``sudo apt-get remove <name of package>``. You need to know the exact name of the package you installed, most probably ``kolibri``.
+* Open **Software** on Ubuntu and locate the Kolibri. Press **Remove**.
+* Or from command line: ``sudo apt-get remove kolibri``.
 
 Upgrade
 -------

diff --git a/docs/learn.rst b/docs/learn.rst
@@ -46,7 +46,36 @@ To sign out from Kolibri you can either:
 Learn with Kolibri
 ==================
 
-Each time you login into **Kolibri**, the first thing you will see is the **Learn** page. Here you will find learning topics and materials related to what you were doing the last time you used Kolibri, or those recommended by your teachers and coaches (not visible if you are browsing as a guest).
+Classes
+^^^^^^^
+
+Each time you login into **Kolibri**, the first thing you will see is the **Learn** page with the list of all the classes you are enrolled to. 
+
+	.. figure:: img/learn-classes.png
+		:alt: Learn start page with all your classes.
+
+		Learn start page with all your classes.
+
+Select one of your classes to access :ref:`Lessons` and :ref:`Exams` your teachers or coaches prepared for your class.
+
+	.. figure:: img/exams-lessons.png
+		:alt: You can see all your lessons and exams in the Class tab.
+
+		You can see all your lessons and exams in the Class tab.
+
+
+Channels
+^^^^^^^^
+
+**Channels** tab offers you the option to navigate through the complete set of learning topics and materials available in Kolibri. Use it as you wish, or according to indications from your teachers and coaches.
+
+Depending on how your school and teachers or coaches decided to organize the content, you may have one or more channels available here. Follow the indications by your teachers or coaches on how to use the content from each available channel.
+
+.. figure:: img/channels.png
+	:alt: Content in Kolibri is grouped in channels.
+
+	Content in Kolibri is grouped in channels.
+
 
 Recommended
 ^^^^^^^^^^^
@@ -68,17 +97,7 @@ The number of displayed content items in each row will depend on the width of yo
 
 		Learn page gives you access to all Kolibri learning content and activities.
 
-Channels
-^^^^^^^^
-
-**Topics** tab offers you the option to navigate through the complete set of learning topics and materials available in Kolibri. Use it as you wish, or according to indications from your teachers and coaches.
-
-Depending on how your school and teachers or coaches decided to organize the content, you may have one or more channels available here. Follow the indications by your teachers or coaches on how to use the content from each available channel.
 
-.. figure:: img/channels.png
-	:alt: Content in Kolibri is grouped in channels.
-
-	Content in Kolibri is grouped in channels.
 
 Navigate Kolibri topics with breadcrumb links
 """""""""""""""""""""""""""""""""""""""""""""
@@ -180,12 +199,28 @@ PDF Viewer options
 
 Use the **Download content** button below the PDF viewer to download the PDF file to your computer.
 
+.. _lessons:
+
+Lessons
+^^^^^^^
+
+When your teacher or coach prepares a *lesson*, that is a recommended set of learning resources for you or your class to view, it will be available in the **Class** tab, below the **Lessons** heading. You may have more than one lesson available at the time.
+
+Click on a lesson title to open its content, and follow the indications of your teachers or coaches on how to use it.
+
+.. figure:: img/learner-lesson-home.png
+	:alt: lessons tab
+
+
+Here you will find learning topics and materials related to what you were doing the last time you used Kolibri, or those recommended by your teachers and coaches (not visible if you are browsing as a guest).
+
+
 .. _exams:
 
 Exams
 ^^^^^
 
-If your teacher/coach scheduled an exam for you or your class, it will be available through the **Exams** tab. You may have more than one exam available at the time.
+If your teacher or coach scheduled an exam for you or your class, it will be available in the **Class** tab, under the **Exams** heading. You may have more than one exam available at the time.
 
 .. figure:: img/exams3.png
 	:alt: exams tab
@@ -210,4 +245,3 @@ If your teacher/coach scheduled an exam for you or your class, it will be availa
 
 .. figure:: img/exam-result.png
 	:alt: exams tab
-
diff --git a/docs/manage/_command_line.rst b/docs/manage/_command_line.rst
@@ -143,7 +143,7 @@ Change the Location of ALL Kolibri Files
 
 If you want to change the directory where all of Kolibri’s runtime files go, the imported content channels, you need to change the environment variable called ``KOLIBRI_HOME`` to the path of your choice.
 
-If the variable is left unset, by default, Kolibri’s runtime files and content will be placed in your user’s :ref:`Home <home>` folder, under the ``.kolibri`` subfolder. 
+If the variable is left unset, by default, Kolibri’s runtime files and content will be placed in your user’s ``Home`` folder, under the ``.kolibri`` subfolder. 
 
 There are many ways to set an environment variable either temporarily or permanently. To start Kolibri on **OSX or Linux** with a different home, follow these steps.