Merge pull request #5387 from benjaoming/releasenotes-0.17

More docs for 0.17

docs/developer_docs/environment.rst

@@ -51,7 +51,7 @@ Static vs. Dynamic version
 __________________________
 
 Apart from Python itself, KA Lite depends on a couple of python applications,
-mainly from the Django ecology. These dependencies can be installed in two ways:
+mainly from the Django ecosystem. These dependencies can be installed in two ways:
 
 * **Dynamic**: Means dependencies are automatically installed through
   *PIP* as a separate software package accessible to your whole system. This

docs/developer_docs/inline.rst

@@ -11,25 +11,28 @@ _______________
 
 You should be able to write inline help for a page following these simple steps:
 
-  #. Clone the repository and setup a development environment following the
-     steps in :ref:`development-environment`.
-  #. Open up the file ``kalite/inline/narratives.py``
-  #. Add a new entry of a page you wish to write inline help for, for instance if
-     the URL of the page is ``/learn``, then you can add this entry::
-          u'learn/?$': [
-              {u'#css-id': [
-                  {u'step': 1},
-                  {u'text':
-                      _(u'This is the explanation for the user')}
-              ]},
-          ],
-
-     .. note:: The URL entry is a regular expression. You might want to implement
-              variations of the URL in case it can be parameterized. Do not include
-  #. After changing the documentation, you can view the results by running the
-     development server from command line::
-        bin/kalite manage runserver --settings=kalite.project.settings.dev
-
-Once you written inline help, go and open up a Pull Requestion for the
-``develop`` branch on our Github page.
+ #. Clone the repository and setup a development environment following the
+    steps in :ref:`development-environment`.
+ #. Open up the file ``kalite/inline/narratives.py``
+ #. Add a new entry of a page you wish to write inline help for, for instance if
+    the URL of the page is ``/learn``, then you can add this entry::
+
+      u'learn/?$': [
+          {u'#css-id': [
+              {u'step': 1},
+              {u'text':
+                  _(u'This is the explanation for the user')}
+          ]},
+      ],
+
+    .. note::
+      The URL entry is a regular expression. You might want to implement
+      variations of the URL in case it can be parameterized. Do not include
+
+ #. After changing the documentation, you can view the results by running the
+    development server from command line::
+
+      bin/kalite manage runserver --settings=kalite.project.settings.dev
+
+Once you written inline help, go and open up a Pull Requestion for the ``develop`` branch on our Github page.
 

docs/faq.rst

@@ -242,3 +242,14 @@ 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.
+
+I am online but device registration freezes
+-------------------------------------------
+
+Recent efficient versions of ad blockers and anti-trackers have started to block
+scripts from third-party servers, including the server we use to register a
+device against.
+
+The solution is to add an exception to unblock ``hub.learningequality.org``
+(or ``staging.learningequality.org`` if you are a developer).
+

docs/installguide/install_main.rst

@@ -8,5 +8,5 @@ Hello! If you know what OS you're installing on then click ahead.
     Installation Guide <install_all>
     Release Notes <release_notes>
     Advanced Installation <advanced>
-    Raspberry Pi Tutorial <rpi_install>
+    Raspberry Pi Tutorial <tutorial_rpi>
     System Requirements <system_requirements>

docs/installguide/release_notes.rst

@@ -1,47 +1,55 @@
 Release Notes
 =============
 
-0.17 (unreleased)
------------------
+0.17.0 (unreleased)
+-------------------
+
+Please read our release notes before installing.
 
 This is a draft of what will be released. Notes are not fully accurate or final.
 
 Content
 ^^^^^^^
 
-Contents have been rebuilt from upstream Khan Academy. We have solved issues
+Contents have been updated from upstream Khan Academy. We have solved issues
 regarding merging contents from Youtube and KhanAcademy.org, meaning that
 inaccuracies in 0.16 content packs are solved.
 
- * Fixed/added in 0.17:
+ * Languages fixed/added in 0.17:
     * Kannada, Malay, Polish, Swahili, Zulu
