Skip to content

Commit

Permalink
Merge pull request #183 from radinamatic/0.14.1-updates
Browse files Browse the repository at this point in the history
Integrated feedback from the Imps team, added new icons, updated 404 page
  • Loading branch information
radinamatic committed Aug 25, 2020
2 parents 326f9fa + e4b0475 commit 0aab021
Show file tree
Hide file tree
Showing 8 changed files with 83 additions and 67 deletions.
13 changes: 9 additions & 4 deletions docs/404.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
:orphan:

404
===
Page not found
==============

We looked everywhere but we couldn't find that page!
It seems you are searching for a topic that has been moved elsewhere in our documentation. Please try the following to find what you were looking for:

Try using the links in the sidebar or the search box to find what you are looking for, or go to the homepage.
* Browse the table of content in the sidebar (use |menu| to open it if you are on the mobile device)
* Use the search box

.. tip:: Make sure you are browsing the user guide for the `latest release of Kolibri <https://kolibri.readthedocs.io/en/latest/>`_.

We apologize for the inconvenience!
2 changes: 1 addition & 1 deletion docs/coach/quizzes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can view, create and delete quizzes, as well as assign them to learners, usi
.. TO-DO (icon)
.. note::
To manage **Quizzes** |exams| in Kolibri classes and groups you must sign in as **coach**, **admin** or **super admin**.
To manage **Quizzes** in Kolibri classes and groups you must sign in as **coach**, **admin** or **super admin**.


