Merge pull request #170 from indirectlylit/docs-tweaks

minor tweaks to docs

docs/faq.rst

@@ -5,32 +5,39 @@ Frequently Asked Questions
 How much does Kolibri cost to install?
 --------------------------------------
 
-Kolibri is **free and open source** software! To learn more about free software, see this `Free Software Foundation article <https://www.fsf.org/about/what-is-free-software>`_.
+Kolibri is `free and open-source <https://www.fsf.org/about/what-is-free-software>`_ software!
 
 
 Do I need the internet to run Kolibri?
 --------------------------------------
 
-Short answer: **No!** You can bring or send a storage device (USB or HDD unit) with Kolibri installer and content channels downloaded somewhere with available internet connection, and install everything on an completely offline device.
+**No!** You can bring or send a storage device (USB or HDD unit) with Kolibri installer and content channels downloaded somewhere with available internet connection, and install everything on an completely offline device.
 
-In a nutshell, Kolibri can run independently of internet availability, but you need to procure the installer and content channels from somewhere for the initial installation and for subsequent upgrades. 
+In a nutshell, Kolibri can run independently of internet availability, but you need to procure the installer and content channels from somewhere for the initial installation and for subsequent upgrades.
 
 One possibility is to have Kolibri installed in one location with internet connection, where you can import content channels from `Kolibri Studio <https://studio.learningequality.org/>`_ (curriculum tool and content curation server), and then export them to removable USB drives that you bring or send to offline locations (rural schools, refugee camps, etc.) to import locally.
 
 .. _languages:
 
+
+How do I get help if something isn't working?
+---------------------------------------------
+
+Please refer to the :ref:`Troubleshoot and Support <support>` section of this guide.
+
+
 What languages is Kolibri available in?
 ---------------------------------------
 
 Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are translation-ready and currently available in these languages:
 
-+---------------------------+-----------------+-----------------+ 
-| Language                  | Kolibri         | Kolibri Studio  | 
-+===========================+=================+=================+ 
++---------------------------+-----------------+-----------------+
+| Language                  | Kolibri         | Kolibri Studio  |
++===========================+=================+=================+
 | English                   | ✓               | ✓               |
 +---------------------------+-----------------+-----------------+
 | Arabic                    | ✓               |                 |
-+---------------------------+-----------------+-----------------+ 
++---------------------------+-----------------+-----------------+
 | Bengali                   | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Bulgarian                 | ✓               |                 |
@@ -58,7 +65,7 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 | Portuguese (Brazil)       | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Spanish (Latin America)   | ✓               | ✓               |
-+---------------------------+-----------------+-----------------+ 
++---------------------------+-----------------+-----------------+
 | Spanish (Spain)           | ✓               |                 |
 +---------------------------+-----------------+-----------------+
 | Swahili (Tanzania)        | ✓               |                 |
@@ -74,89 +81,65 @@ Both Kolibri and `Kolibri Studio <https://studio.learningequality.org/>`_ are tr
 
 To contribute to Kolibri and Kolibri Studio as a translator, you can get started over on our `translations and internationalization page <https://learningequality.org/translate/>`_.
 
-What are the typical deployment scenarios?
-------------------------------------------
+What are some typical implementation scenarios?
+-----------------------------------------------
 
 There is no typical implementation setting. However, we can share with you what we’ve learned from our community of KA Lite and Kolibri users. Some example implementation settings are provided below based on the presence of a coach and whether the settings allows for formal, non-formal, and informal learning.
 
-+---------------------------+-----------------------------------+--------------------------------------------------------------------------------+ 
-|                           | Coach                             | No Coach                                                                       | 
-+===========================+===================================+================================================================================+ 
++---------------------------+-----------------------------------+--------------------------------------------------------------------------------+
+|                           | Coach                             | No Coach                                                                       |
++===========================+===================================+================================================================================+
 | Formal and Non-Formal     | * School classroom                | * After school program                                                         |
 |                           | * Home schooling                  | * Supplementary education setting (computer labs model)                        |
 |                           | * Supplementary education setting | * Use in classroom that has teacher, but without coach engagement or monitoring|
 |                           |                                   |                                                                                |