- * Updated:
+ * Languages updated:
     * Bulgarian, English, Bengali, Danish, German, Spanish (Castilian), French,
       Hindi, Indonesian, Georgian, Portuguese (Brazil), Portuguese (Portugal),
       Tamil, Xhosa
- * Known issues:
+ * Languages with remaining issues:
     * Arabic, we are still receiving wrong data from upstream APIs that we cannot fix.
+ * General updates:
+    * Many exercises are rearranged and updated, as with javascript libraries. This will solve an unknown number of javascript errors, for instance :url-issue:`5316`
 
 .. note::
   After upgrading to version 0.17, you should visit the *Manage* tab to
   upgrade your language and videos. You can also use
-  ``kalite manage retrievecontentpack`` to automate the download and
+  ``kalite manage contentpackchecker all --update`` to automate the download and
   installation of new content packs.
 
   You should **always** upgrade the English content pack because it contains
-  exercise data needed by the other content packs.
+  exercise data needed by the other content packs. However, most installers
+  bundle the English content pack, so after updating the software, you may find
+  that you only need to upgrade other installed languages.
 
 
 New features
 ^^^^^^^^^^^^
 
  * New management command ``clearuserdata``, makes it easy to prepare a
    prototype device for subsequent cloning. :url-issue:`5341`
- * Patch from Rachel means you can now go to a specific page in a specific
-   language:
+ * Patch from Rachel means you can now deeplink a page in a specific
+   language, using this URL shortcut:
    ``/api/i18n/set_default_language/?lang=es&returnUrl=/learn/khan/math``
    :url-issue:`5342` -
    (Thanks: Jonathan Field)
+ * OSX 10.11 (El Capitan) + MacOS Sierra 10.12 are now supported.
+ * Updates for improved Raspbian Jessie support.
 
 
 Bug fixes
@@ -64,6 +72,7 @@ Bug fixes
  * Installation works with latest ``setuptools >= 30.0`` affecting almost any recent system using ``pip install``. :url-issue:`5352`
  * Installation works with latest ``pip 9``. :url-issue:`5319`
  * ``kalite manage contentpackchecker all --update`` wrongly retrieved all available content packs. Now only updates *installed* content packs.
+ * No content pack files are placed in ``STATIC_ROOT``, ensuring that ``kalite manage collectstatic`` will not remove any files from content packs (subtitles!). :url-issue:`5386` :url-issue:`5073`
  * **Windows**: Logging works again: Writing to ``server.log`` was disabled on Windows :url-issue:`5057`
  * **Dev** Loading subtitles now works in ``bin/kalite manage runserver --settings=kalite.project.settings.dev``
  * **Dev** Test runner is now compatible with Selenium 3 and Firefox 50

docs/installguide/rpi_install.rst → docs/installguide/tutorial_rpi.rst

@@ -121,16 +121,21 @@ Please make sure that all these files once copied, they have permissions to be v
 Step 5: Replication to other devices
 ------------------------------------
 
-We are working on a command that resets the device registration allowing you to
-copy the ``~/.kalite`` folder with all the downloaded videos onto a blank device.
-
-For now, the basic steps are:
+Here are the basic steps to manually replicate from one KA Lite device to
+another. We advice you to write your own scripts to automate this process if you
+are deploying to more than just a couple of devices.
 
  #. Prepare the seed device, your prototype using the above steps. Then:
 
       #. Download and install all desired videos and content packs.
-      #. Remove ``~/.kalite/secretkey.txt``
-      #. Remove ``~/.kalite/database/data.sqlite``
+      #. To remove the data that should NOT be replicated to other devices, run::
+
+             kalite manage clearuserdata
+
+         To run the same command as a different user::
+
+             sudo su -l USERNAME -c kalite manage clearuserdata
+
       #. Copy the ``~/.kalite`` folder to a removable device. It's likely NOT going to save you time to compress it to .zip or .gz.
 
  #. On the target device: