Skip to content

Commit

Permalink
Merge pull request #5427 from benjaoming/docs-impro
Browse files Browse the repository at this point in the history
Documentation updates
  • Loading branch information
benjaoming committed Mar 31, 2017
2 parents 5beebce + cfecfc4 commit b438691
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
17 changes: 9 additions & 8 deletions docs/installguide/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Installing through pip or with setup.py
For command line users with access to pip, you can install KA Lite from an
online source like this::

$> pip install ka-lite
pip install ka-lite


Static version
Expand All @@ -30,7 +30,7 @@ Static version
If you need to run KA Lite with static dependencies bundled and isolated from
the rest of your environment, you can run::

$> pip install ka-lite-static
pip install ka-lite-static


Portable tarballs / zip files with setup.py
Expand All @@ -43,11 +43,11 @@ To unpack the package for installation, run:

.. parsed-literal::
$> tar -xf ka-lite-static-|release|.tar.gz
tar -xf ka-lite-static-|release|.tar.gz
Once it's unpacked, install it by entering the extracted directory and running::

$> sudo python setup.py install
sudo python setup.py install

Beware that the PyPi sources do not contain assessment items, so you need to
:url-pantry:`download the contentpack en.zip manually <content/contentpacks/en.zip>` (>700 MB)..
Expand All @@ -61,7 +61,8 @@ _________________________________________________
We maintain a `PPA on Launchpad <https://launchpad.net/~learningequality/+archive/ubuntu/ka-lite>`_
and if you are connected to the internet, this will also give you automatic updates.

On Ubuntu, do this::
To add the PPA as a repository on an apt-based system, you need to ensure that a few libraries are present, and then add our repository and the public key that packages are signed with::


sudo apt-get install software-properties-common python-software-properties
sudo su -c 'echo "deb http://ppa.launchpad.net/learningequality/ka-lite/ubuntu xenial main" > /etc/apt/sources.list.d/ka-lite.list'
Expand Down Expand Up @@ -152,7 +153,7 @@ it may be located somewhere else.

Example of setting up kalite for the www-data user: ::

$> sudo su -s /bin/bash www-data
$> kalite manage setup
$> exit
sudo su -s /bin/bash www-data
kalite manage setup
exit

3 changes: 2 additions & 1 deletion docs/installguide/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Known issues
* **Windows** needs at least Python 2.7.11. The Windows installer for KA Lite will install the latest version of Python. If you installed KA Lite in another way, and your Python installation is more than a year old, you probably have to upgrade Python - you can fetch the latest 2.7.12 version `here <https://www.python.org/downloads/windows/>`__.
* **Windows** installer tray application option "Run on start" does not work, see `learningequality/installers#106 <https://github.com/learningequality/installers/issues/106>`__ (also contains `a work-around`<https://github.com/learningequality/installers/issues/106#issuecomment-237729680>__)
* **Windows 8** installation on 32bit is reported to take ~1 hour before eventually finishing.
* **Development**: Selenium tests on Firefox 48\+ needs the new `geckodriver <https://github.com/mozilla/geckodriver>`__ and the new Selenium 3 beta ``pip install selenium --pre --upgrade``.
* **Windows + IE9** One-Click device registration is broken. Work-around: Use a different browser or use manual device registration. :url-issue:`5409`
* **Firefox 47**: Subtitles are misaligned in the video player. This is fixed by upgrading Firefox.


Expand Down Expand Up @@ -156,6 +156,7 @@ Debian/Ubuntu installer
* `ka-lite-bundle` now comes bundled with the English content pack `learningequality/installers#422 <https://github.com/learningequality/installers/pull/425>`__
* No Python files (`*.py`) are placed in `/usr/share/kalite`.
* Systemd support introduced, fixes specific bug on unupdated Raspbian Jesse `learningequality/installers#422 <https://github.com/learningequality/installers/pull/422>`__
* Systemd support fixed and released in 0.17.0-0ubuntu2 build `learningequality/installers#440 <https://github.com/learningequality/installers/pull/422>`__


Mac installer
Expand Down
4 changes: 2 additions & 2 deletions docs/installguide/tutorial_rpi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Raspberry Pi 3 Tutorial
=======================

Raspberry Pi has many versions and the latest one is Pi 3, which this guide is
based on. It should work for older version of Raspberry Pi as well. In order to
have complete ka-lite installation one would need a 64GB MicroSD Card
based on. It also works for other editions of The Pi - RPi1, 2, Nano, Zero etc.
In order to have complete ka-lite installation one would need a 64GB MicroSD Card
(earlier version may need a SD Card) as the reduced size video are currently
34GB in size (see :ref:`system-requirements`).

Expand Down

0 comments on commit b438691

Please sign in to comment.