-+---------------------------+-----------------------------------+--------------------------------------------------------------------------------+ 
++---------------------------+-----------------------------------+--------------------------------------------------------------------------------+
 | Informal                  | * Tutoring session                | * Mobile school vans                                                           |
 |                           |                                   | * Use for homework only                                                        |
 +---------------------------+-----------------------------------+--------------------------------------------------------------------------------+
 
 
-What are some possible hardware configurations for deploying Kolibri?
----------------------------------------------------------------------
+What are some possible hardware configurations?
+-----------------------------------------------
 
-To deploy Kolibri for multiple users you will need:
+To implement Kolibri for multiple users you will need:
 
 #. **Server device**: a computer that is running the Kolibri software (e.g. a desktop computer, laptop, or Raspberry Pi).
 #. One or more **client devices** that have web browsers (laptops, tablets, desktop computers, etc)
 
 .. note::
-  For a single-device deployment (1) and (2) can be the same computer, with the browser connecting to the locally running Kolibri server. To make the software accessible to multiple client devices, you will need to put them on the same local network as the Kolibri server device (1), e.g. through a WIFI access point.
+  For a single-device implementation (1) and (2) can be the same computer, with the browser connecting to the locally running Kolibri server. To make the software accessible to multiple client devices, you will need to put them on the same local network as the Kolibri server device (1), e.g. through a WIFI access point.
 
 To read more details, see the full `Kolibri Hardware Guide <https://learningequality.org/r/hardware-guide>`_ and examples of `Hardware Configurations for Kolibri <https://learningequality.org/r/hardware>`_ (PDF documents).
 
 
-How can I generate content aligned to local curriculum?
--------------------------------------------------------
-
-Use `Kolibri Studio <https://studio.learningequality.org/>`_ curriculum tool to curate content channels aligned to your local requirements. Once you finish creating the channels on Studio, you can import them on all your Kolibri deployments for use in learning environments.
-
-
-Bulk Downloads of Content Channels
-----------------------------------
+How can I aligned resources to local curricula?
+-----------------------------------------------
 
-``Coming soon!``
+Use `Kolibri Studio <https://studio.learningequality.org/>`_ curriculum tool to curate content channels aligned to your local requirements. Once you finish creating the channels on Studio, you can import them on all your Kolibri implementations for use in learning environments.
 
-At this time we do not support bulk downloads of content channel outside the Kolibri platform.  In the near future, we will consider offering bit torrents for certain global content channels.
 
+Who maintains Kolibri?
+----------------------
 
-Something isn’t working!
-------------------------
+Kolibri is created, maintained, and operated by `Learning Equality <https://learningequality.org/>`_.
 
-Refer to the :ref:`Troubleshoot and Support <support>` section of this guide.
-
-
-Who maintains the Kolibri project?
-----------------------------------
-
-Kolibri is created, maintained, and operated by `Learning Equality <https://learningequality.org/about/>`_.
+To stay up-to-date on all our activities, follow our `blog <https://blog.learningequality.org/>`_, `Twitter <https://twitter.com/LearnEQ/>`_, and `Facebook <https://www.facebook.com/learningequality>`_!
 
 
-How do you operate in the field?
---------------------------------
+How are Kolibri implementations operated?
+-----------------------------------------
 
 The Learning Equality team primarily works in our San Diego offices, building software and shaping our road map based on our interactions with our partners around the world. We work with individual humanitarians and NGOs of all sizes to help them distribute Kolibri to offline communities around the world, and will work on site for research and training purposes.
 
 
 What is Kolibri’s affiliation with Khan Academy?
 ------------------------------------------------
 
-Kolibri is an independent, open-source project maintained by `Learning Equality <https://learningequality.org/about/>`_, and is not officially affiliated with Khan Academy, although they are very supportive of the Kolibri project.
-
-
-Can I contribute to Kolibri as a developer?
--------------------------------------------
+Kolibri is an independent, open-source project maintained by `Learning Equality <https://learningequality.org/>`_, and is not officially affiliated with Khan Academy, although they are very supportive of the Kolibri project.
 
-Yes! Kolibri is an `open source project <https://github.com/learningequality/>`_, and developers are encouraged to contribute!
 
+Can I contribute to Kolibri?
+----------------------------
 
-Can I contribute to Kolibri as a translator?
---------------------------------------------
-
-Yes, absolutely! To contribute to Kolibri and Kolibri Studio as a translator, you can get started over on our `translations and internationalization page <https://learningequality.org/translate/>`_.
-
-
-How do I find out more about Learning Equality and Kolibri?
------------------------------------------------------------
-
-To stay up-to-date on all our activities, follow our `blog <https://blog.learningequality.org/>`_, `Twitter <https://twitter.com/LearnEQ/>`_, and `Facebook <https://www.facebook.com/learningequality>`_!
+Yes, `contributions are welcome <https://kolibri-dev.readthedocs.io/en/develop/contributing/ways_to_contribute.html>`_! We can use help with feedback, bug reports, software development, and translations.

docs/install/provision.rst

@@ -6,14 +6,14 @@ Provisioning many servers
 
 This tutorial will help you to prepare for the Kolibri implementation where you need to install and provision several Kolibri server devices with the same content channels.
 
-Provisioning multiple servers with software and content is **going to take some time** irregardless of the chosen procedure. 
+Provisioning multiple servers with software and content is **going to take some time** regardless of the chosen procedure.
 
 You will need an **active Internet connection only to preload content channels on the first server device**. Provisioning the rest of the servers can be accomplished offline, or just within the working local network.
 
 Required hardware
 -----------------
 
-#. Laptops and/or other devices to host Kolibri servers. 
+#. Laptops and/or other devices to host Kolibri servers.
 
 	.. commenting out for now until the tutorial is updated.
 		.. tip:: If you are planning to use Raspberry Pi as your server device, read our comprehensive tutorial about setting up :ref:`tutorial_rpi`.
@@ -50,29 +50,29 @@ At this point you have the master server set-up and preloaded with content. Befo
 	``<username>`` refers to the user you were logged in as when you installed Kolibri as explained above. In the image below for example, you can see that the user who installed Kolibri is called **IEUser**.
 
 	.. figure:: /img/IEUser.gif
-	    :alt:  
+	    :alt:
 
 	    Find the `.kolibri` folder on Windows.
 
 * On Linux the ``.kolibri`` folder is located inside your user home folder.
-  
+
 	.. figure:: /img/linux.kolibri.png
-	    :alt:  
+	    :alt:
 
 	    Find the `.kolibri` folder on Linux.
 
 The content of the ``.kolibri`` folder is the same for all platforms. Inside you can see the main database file ``db.sqlite3``, and the subfolder named ``content`` which contains 2 subfolders: ``databases`` with the separate database for each of the content channels imported into Kolibri, and the ``storage`` folder with all the content files and resources.
 
 .. figure:: /img/db-and-content.gif
-    :alt:  
+    :alt:
 
     Find the channel's databases and content folder.
 
 
 Prepare the ``.kolibri`` folder for copying
 *******************************************
 
-Before you proceed to copy the ``.kolibri`` folder from the master server hard drive (which already contains content channels), to the rest of the server devices for your deployment, you need to **deprovision** (that is, empty out) the user database.
+Before you proceed to copy the ``.kolibri`` folder from the master server hard drive (which already contains content channels), to the rest of the server devices for your implementation, you need to **deprovision** (that is, empty out) the user database.
 
 .. warning:: This is a critical step, to ensure that each destination server has a unique **Facility ID** (and name) associated with it.
 
@@ -90,19 +90,19 @@ Before you proceed to copy the ``.kolibri`` folder from the master server hard d
 
   		kolibri manage deprovision
 
-	
+
 	You will have to confirm twice by typing ``yes`` and pressing the :guilabel:`Enter` key.
 
 
 Copy the content to other server devices
 ----------------------------------------
 
