Merge pull request #203 from learningequality/release-v0.14.x

Release v0.14.x -> develop

README.rst

@@ -31,16 +31,36 @@ You will need an environment with `make <https://en.wikipedia.org/wiki/Make_(sof
 
   # Create a Python 3 virtual environment using Virtualenvwrapper
   # See: https://virtualenvwrapper.readthedocs.io/
-  $ mkvirtualenv -p python3 kolibri-docs
+  mkvirtualenv -p python3 kolibri-docs
 
   # Install Python requirements
-  $ pip install -r requirements.txt
+  pip install -r requirements.txt
 
-  # Build docs with Sphinx
-  $ make docs  
 
-  # Open the docs with Firefox
-  $ firefox docs/_build/html/index.html
+Build and run:
+
+.. code-block:: bash
+
+  make docs
+
+You should now be able open the built docs with a web browser at ``docs/_build/html/index.html``.
+
+You can also have the docs automatically build and reload:
+
+.. code-block:: bash
+
+  sphinx-autobuild docs docs/_build/html
+
+
+You should now be able open the automatically-rebuilding docs with a web browser at ``http://127.0.0.1:8000``.
+
+
+Internationalization
+--------------------
+
+Some commands related to i18n:
+
+.. code-block:: bash
 
   # Build a translated (Spanish) version
   $ make docs-translated lang=es
@@ -52,8 +72,10 @@ You will need an environment with `make <https://en.wikipedia.org/wiki/Make_(sof
   $ CROWDIN_API_KEY="your-secret-key" make crowdin-download crowdin-branch=release-v0.7.x
 
 
-Workflow
---------
+
+
+Release process
+---------------
 
 When a new release of Kolibri happens, we track that release in a branch here with the
 exact same name. We build this branch on Read The Docs.

docs/_static/theme_overrides.css

@@ -1,6 +1,4 @@
 
-@import url("https://fonts.googleapis.com/icon?family=Material+Icons");
-
 html[lang=ar] {
     direction: rtl;
 }
@@ -110,7 +108,7 @@ span.caption-text {
     margin-left: 6px;
     border-bottom: 1px solid #ccc;
     padding-bottom: 5px;
-    font-size: smaller; 
+    font-size: smaller;
 }
 
 code.docutils.literal.notranslate {
@@ -130,21 +128,14 @@ code.docutils.literal.notranslate {
  }
 
 .wy-nav-top {
-    background: #996189 !important;   
+    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;
-    padding-bottom: 8px !important;
-    padding-right: -5px !important;
-}
-
 .local_library {
 	color: #2196f3;
 }
@@ -164,7 +155,7 @@ code.docutils.literal.notranslate {
 
 .clock {
     padding-bottom: 1px !important;
-    border-radius: 50%;                                                                                            
+    border-radius: 50%;
     color: #2196f3;
 }
 
@@ -214,12 +205,61 @@ img {
     background: #feffe9 !important;
 }
 
-// Reported upstream: https://github.com/rtfd/sphinx_rtd_theme/issues/722
+/* Reported upstream: https://github.com/rtfd/sphinx_rtd_theme/issues/722 */
 .admonition {
   clear: both;
 }
 
 /* push down the RTD banner so it's not confused with menu */
 .keep-us-sustainable {
   margin-top: 20em !important;
-}
+}
+
+/*
+    Design system icon replacements default colors
+
+    See pregenerate.css in the design system for usage and for specific color
+    values see https://kolibri-design-system.netlify.app/colors/#tokens
+*/
+
+.design-system-icon svg {
+    width: 24px;
+    height: 24px;
+    vertical-align: top;
+}
+
+.design-system-icon-color-annotation {
+    fill: #616161;
+}
+
+.design-system-icon-color-coachContent {
+    fill: #0277bd;
+}
+
+.design-system-icon-color-correct {
+    fill: #43a047;
+}
+
+.design-system-icon-color-error {
+    fill: #d32f2f;
+}
+
+.design-system-icon-color-incorrect {
+    fill: #c62828;
+}
+
+.design-system-icon-color-mastered {
+    fill: #ffc107;
+}
+
+.design-system-icon-color-progress {
+    fill: #03a9f4;
+}
+
+.design-system-icon-color-success {
+    fill: #388e3c;
+}
+
+.design-system-icon-color-textDisabled {
+    fill: #e0e0e0;
+}

docs/access/access_lan.rst

@@ -29,7 +29,7 @@ For example, if Kolibri is installed and started on a computer with the address
 
 
 .. tip::
-  * You can check the IP (**Server URL**) of the device where Kolibri is running by going to **Info** tab in the **Device** dashboard.
+  * You can check the IP (**Server URL**) of the device where Kolibri is running by going to |deviceInfo| **Info** tab in the |device| **Device** dashboard.
 
     .. figure:: ../img/device-info.png
       :alt: Open the Device page and navigate to the Info tab to find the IP (Server URL) for your device.

docs/coach/groups.rst

@@ -4,7 +4,7 @@
 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 **Groups** sub-tab in the **Plan** tab (|edit| icon) of your **Coach** dashboard. Default view displays the list of all groups for the selected class, with the number of assigned learners for each group.
+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 **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.
 
 	.. figure:: /img/groups.png
 	  :alt: Open Coach > Plan page and navigate to Groups tab to view and manage learners and groups.

docs/coach/index.rst

@@ -3,7 +3,7 @@
 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** dashboard. The default view of the **Coach** dashboard presents the list of **Classes** with their assigned coaches, and the number of learners enrolled in each class.
+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.
 
 Click on a class to access the progress-tracking features and create lessons, quizzes and groups.
 
@@ -18,7 +18,7 @@ Click on a class to access the progress-tracking features and create lessons, qu
 Class Home
 ~~~~~~~~~~
 
-On the **Class Home** tab (|class-home| icon) you can see the overview of the class activity and track progress of the learners on lessons and quizzes assigned to them.
+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.
 
 	.. figure:: /img/class-home.png
 	  :alt: Open the Coach page to view the list of classes
@@ -29,10 +29,10 @@ On the **Class Home** tab (|class-home| icon) you can see the overview of the cl
 Quizzes
 -------
 
-You can review the progress of learners on the assigned quizzes in the **Quizzes** |exams| block.
+You can review the progress of learners on the assigned quizzes in the |quiz| **Quizzes** block.
 
-* Progress bar will indicate how many learners have started |started| and completed |completed-small| the quiz.
-* You can click on the progress bar to open the complete quiz data in the **Reports** tab.
+* Progress bar will indicate how many learners have |inProgress| started and |mastered| completed the quiz.
+* You can click on the progress bar to open the complete quiz data in the |reports| **Reports** tab.
 * Click :guilabel:`VIEW ALL` to access the full list of notifications about quizzes (only the 3 most recent are displayed in the block).
 
 .. note::
@@ -42,10 +42,10 @@ You can review the progress of learners on the assigned quizzes in the **Quizzes
 Lessons
 -------
 
-You can review the progress of learners on the assigned lessons in the **Lessons** |lessons| block.
+You can review the progress of learners on the assigned lessons in the |lesson| **Lessons** block.
 
-* Progress bar will indicate how many learners have started |started| and completed |completed-small| the lesson, and if they need help |need-help| with  some of the resources in it.
-* You can click on the progress bar to open the complete lesson data in the **Reports** tab.
+* Progress bar will indicate how many learners have |inProgress| started and |mastered| completed the lesson, and if they |helpNeeded| need help with some of the resources in it.
+* You can click on the progress bar to open the complete lesson data in the |reports| **Reports** tab.
 * Click :guilabel:`VIEW ALL` to access the full list of notification about lessons (only the 3 most recent are displayed in the block).
 
 
@@ -54,10 +54,10 @@ Class Activity
 
 As learners interact with lessons and quizzes, you can track their progress in the **Class activity** block. 
 
-* When learners start or complete lessons, you will see one notification displaying the title of the lesson they started |started| or completed |completed-small|, and another displaying the title of the specific resource in the lesson they interacted with. In case of quizzes, you will see only the quiz title notification.
+* When learners start or complete lessons, you will see one notification displaying the title of the lesson they |inProgress| started or |mastered| completed, and another displaying the title of the specific resource in the lesson they interacted with. In case of quizzes, you will see only the quiz title notification.
 * When multiple learners are working on the same lesson or quiz, you will see a notification like *Learner1 and 3 other have started...*
-* When learners input multiple incorrect answers to a question in a lesson, the notification in the **Class activity** block will display that one or more learners need help |need-help| with a specific resource.
-* You can click each notification link to review the complete resource data in the **Reports** tab.
+* When learners input multiple incorrect answers to a question in a lesson, the notification in the **Class activity** block will display that one or more learners |helpNeeded| need help with a specific resource.
+* You can click each notification link to review the complete resource data in the |reports| **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:
@@ -66,7 +66,7 @@ As learners interact with lessons and quizzes, you can track their progress in t
 Reports
 ~~~~~~~
 
-**Reports** tab (|reports| icon) allows you to gain insight into detailed real-time progress of the learners for single resources in lessons and quizzes assigned to them.
+The |reports| **Reports** tab allows you to gain insight into detailed real-time progress of the learners for single resources in lessons and quizzes assigned to them.
 
 Kolibri presents actionable reports for each lesson and quiz the class learners have been assigned, together with the possibility to observe the progress by groups and individual learners.
 
@@ -87,19 +87,19 @@ Kolibri presents actionable reports for each lesson and quiz the class learners
 Print and Export Coach Reports
 ------------------------------
 
-On any coach report where you see the |print| and |export| icons, 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.
+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.
 
-#. Click the |print| icon for the report you want to print or save as PDF file on your local drive.
+#. Click the |print| (print) button for the report you want to print or save as PDF file on your local drive.
    You will either have to select your paper printer device, or the *Save as PDF* option in the print dialog.
 
-#. Click the |export| icon for the report you want to export as CSV file on your local drive. 
+#. Click the |download| (download) button for the report you want to export as CSV file on your local drive. 
 
 
 
 Plan
 ~~~~
 
-Use the options in the **Plan** tab to create and manage the lessons, quizzes, and groups for the selected class.
+Use the options in the |edit| **Plan** tab to create and manage the lessons, quizzes, and groups for the selected class.
 
 .. toctree::
   :maxdepth: 1
@@ -114,7 +114,7 @@ Use the options in the **Plan** tab to create and manage the lessons, quizzes, a
 Coach Support Resources
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-`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. 
+`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 |channel| **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.
 
@@ -123,7 +123,7 @@ However, coach can decide to include any of these resources in :ref:`lessons <ma
 
 	  Setting the visibility of resources in Kolibri Studio.
 
-Coach resources and channels that contain them are marked with the |coach-resource| icon in Kolibri.
+Coach resources and channels that contain them are marked with the |coachContent| (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.

docs/coach/lessons.rst

@@ -6,20 +6,19 @@ 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. 
-
+To view, create or delete lessons, as well as assign them to learners, use the **Lessons** sub-tab in the |edit| **Plan** tab (|edit| icon) of your |coach| **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.
 
 .. figure:: /img/lessons.png
     :alt: 
 
 .. note::
-  To manage |lessons| **Lessons** in Kolibri classes and groups, you must sign in as **coach**, **admin** or **super admin**.
+  To manage |lesson| **Lessons** in Kolibri classes and groups, you must sign in as **coach**, **admin** or **super admin**.
 
 
 Create New Lesson
 """""""""""""""""
 
-To create a new lesson |lessons|, follow these steps.
+To create a new |lesson| *lesson*, follow these steps.
 
 1. Click the :guilabel:`NEW LESSON` button.
 2. Fill in the field for the lesson title, description and choose individual learners, groups or the entire class as the recipients. 
@@ -42,7 +41,7 @@ To create a new lesson |lessons|, follow these steps.
   .. figure:: /img/select-lesson-resources2.png
     :alt: 
 
-6. Use the **Search** feature to look for resources about a specific subject. Write the search term in the field, and press the :guilabel:`ENTER` key or click the |search| button to display the results. When you finish, click the :guilabel:`EXIT SEARCH` button to return to the list of selected resources.
+6. Use the **Search** feature to look for resources about a specific subject. Write the search term in the field, and press the :guilabel:`ENTER` key or click the |search| (search) button to display the results. When you finish, click the :guilabel:`EXIT SEARCH` button to return to the list of selected resources.
 
   .. figure:: /img/search-lesson-resources.png
     :alt: There are 3 filters available to refine the search; click to open each and select one of the options.
@@ -54,8 +53,8 @@ To create a new lesson |lessons|, follow these steps.
 
 8. After you've selected the resources for the lesson, you can:
 
-    * Grab the |drag| button to reorder lesson resources with the mouse (drag and drop).
-    * Use the |arrow-up| and |arrow-down| buttons to reorder by keyboard navigation.
+    * Grab the |dragHorizontal| (drag) button to reorder lesson resources with the mouse (drag and drop).
+    * Use the |chevronUp| (up) and |chevronDown| (down) buttons to reorder by keyboard navigation.
     * Click the :guilabel:`REMOVE` button to delete a resource.
 
       .. figure:: /img/reorder-lesson-resources.png