Create New Quiz
Expand Down
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,6 @@ def setup(app):
.. |users| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">people</span><span class="visuallyhidden">Users</span>`
.. |groups| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">group_work</span><span class="visuallyhidden">Groups</span>`
.. |recent| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">access_time</span><span class="visuallyhidden">Recent</span>`
.. |exams| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">assignment_late</span><span class="visuallyhidden">Quizzes</span>`
.. |channels| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">apps</span><span class="visuallyhidden">Channels</span>`
.. |settings| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">settings</span><span class="visuallyhidden">Settings</span>`
.. |data| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">save</span><span class="visuallyhidden">Data</span>`
Expand All @@ -207,6 +206,8 @@ def setup(app):
.. |class-home| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">dashboard</span><span class="visuallyhidden">Class home</span>`
.. |reports| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">assessment</span><span class="visuallyhidden">Reports</span>`
.. |drag| replace:: :raw-html:`<span class="material-icons drag" aria-hidden="true">drag_indicator</span>`
.. |facilities| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">domain</span><span class="visuallyhidden">Facilities</span>`
.. |menu| replace:: :raw-html:`<span class="material-icons" aria-hidden="true">menu</span><span class="visuallyhidden">Menu</span>`
.. |on-device| image:: ../img/on-device.png
:alt: On your device
.. |green-check| image:: /img/on-device.png
Expand All @@ -227,6 +228,8 @@ def setup(app):
:alt: Print
.. |export| image:: /img/export.png
:alt: Export
.. |exams| image:: /img/quiz-icon.png
:alt: Quizzes
"""

Expand Down
Binary file added docs/img/facilities-icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/quiz-icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 19 additions & 19 deletions docs/install/initial_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Initial Setup
Setting up Kolibri will be different depending on your learning environment:

* If you plan to use Kolibri at home or for supplemental learning outside any facility, use **Quick start**
* If you are installing Kolibri to be used by many learners at a formal facilities like schools, or non-formal like libraries or community centers, use **Advanced setup**.
* If you are installing Kolibri to be used by many learners at formal facilities like schools, or non-formal like libraries or community centers, use **Advanced setup**.

.. note::
You will only need to do the initial setup once, when you first start Kolibri after the installation. You can change all the settings later.
Expand Down Expand Up @@ -37,15 +37,15 @@ To do the initial setup of Kolibri for use at home, follow these steps.
Select Quick start for personal or home use of Kolibri.


#. **Create super admin account.** This user will be a **super admin**, able to manage all the content and all other Kolibri users on this device.
#. **Create a super admin account.** This user will be a **super admin**, able to manage all the content and all other Kolibri users on this device.

.. figure:: /img/super-admin.png
:alt:

Select the username and password for the super admin.

.. tip::
Make sure to save these super admin credentials in a safe place!
Make sure to save these super admin credentials in a safe place! Device super admin credentials cannot be retrieved when lost, and you will have to manually create another super admin account to manage your device.


Once you finish the initial setup, proceed to :ref:`import some learning resources <manage_resources_ref>`, and :ref:`create users <manage_users_ref>` if more people at your home are going to be using Kolibri. Make sure to check how to :ref:`configure other devices <access_LAN>` (computers, tablets or smartphones) in the home network to access Kolibri.
Expand Down Expand Up @@ -75,14 +75,14 @@ Advanced Setup
Select Advanced setup for use of Kolibri in group learning environments.


#. **Select the name of the device** on which Kolibri server will be running from. Choose a meaningful and recognizable name because it will help you identify it during syncing and importing processes later on.
#. **Select the name of the device** on which Kolibri server will be running from. Choose a meaningful and recognizable name because it will help you identify it during syncing and importing processes later on. If many devices are connected to your local network at the same time, the device where the Kolibri server is running must be easily recognizable for users on other devices who need to sync with it.

.. figure:: /img/device-name.png
:alt:

Select a meaningful name for the device.

#. **Create or import a facility**. In Kolibri we use the term "facility" to describe a set of user accounts, classes, and their associated data. Examples of facilities include schools, temporary learning hubs, groups of distributed at-home learners, and other situations requiring continuity between learners' activities. At this step you can choose to create a new facility or import one from another device.
#. **Create or import a facility**. In Kolibri we use the term facility to describe a set of user accounts, classes, and their associated data. Examples of facilities include schools, temporary learning hubs, groups of distributed at-home learners, and other situations requiring continuity between learners activities. At this step, you can choose to create a new facility or import one from another device.

Create a New Facility
*********************
Expand Down Expand Up @@ -115,21 +115,21 @@ Create a New Facility
.. figure:: /img/enable-passwords.png
:alt: Step 4 of 6.

Select if learners must type in their passwords to sign-in to Kolibri.
Select if learners must type in their passwords to sign in on Kolibri.


#. **Create super admin account**. This admin user will be a **super admin**, able to manage all the device content, and all the rest of the facility users and their permissions.
#. **Create super admin account**. This admin user will be a **super admin**, able to manage not only the content, but also all users and permissions in this facility.

.. figure:: /img/super-admin.png
:alt: Step 5 of 6.

Select the username and password for the facility super admin.

.. tip::
Make sure to save these super admin credentials in a safe place!
Make sure to save these super admin credentials in a safe place! Device super admin credentials cannot be retrieved when lost, and you will have to manually create another super admin account to manage your device.


#. **Responsibilities of the administrator**. When you are setting up a Kolibri facility you need to take into consideration the relevant privacy laws and regulations. You as the **super admin**, or someone you delegate, will be responsible for protecting and managing the user accounts and personal information stored on the device. Review the data usage and privacy statement before finishing the facility setup.
#. **Responsibilities of the administrator**. When you are setting up a Kolibri facility you need to take into consideration the relevant privacy laws and regulations. As **super admin**, you or someone you delegate, will be responsible for protecting and managing the user accounts and personal information stored on the device. Review the data usage and privacy statement before finishing the facility setup.

.. figure:: /img/super-admin-resp.png
:alt: Step 6 of 6.
Expand All @@ -145,11 +145,11 @@ Once you finish the initial setup, proceed to :ref:`import some learning resourc
Import Facility
***************

If you are part of a wider learning environment, or you need to sync the learner progress data from your facility with another device where Kolibri is running, you can choose to import a facility that is already set up on that device.
If you are part of a wider learning environment, where several learning facilities like schools or community centers are managed by one central organization, or you need to sync the learner progress data from your facility with another device where Kolibri is running, you can choose to import a facility that is already set up on that device.

#. Click :guilabel:`Import facility` button in the **Create or import facility** setup step.

#. Any device that has Kolibri running in the local network should appear in the **Select network address** window.
#. Any device that has Kolibri running in the local network should appear in the **Select network address** window. Read more on how set up a local network in the `Kolibri Hardware Guide <https://learningequality.org/r/hardware-guide>`_.

Select the device and click the :guilabel:`Continue` button.

Expand All @@ -163,14 +163,14 @@ If you are part of a wider learning environment, or you need to sync the learner
.. figure:: /img/initial-setup-add-device.png
:alt: Add the network address of the device manually.

Add the network address of the device manually.
Manually add the network address of the device.

.. warning:: **Firewals** may impede your ability to see other devices in your local network, or add them as source. If you are unable to see other devices, make sure to:
.. warning:: **Firewals** may impede your ability to see other devices in your local network or add them as source. If you are unable to see other devices, make sure to:

* disable the firewalls on all the devices that you need to sync
* restart Kolibri for broadcast to take effect

#. **Select facility**. If there several facilities on the device, select the one you want to import, and provide the administrative credentials.
#. **Select facility**. If there are several facilities on the device, select the one you want to import and provide the administrative credentials.

.. figure:: /img/initial-setup-select-facility-to-import.png
:alt: Step 1 of 4.
Expand All @@ -184,21 +184,21 @@ If you are part of a wider learning environment, or you need to sync the learner
.. figure:: /img/initial-setup-loading-facility.png
:alt: Step 2 of 4.

Facility is imported on your device.
Facility successfully imported onto your device.

#. **Create super admin account**. The account you create in this step will be a **super admin for your device**, and be able to manage all the device content, all the facility users, and their permissions.
#. **Create a super admin account**. The account you create in this step will be a **super admin for your device**, and be able to manage all the device content, all the facility users, and their permissions.

You can choose to create a new super admin account, or to use the credentials of the super admin of the device from where you imported the facility.
You can choose to create a new super admin account or to use the credentials of the super admin of the device from where you imported the facility.

.. figure:: /img/device-super-admin.png
:alt: Step 3 of 4.

Select the super admin account.

.. tip::
Make sure to save the super admin credentials in a safe place!
Make sure to save the super admin credentials in a safe place! Device super admin credentials cannot be retrieved when lost, and you will have to manually create another super admin account to manage your device.

#. **Responsibilities of the administrator**. When you are setting up a Kolibri facility, especially in formal environments like schools, you need to take into consideration the relevant privacy laws and regulations. You as the **super admin**, or someone you delegate, will be responsible for protecting and managing the user accounts and personal information stored on the device. Review the data usage and privacy statement before finishing the facility setup.
#. **Responsibilities of the administrator**. When you are setting up a Kolibri facility, especially in formal environments like schools, you need to take into consideration the relevant privacy laws and regulations. As **super admin**, you or someone you delegate, will be responsible for protecting and managing the user accounts and personal information stored on the device. Review the data usage and privacy statement before finishing the facility setup.

.. figure:: /img/super-admin-resp.png
:alt: Step 4 of 4.
Expand Down

0 comments on commit 0aab021

Please sign in to comment.