Merge tag '0.16.x' into central-develop

Final 0.16.3 - Fixes #5087 related to certain Linux kernel version labels - Few docs changes
learningequality · Jul 4, 2019 · 3555f82 · 3555f82
2 parents a118a2d + 521a145
commit 3555f82
Show file tree

Hide file tree

Showing 93 changed files with 512 additions and 785 deletions.
diff --git a/Vagrantfile b/Vagrantfile
diff --git a/bin/kalite b/bin/kalite
@@ -102,7 +102,7 @@ if os.name == "posix" and os.path.isfile("/etc/ka-lite/username"):
             ).format(username))
             sys.stderr.write((
                 "To run the command as the default user, run this instead:\n\n"
-                "    sudo su {user} -s /bin/sh -c {command}\n\n"
+                "    sudo su {user} -c {command}\n\n"
             ).format(user=username, command=" ".join(sys.argv)))
             cont = input("Do you wish to continue? [y/N] ")
             if not cont.lower() == "y":

diff --git a/data/version.yml b/data/version.yml
@@ -1,8 +1,48 @@
+0.16.3:
+  release_date: "2016/04/25"
+  git_commit: ""
+  new_features: []
+  bugs_fixed:
+    all:
+      - Fix for 'nix based systems with unconventional kernel versioning (#5087)
+    students: []
+    coaches: []
+    admins: []
+
+0.16.2:
+  release_date: "2016/04/12"
+  git_commit: ""
+  new_features: []
+  bugs_fixed:
+    all:
+      - Fix attempt log filtering (#5082)
+    students: []
+    coaches: []
+    admins: []
+
+0.16.1:
+  release_date: "2016/04/04"
+  git_commit: ""
+  new_features: []
+  bugs_fixed:
+    all:
+      - Tweaks to our documentation (#5067)
+      - Refactor assessment item asking logic in the setup command (#5065)
+      - Properly copy over docs pages while preserving content pack assets (#5074)
+    students: []
+    coaches: []
+    admins: []
+
 0.16.0:
-  release_date:
+  release_date: "2016/04/01"
   git_commit: ""
   new_features:
-    all: []
+    all:
+      - New content pack format.
+      - Faster startup time.
+      - New inline help feature (BETA).
+      - A few UI tweaks.
+      - A lot of bugfixes.
     students: []
     coaches: []
     admins: []

diff --git a/docs/.screenshot_dump/004ee879e2bb47d49377b861bf6659aa.png b/docs/.screenshot_dump/004ee879e2bb47d49377b861bf6659aa.png
diff --git a/docs/.screenshot_dump/0cb588c024762522dab6cc7624902020.png b/docs/.screenshot_dump/0cb588c024762522dab6cc7624902020.png
diff --git a/docs/.screenshot_dump/0ea6d393cbd0a961c91c4a73eb76443d.png b/docs/.screenshot_dump/0ea6d393cbd0a961c91c4a73eb76443d.png
diff --git a/docs/.screenshot_dump/10e2b5ae7e7e48b9b1771dd25d5b03cb.png b/docs/.screenshot_dump/10e2b5ae7e7e48b9b1771dd25d5b03cb.png
diff --git a/docs/.screenshot_dump/1c47c76890be4305230319aa52b48c83.png b/docs/.screenshot_dump/1c47c76890be4305230319aa52b48c83.png
diff --git a/docs/.screenshot_dump/1febcea47bf94953e0b4351a7be2d7e8.png b/docs/.screenshot_dump/1febcea47bf94953e0b4351a7be2d7e8.png
diff --git a/docs/.screenshot_dump/2389501a88a890257ae9510c56505e01.png b/docs/.screenshot_dump/2389501a88a890257ae9510c56505e01.png
diff --git a/docs/.screenshot_dump/260c9ea74c87287fcac5dbef612d34d8.png b/docs/.screenshot_dump/260c9ea74c87287fcac5dbef612d34d8.png
diff --git a/docs/.screenshot_dump/298b4ca13d9ed220b414b0450189d955.png b/docs/.screenshot_dump/298b4ca13d9ed220b414b0450189d955.png
diff --git a/docs/.screenshot_dump/2eeb2ed1e0731f6cc77bdc8189e58967.png b/docs/.screenshot_dump/2eeb2ed1e0731f6cc77bdc8189e58967.png
diff --git a/docs/.screenshot_dump/32b44b6848bd8d54b5072b747c3b1d0f.png b/docs/.screenshot_dump/32b44b6848bd8d54b5072b747c3b1d0f.png
diff --git a/docs/.screenshot_dump/394d80548a460956916ecbf5306ee28b.png b/docs/.screenshot_dump/394d80548a460956916ecbf5306ee28b.png
diff --git a/docs/.screenshot_dump/427342ec4e7aac3586de322eb39afbf2.png b/docs/.screenshot_dump/427342ec4e7aac3586de322eb39afbf2.png
diff --git a/docs/.screenshot_dump/45f197e49bdfbe3958a5da76510f96fd.png b/docs/.screenshot_dump/45f197e49bdfbe3958a5da76510f96fd.png
diff --git a/docs/.screenshot_dump/4ffe666b16aca697959079b1d49bfe81.png b/docs/.screenshot_dump/4ffe666b16aca697959079b1d49bfe81.png
diff --git a/docs/.screenshot_dump/54f2081dee95763b4f6100990917d29b.png b/docs/.screenshot_dump/54f2081dee95763b4f6100990917d29b.png
diff --git a/docs/.screenshot_dump/57327a1a82d4572b4ed4d742a29c81aa.png b/docs/.screenshot_dump/57327a1a82d4572b4ed4d742a29c81aa.png
diff --git a/docs/.screenshot_dump/5937cd9b87b5e7f062ce1ad780fdfdd3.png b/docs/.screenshot_dump/5937cd9b87b5e7f062ce1ad780fdfdd3.png
diff --git a/docs/.screenshot_dump/5cc9c0672c8c6ef3cbc8a33e071fdf70.png b/docs/.screenshot_dump/5cc9c0672c8c6ef3cbc8a33e071fdf70.png
diff --git a/docs/.screenshot_dump/611ad781d060b5fd330ba7e5a07907b2.png b/docs/.screenshot_dump/611ad781d060b5fd330ba7e5a07907b2.png
diff --git a/docs/.screenshot_dump/6a4db825f084e8a0b3bd7fbbfa0ce381.png b/docs/.screenshot_dump/6a4db825f084e8a0b3bd7fbbfa0ce381.png
diff --git a/docs/.screenshot_dump/6ba892db1327a8645f88684c6ad58b46.png b/docs/.screenshot_dump/6ba892db1327a8645f88684c6ad58b46.png
diff --git a/docs/.screenshot_dump/6bfeab25adee7e88d404ab59a81f27cb.png b/docs/.screenshot_dump/6bfeab25adee7e88d404ab59a81f27cb.png
diff --git a/docs/.screenshot_dump/6debd4ad4a281d125e290ddc3f720865.png b/docs/.screenshot_dump/6debd4ad4a281d125e290ddc3f720865.png
diff --git a/docs/.screenshot_dump/770a546fd59fbd2faa4d98abff3cdbab.png b/docs/.screenshot_dump/770a546fd59fbd2faa4d98abff3cdbab.png
diff --git a/docs/.screenshot_dump/87d784e4e34dcb41202e5497b66580c0.png b/docs/.screenshot_dump/87d784e4e34dcb41202e5497b66580c0.png
diff --git a/docs/.screenshot_dump/9a5e781ddcf92e4fc67e2bc60d990f30.png b/docs/.screenshot_dump/9a5e781ddcf92e4fc67e2bc60d990f30.png
diff --git a/docs/.screenshot_dump/9bf236d34593bdbf6c092e608dc91a9f.png b/docs/.screenshot_dump/9bf236d34593bdbf6c092e608dc91a9f.png
diff --git a/docs/.screenshot_dump/9c831d47ab856f6dea213885339f8793.png b/docs/.screenshot_dump/9c831d47ab856f6dea213885339f8793.png
diff --git a/docs/.screenshot_dump/a56c8dbd40323113f2fdf500e5952021.png b/docs/.screenshot_dump/a56c8dbd40323113f2fdf500e5952021.png
diff --git a/docs/.screenshot_dump/b1751d2f19bf6b100a0ae8d0cde7a0a6.png b/docs/.screenshot_dump/b1751d2f19bf6b100a0ae8d0cde7a0a6.png
diff --git a/docs/.screenshot_dump/b92d2586fa6b5390fed3aef07edfd80d.png b/docs/.screenshot_dump/b92d2586fa6b5390fed3aef07edfd80d.png
diff --git a/docs/.screenshot_dump/c1c3a7830a61d95b64d010153f7faebd.png b/docs/.screenshot_dump/c1c3a7830a61d95b64d010153f7faebd.png
diff --git a/docs/.screenshot_dump/c66fc3b0cdfa0eeef604afe36ad16659.png b/docs/.screenshot_dump/c66fc3b0cdfa0eeef604afe36ad16659.png
diff --git a/docs/.screenshot_dump/d316a315f5696daca0319be2cf63c9e0.png b/docs/.screenshot_dump/d316a315f5696daca0319be2cf63c9e0.png
diff --git a/docs/.screenshot_dump/db082167ce73355be305c4c038a3e143.png b/docs/.screenshot_dump/db082167ce73355be305c4c038a3e143.png
diff --git a/docs/.screenshot_dump/dfad7260a5c36b7422bf2a07665afe36.png b/docs/.screenshot_dump/dfad7260a5c36b7422bf2a07665afe36.png
diff --git a/docs/.screenshot_dump/e1ddb22ed2ade1829458fd467f5f66e7.png b/docs/.screenshot_dump/e1ddb22ed2ade1829458fd467f5f66e7.png
diff --git a/docs/.screenshot_dump/f19e30637f8749a6dd2a4b2311c9d914.png b/docs/.screenshot_dump/f19e30637f8749a6dd2a4b2311c9d914.png
diff --git a/docs/.screenshot_dump/f5bd601dd8e28c0239d3d110cf153283.png b/docs/.screenshot_dump/f5bd601dd8e28c0239d3d110cf153283.png
diff --git a/docs/.screenshot_dump/fdfbbe6e30092722388be3414b20a0ac.png b/docs/.screenshot_dump/fdfbbe6e30092722388be3414b20a0ac.png
diff --git a/docs/README.md b/docs/README.md
@@ -3,8 +3,6 @@ You need to install following dependencies in order to build the docs in headles
 - xvfb (system package)
 - pyvirtualdisplay (python package)
 
-You'll also need to install `sphinx`.
-
 Execute following commands as root user to install the dependencies.
 For Debian/Ubuntu users:
 ```
@@ -15,11 +13,7 @@ For RHEL/CentOS/Fedora users:
     yum install xorg-x11-server-Xvfb
 ```
 
-Then, install following python packages:
-```
-    pip install pyvirtualdisplay
-    pip install sphinx
-```
+Then, in the base directory, run `pip install -r requirements_sphinx.txt`.
 
 
 ## Building Documentation
@@ -29,6 +23,24 @@ Change your current working directory to `docs` directory under `ka-lite` root a
 ```
 If the above command executes successfully, docs should be found under `docs/_build` directory inside `ka-lite`.
 
+
+## Building Documentation with automatic screenshots
+We use Selenium web driver and a custom sphinx directive to take screenshots of the KA Lite application. It takes a 
+long time -- an instance of the server is spun up with an in-memory database and user data is generated.
+
+Custom directives in the rst files indicate on which page a screenshot should be taken, and what actions the web driver
+instance should do to prepare the screenshot. This is failure-prone if the instructions are based on *timing* (which
+could change from machine to machine or even on subsequent runs) much like flaky tests. It's also failure prone if
+the UI is changed "from underneath" the directive, for instance by referencing an element id that no longer exists on
+that page. Because this command is run infrequently, it's generally not noticed when this happens.
+
+Before building the docs with screenshots, you'll need to create js assets. Run `node build.js` followed by
+`kalite manage collectstatic`.
+
+To build the docs with screenshots, add the line `screenshots_create = True` to `conf.py`, then run `make html`.
+If the environment variable `SPHINX_SS_USE_PVD` has the value `true`, then screenshots will be made headlessly using
+xvfb.
+
 ## Building translated docs
 1. Make sure you have the sphinx-intl dependency (run the command `pip install -r requirements` in this directory).
 2. Extract the translatable messages into pot files using the command `make gettext`. The pot files are then found in `_build/locale directory`.

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -9,7 +9,7 @@ Information on how to install KA Lite is available via our :doc:`user guides </i
 How much does KA Lite cost to install?
 --------------------------------------
 
-It is **FREE** -- both free as in "free speech" and free as in "free beer"! To learn more about free software, see this `Free Software Foundation article <http://www.fsf.org/about/what-is-free-software>`_
+It is **FREE** -- both free as in "free speech" and free as in "free beer"! To learn more about free software, see this `Free Software Foundation article <http://www.fsf.org/about/what-is-free-software>`_.
 
 How do I report a problem?
 --------------------------
@@ -52,7 +52,15 @@ Yes! Please see the instructions for ":ref:`bulk-video-downloads`".
 How can I install a language pack without a reliable internet connection?
 -------------------------------------------------------------------------
 
-To install, a language pack on a computer without internet access, look up the language code for the language you wish to download:
+In version 0.16 we changed the proces for making KA Lite available in other languages. For more technical background about the new **contentpacks**, please refer to our `Wiki page <https://github.com/learningequality/ka-lite/wiki/Content-packs>`_.
+
+You can download from our server the new `contentpacks for all the languages <http://pantry.learningequality.org/downloads/ka-lite/0.16/content/contentpacks/>`_, and carry around the zip file to computers you want to install the contentpack to.
+
+Once you have downloaded the contentpack for install on a computer without a reliable internet access, use the following command::
+
+    kalite manage retrievecontentpack local <language code> <path to zip file>
+
+Use the language code indicated below:
 
     ================ ======
      Language name    Code
@@ -76,23 +84,9 @@ To install, a language pack on a computer without internet access, look up the l
      Zulu             zul
     ================ ======
 
-Once you've determined the right language code, you can download the right language pack using this url::
-
-  http://keep.learningequality.org/media/language_packs/0.15/<code>.zip
-
-where <code> is replaced by the right language code. You can now carry around that zip file to computers you want to install the language pack to.
-
-You can install the language pack with the following command (for Debian and OS X)::
-
-  kalite manage languagepackdownload --from-file=<path to zip file> -l<language code> --commandline
-
-Or for Windows::
+An example invocation for installing the French `contentpack` on Windows would be::
 
-  <path to KA Lite installation>\bin\windows\kalite.bat languagepackdownload --from-file=<path to zip file> -l<language code> --commandline
-
-An example invocation for Windows would be::
-
-  C:\Program Files\KA Lite\ka-lite\bin\windows\kalite.bat languagepackdownload --from-file="C:\Downloads\es.zip" -les --commandline
+    C:\Python27\Scripts\kalite manage retrievecontentpack local fr fr.zip
 
 
 After starting up your server, you should now see your new language in the Manage > Language page.
@@ -160,19 +154,19 @@ KA Lite is an independent, open-source project maintained by `Learning Equality`
 How can local curriculum be generated?
 --------------------------------------
 
-Local content creation is something that Learning Equality intends to build into future platforms. If you would like to be notified when it is available, subscribe for updates on our `home page`_, or if you would like to help fund this project, please `click here <https://learningequality.org/give/>`_.
+Local content creation is something that Learning Equality intends to build into future `platforms <https://learningequality.org/kolibri/>`_. If you would like to be notified when it is available, subscribe for `updates <https://github.com/learningequality/ka-lite/wiki/Communication%20and%20Coordination>`_, or if you would like to help fund this project, please `click here <https://learningequality.org/give/>`_.
 
 .. _home page: http://kalite.learningequality.org/
 
 How is it possible to compress the content into KA Lite?
 --------------------------------------------------------
 
-First, users are able to select which videos they wish to download through the user-interface, allowing the users to customize the amount of space used.
+Users are able to select which videos they wish to download through the user-interface, allowing to customize the amount of space used.
 
 What languages is KA Lite available in?
 ---------------------------------------
 
-KA Lite was `released with internationalization support`_ on 2014/03/07, including support for a translated interface, dubbed videos, subtitles, and translated exercises. Currently we have varying levels of support Portuguese, Danish, French, Polish, Spanish. Please `visit our blog`_ for the latest information about language support.
+KA Lite was `released with internationalization support`_ on 2014/03/07, including support for a translated interface, dubbed videos, subtitles, and translated exercises. Currently we have varying levels of support Portuguese, Danish, French, Polish, Spanish, and many others. Please `visit our blog`_ for the latest information about language support.
 
 .. _released with internationalization support: https://learningequality.org/blog/2014/i18n-released/
 
@@ -228,17 +222,14 @@ Note that online data back-ups occur if you "register" your KA Lite installation
 If you only want to backup the database, locate the ``.kalite/database/`` folder
 and copy and restore that one.
 
-I skipped the step for downloading the assessment items during install, how can I do it now?
---------------------------------------------------------------------------------------------
-
-Run the following command (beware it can take a while, the download size is over 500 MB):
-
-``kalite manage unpack_assessment_zip https://learningequality.org/downloads/ka-lite/0.15/content/assessment.zip -f``
-
-As an alternative, you can download the zip file from https://learningequality.org/downloads/ka-lite/0.15/content/assessment.zip and run the command on your local copy. This is useful if you're deploying KA Lite on multiple computers.
-
 I can't get KA Lite to work on Windows! The installation succeeded, but nothing happens!
 ----------------------------------------------------------------------------------------
 
 KA Lite on Windows is controlled through a task-tray program.
 See the :doc:`installation guide <installguide/install_all>` for some more info.
+
+
+I can't see videos in Firefox on Ubuntu/Debian!
+-----------------------------------------------
+
+Install `Ubuntu restricted extras package <https://apps.ubuntu.com/cat/applications/ubuntu-restricted-extras/>`_ in the Ubuntu Software Center.
diff --git a/docs/installguide/advanced.rst b/docs/installguide/advanced.rst
@@ -69,18 +69,19 @@ the rest of your environment, you can run::
 Portable tarballs / zip files with setup.py
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Adequate to the online source, you can fetch a zip/tarball directly from
-`PyPi <https://pypi.python.org/pypi/ka-lite-static>`.
-Do this for the sake of carrying KA Lite on an offline media for use on systems
-that are not capable of installing the .exe/.dmg/.deb formats.
+If you can't install KA Lite on systems with the standard Windows/Mac/Linux installers,
+you can fetch the KA Lite python package from `PyPi <https://pypi.python.org/pypi/ka-lite-static>`_.
 
-A .tar.gz or .zip is unpacked and from command line inside the unpacked
-directory, run::
+To unpack the package for installation, run::
+
+   $> tar -xf ka-lite-static-0.16.0.tar.gz
+
+Once it's unpacked, install it by entering the extracted directory and running::
 
     $> sudo python setup.py install.
 
-Beware that the PyPi sources do not contain assessment items, you need to
-`download khan_assessment.zip manually <http://learningequality.org/downloads/ka-lite/0.15/content/khan_assessment.zip>`_ (~350 MB).
+Beware that the PyPi sources do not contain assessment items, so you need to
+`download the contentpack en.zip manually <http://pantry.learningequality.org/downloads/ka-lite/0.16/content/contentpacks/en.zip>`_ (~650 MB).
 
 
 Specific system setups