-.. warning:: 
+.. warning::
 	#. Independent from the copying procedure you decide to use, you should first proceed to :ref:`install Kolibri <install>` on each of the destination devices, following the same steps as for the master server, **but you don’t need to go through the Initial Setup**.
 
 	#. After the installation you must **stop Kolibri** on the destination device, before you proceed to copy the content.
 
-		* On Windows you need to right-click the Kolibri icon in the Windows taskbar (usually at bottom right, near the clock), and select ``Exit``. You will be prompted to confirm the selection, after which Kolibri will stop. 
+		* On Windows you need to right-click the Kolibri icon in the Windows taskbar (usually at bottom right, near the clock), and select ``Exit``. You will be prompted to confirm the selection, after which Kolibri will stop.
 
 		.. figure:: /img/taskbar-options.png
 			:alt: When you right click the Kolibri taskbar icon, you can see the taskbar options.
@@ -117,7 +117,7 @@ Use the external USB drive to copy content
 ******************************************
 
 #. Copy the ``.kolibri`` folder from the master server hard drive, and paste it on the external USB drive.
-#. Copy the ``.kolibri`` folder from the USB drive, and paste it inside the destination device hard drive. 
+#. Copy the ``.kolibri`` folder from the USB drive, and paste it inside the destination device hard drive.
 
 	.. note:: On Windows you need to copy the ``.kolibri`` folder into the ``C:/Users/<username>/`` folder, where the ``<username>`` is the account you were logged in as when you installed Kolibri on that destination device (it may be different from the account on the master server). On Linux you need to copy inside the home folder of the user who installed Kolibri, or is the owner of the Kolibri system service.
 
@@ -128,19 +128,19 @@ Use the cabled LAN connection to copy content
 *********************************************
 
 #. Connect all the devices, master server and the others where you need to copy the content on, to the same local area network (LAN).
-	
+
 	Configure the network access on the master server, so the rest of the devices can:
 
 	* See it among their Network locations in the Windows Explorer
 	* Open it and freely browse its shared folders (``.kolibri`` folder should be shared)
-  
-#. Use the Windows or File Explorer on each destination device to copy the ``.kolibri`` folder from the master server hard drive, and paste it inside the destination device hard drive. 
+
+#. Use the Windows or File Explorer on each destination device to copy the ``.kolibri`` folder from the master server hard drive, and paste it inside the destination device hard drive.
 
 	.. note:: On Windows you need to copy the ``.kolibri`` folder into the ``C:/Users/<username>/`` folder, where the ``<username>`` is the account you were logged in as when you installed Kolibri on that destination device (it may be different from the account on the master server). On Linux you need to copy inside the home folder of the user who installed Kolibri, or is the owner of the Kolibri system service.
 
 	.. warning:: You should see an alert message that there is already a  ``.kolibri`` folder on the destination device: choose the option to overwrite it.
 
-#. You should be able to access the master server from several other destination servers through the LAN, and copy the ``.kolibri`` folder at the same time. 
+#. You should be able to access the master server from several other destination servers through the LAN, and copy the ``.kolibri`` folder at the same time.
 
 
 Restart Kolibri servers on destination devices
@@ -149,4 +149,4 @@ Restart Kolibri servers on destination devices
 * On Windows double-click the desktop shortcut to start Kolibri after copying content. You will see the notification message *Kolibri is starting, please wait…*. When you see the next notification that *Kolibri is running…*, Kolibri will open in the browser with the URL ``http://127.0.0.1:8080``.
 * On Linux open the Terminal and run ``kolibri start`` or ``sudo service kolibri start`` (if you installed Kolibri to run as the system service).
 
-Since the deprovision command emptied the user database on the master server, you will need to perform  the :ref:`setup_initial` on each destination device to set their **Facility** name and the super admin account. The Facility name could be the name of the learning center or school in which the respective server will be deployed.
+Since the deprovision command emptied the user database on the master server, you will need to perform  the :ref:`setup_initial` on each destination device to set their **Facility** name and the super admin account. The Facility name could be the name of the learning center or school in which the respective server will be implemented.