Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.14.1 #4485

Merged
merged 22 commits into from
Oct 5, 2015
Merged

0.14.1 #4485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
df3de88
README tweaks
jamalex Aug 28, 2015
67c0876
Merge pull request #4313 from learningequality/readme-tweaks
aronasorman Aug 31, 2015
455cad6
Change mentions of bin/kalite to kalite.
Sep 1, 2015
4154163
Corrections and updates to documentation (admin page and FAQ).
jamalex Sep 2, 2015
19cfd52
Address comments in https://github.com/learningequality/ka-lite/pull/…
Sep 2, 2015
5919163
A couple additional docs tweaks for getting links to work.
jamalex Sep 2, 2015
cc51ed3
Merge pull request #4329 from aronasorman/4326
jamalex Sep 2, 2015
0edaef5
Merge branch '0.14.x' of github.com:learningequality/ka-lite into doc…
jamalex Sep 2, 2015
56199a6
A couple linking tweaks in the docs.
jamalex Sep 2, 2015
7b5c320
Merge pull request #4350 from jamalex/docs_faq_admin_tweaks
MCGallaspy Sep 2, 2015
2da4cac
fix #4382 -- we are MIT licensed
benjaoming Sep 7, 2015
5d6ddd7
Merge pull request #4384 from benjaoming/mit-license
jamalex Sep 7, 2015
7073fb4
Actually translate assessment item data.
rtibbles Sep 24, 2015
b2e0fee
Use empty list not string of empty list.
rtibbles Sep 24, 2015
a1dd608
Merge pull request #4482 from rtibbles/assessment_item_translate_0.14.x
aronasorman Sep 24, 2015
4e82a5b
Add warning to langauge pack download completion to restart server.
rtibbles Sep 24, 2015
45b1e7c
Merge pull request #4491 from rtibbles/download_fix
aronasorman Sep 24, 2015
5ce63a6
Update install_all.rst
arnoan Sep 24, 2015
1224480
Merge pull request #4493 from arnoan/patch-1
aronasorman Sep 25, 2015
c1b4045
Generate a secret key file, and load SECRET_KEY from said file.
aronasorman Sep 24, 2015
0818d65
Merge pull request #4494 from aronasorman/4213
aronasorman Sep 25, 2015
306de74
bump version to 0.14.1.
Sep 30, 2015
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,29 @@
[Khan Academy](http://www.khanacademy.org/)'s core mission is to "provide a free world-class education for anyone anywhere", and as [70% of the world's population is without access to the internet](http://en.wikipedia.org/wiki/Global_Internet_usage), primarily in the developing world, providing an alternative delivery mechanism for Khan Academy content is key to fulfilling this mission.
[Khan Academy](http://www.khanacademy.org/)'s core mission is to "provide a free world-class education for anyone anywhere", and as [60% of the world's population is without access to the internet](http://en.wikipedia.org/wiki/Global_Internet_usage), primarily in the developing world, providing an alternative delivery mechanism for Khan Academy content is key to fulfilling this mission.

[KA Lite](http://kalite.learningequality.org/) is a lightweight [Django](https://www.djangoproject.com/) web app for serving core Khan Academy content (videos and exercises) from a local server, with points and progress-tracking, without needing internet connectivity.
[KA Lite](https://learningequality.org/ka-lite/) is a lightweight [Django](https://www.djangoproject.com/) app for serving core Khan Academy content (videos and exercises) from a local server, with points and progress-tracking, without needing internet connectivity.

#### Primary use cases include:
* For servers/**computer labs located in remote schools**, which could be slowly syncing with a central server over a cell/satellite network or via USB keys.
* In **correctional facilities** and other environments where providing educational materials is of value, but users cannot be given general internet access.
* **Mobile school "vans"**, which transport a server and multiple laptops/tablets between a number of schools (or orphanages, community centers, etc) in remote communities on a rotating basis, and syncing up with a central database (to download new content and upload analytics) when in an area with internet connectivity.
KA Lite is maintained by [Learning Equality](https://learningequality.org/), a small nonprofit startup based in San Diego.

Donate: https://learningequality.org/donate/

#### We would love for you to get involved!
* **Learn how you can contribute code on our [KA Lite GitHub Wiki](https://github.com/learningequality/ka-lite/wiki)**
* **Report bugs by [creating issues](https://github.com/learningequality/ka-lite/wiki/Report-Bugs-by-Creating-Issues)**
* **Read more about the project's motivation** at ["Introducing KA Lite, an offline version of Khan Academy"](http://jamiealexandre.com/blog/2012/12/12/ka-lite-offline-khan-academy/).


Official website: http://kalite.learningequality.org/
Official website: https://learningequality.org/ka-lite/

---

#### Documentation

* Instructions for installation: [See: INSTALL.md](INSTALL.md)
* Further documentation: [See: our wiki](https://github.com/learningequality/ka-lite/wiki)
* [Instructions for installation](https://learningequality.org/r/docs-latest-install-guide)
* [Further documentation](https://learningequality.org/r/docs-latest)

---

#### License information:

The KA Lite sourcecode itself is open-source [MIT licensed](http://opensource.org/licenses/MIT), and the other included software and content is licensed as described in the [LICENSE](https://raw.github.com/learningequality/ka-lite/master/LICENSE) file. Please note that KA Lite is not officially affiliated with, nor maintained by, Khan Academy, but rather makes use of Khan Academy's open API and Creative Commons content, which may only be used for non-commercial purposes.

#### Badges

[![Build Status](https://travis-ci.org/learningequality/ka-lite.png?branch=master)](https://travis-ci.org/learningequality/ka-lite)
[![Coverage Status](https://coveralls.io/repos/learningequality/ka-lite/badge.svg)](https://coveralls.io/r/learningequality/ka-lite)
The KA Lite sourcecode itself is open-source [MIT licensed](http://opensource.org/licenses/MIT), and the other included software and content is licensed as described in the [LICENSE](https://raw.github.com/learningequality/ka-lite/master/LICENSE) file. Please note that KA Lite is not officially affiliated with, nor maintained by, Khan Academy, but rather makes use of Khan Academy's API and Creative Commons content, which may only be used for non-commercial purposes.

17 changes: 17 additions & 0 deletions data/version.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
0.14.1:
release_date: "2015/10/02"
git_commit: "0818d65"
new_features:
all: []
students:
coaches: []
admins: []
bugs_fixed:
all:
- Fix assessment items not getting translated (#4482)
- Notify users that they need to restart their server after downloading a language pack (#4491)
- Generate a new secret key when the server starts (#4494)
students: []
coaches: []
admins: []

0.14.0:
release_date: "2015/08/27"
git_commit: "c453dab"
Expand Down
4 changes: 2 additions & 2 deletions docs/developer_docs/utility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Django Management Commands

All Django management commands can be run by typing:

``bin/kalite manage <command_name>``
``kalite manage <command_name>``

in the root directory of the KA Lite project.

Expand All @@ -16,4 +16,4 @@ generaterealdata
This function is designed to produce example user data for testing various front end functionality, such as coach reports and content recommendation.
It does take some shortcuts, and will not produce accurate answer data for exercises. This is a Django management command and can be run with the following command:

``bin/kalite manage generaterealdata``
``kalite manage generaterealdata``
75 changes: 18 additions & 57 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Frequently Asked Questions
How do I install KA Lite?
-------------------------

Information on how to install KA Lite is available via our :doc:`user guides </usermanual/userman_main>`.
Information on how to install KA Lite is available via our :doc:`user guides </installguide/install_main>`.

How much does KA Lite cost to install?
--------------------------------------
Expand All @@ -21,15 +21,7 @@ Please follow the instructions on our `Github Wiki`_ for reporting bugs.
How do I change KA Lite's content folder?
-----------------------------------------

If you want to change your installation's content folder from the default (say, to point to a shared folder across installations), here are the steps you need to do:

#. If it doesn't already exist, create a file named local_settings.py in the ka-lite/kalite folder (the one containing settings.py)
#. Add the line ``CONTENT_ROOT="[full path to your videos directory]"``, making SURE to include an OS-specific slash at the end (see examples) and encapsulate it in quotes.
**For example, on Windows:** ``CONTENT_ROOT="C:\\videos_location\\"``

**For example, on Linux:** ``CONTENT_ROOT="/home/me/videos_location/"``
#. Restart your server. If you are unsure on how to do this, please see :ref:`restarting-your-server`.

If you want to change your installation's content folder from the default (say, to point to a shared folder across installations), see how to configure CONTENT_ROOT in the ":ref:`configuration-settings`" section.

Is there somewhere I can find Spanish language content organized by topic?
--------------------------------------------------------------------------
Expand All @@ -41,38 +33,17 @@ Yes! Thanks to the efforts of an awesome volunteer deploying KA Lite and other O
I would like to download the videos for KA Lite via BitTorrent, is this possible?
---------------------------------------------------------------------------------

We have made the full set of KA videos (in the format needed by KA Lite) available via `BitTorrent Sync (btsync)`_ (note that this is different from BitTorrent; btsync allows us to add new videos or fix problems without issuing a whole new torrent file and then having seeders split between the old and new torrent files) Here are the steps to set this up:

* Download and install BitTorrent Sync
* Run btsync. On some platforms, this will bring up a graphical interface. On Linux, you will need to load http://127.0.0.1:8888/ to get the interface.
* Click the "Enter a key or link" button, and enter ::

BT7AOITNAIP3X3CSLE2EPQJFXJXMXVGQI

* Then select the "content" folder inside your KA Lite installation as the "location" (unless you want the videos going somewhere else).
* Allow the videos to sync in there from your peers! It may take a while for now, as we don't yet have many seeders on it. On that note -- please help seed by keeping it running even after you've got all the videos , if you have the bandwidth to spare! This to will make it easier for others to download the content as well.
* Please note that these are resized videos. All in all, this will take around 23GB of space.



Once you have the videos, you need to tell KA Lite where to find them by following the instructions in the :doc:`user guide </usermanual/userman_main>` for your version.

.. _BitTorrent Sync (btsync): http://www.bittorrent.com/sync
Yes! Please see the instructions for ":ref:`bulk-video-downloads`".

Do I need the internet to run KA Lite?
--------------------------------------

No. The only time you need an internet connection is for the initial download of the content (either to the target device, or to a USB stick that can then be carried or mailed). After installation, you can serve the content from a local server or use it directly on the server device without an internet connection.

Is KA Lite involved in getting devices into the hands of students, families, and communities?
---------------------------------------------------------------------------------------------

Currently, KA Lite does not distribute any devices. We are working with partner organizations who do directly distribute devices to local students and communities, and KA Lite is open to any organization who would like to help in this regard. If your organization wants to help KA Lite distribute devices, you can contact us at [email protected].

How do you operate in the field?
--------------------------------

The FLE team primarily works in our San Diego offices, building software and shaping our roadmap based on our interactions with our partners around the world. We work with individual humanitarians and NGOs of all sizes to help them distribute KA Lite to offline communities around the world.
The Learning Equality team primarily works in our San Diego offices, building software and shaping our roadmap based on our interactions with our partners around the world. We work with individual humanitarians and NGOs of all sizes to help them distribute KA Lite to offline communities around the world.

What are the typical deployment scenarios?
------------------------------------------
Expand Down Expand Up @@ -108,36 +79,33 @@ KA Lite can run on almost any major operating system: Windows, Linux, and Mac/OS
What is data syncing?
---------------------

KA Lite is capable to share your student progress data with a central data repository when you are online. This enables the system to have an online backup of your data, allows you to view your student progress online, and to share your data across multiple KA Lite installations.

Does KA Lite support peer to peer synchronization?
--------------------------------------------------

Not yet. Peer to peer sync is a priority for KA Lite in the near future, but is not available yet.
KA Lite is capable to share your student progress data with a `central data repository <https://hub.learningequality.org/>`_ when you are online. This enables the system to have an online backup of your data, allows you to view your student progress online, and to share your data across multiple KA Lite installations.

Who maintains the KA Lite project?
----------------------------------

KA Lite is created, maintained, and operated by the `Foundation for Learning Equality, Inc`_, a California-based nonprofit organization.

.. _Foundation for Learning Equality, Inc: http://learningequality.org
.. _Foundation for Learning Equality, Inc: https://learningequality.org

What is KA Lite's affiliation with Khan Academy?
------------------------------------------------

KA Lite is an independent, open-source project maintained by a distributed team of volunteers, and is not officially affiliated with Khan Academy, although they are (unofficially) very supportive of the KA Lite project.
KA Lite is an independent, open-source project maintained by `Learning Equality`_, and is not officially affiliated with Khan Academy, although they are very supportive of the KA Lite project, and are one of our key partners.

.. _Learning Equality: https://learningequality.org

How can local curriculum be generated?
--------------------------------------

Local content creation is something that KA Lite intends to pursue in the future. This feature is not available at this time, but steps are being taken, as you can `read about here <https://learningequality.org/blog/2013/bringing-ka-lite-gitwe/>`_. If you would like to be notified when it is available, subscribe for updates on our `home page`_, or if you would like to fund this project, please `click here <https://learningequality.org/give/>`_.
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/>`_.

.. _home page: http://kalite.learningequality.org/

How is it possible to compress the content into KA Lite?
--------------------------------------------------------

First, users are able to select the amount of videos and exercises they wish to download on the user-interface, allowing the users to customize the size of the files. Also, we have resized much of the content, and approximately 4,000 videos are around 25 GB if downloaded via BitTorrent and around 70 GB via the user-interface.
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.

What languages is KA Lite available in?
---------------------------------------
Expand Down Expand Up @@ -174,21 +142,14 @@ How do I find out more?

To stay up-to-date on all our activities, follow our `blog <https://learningequality.org/blog>`_, `Twitter <https://twitter.com/LearnEQ>`_, and `Facebook <https://www.facebook.com/learningequality>`_!

What can be done with progress tracking during offline usage?
-------------------------------------------------------------

KA Lite's built-in coach reports are meant to provide teachers and administrators access to progress tracking offline. When a student connects back up to the server that they sync with, all of their progress data will be uploaded for teachers and administrators to evaluate.

How does FLE measure the impact of KA Lite?
How does Learning Equality measure the impact of KA Lite?
-------------------------------------------

Because KA Lite is freely available and designed to run offline, we are not in contact with many of our deployments, and collecting impact data can be challenging.

KA Lite is capable to synchronize data with our central data repository when an online connection exists.
Because KA Lite is freely available and designed to run offline, collecting impact data can be challenging.

For the deployments in which we do have direct involvement, we receive updates from the administrator’s with quantitative data from the built-in coach reports and attain qualitative data from our on-site visits. For example, we know that 20 out of 20 students in the Idaho Department of Corrections deployment have passed their GED using KA Lite.
KA Lite is capable of synchronizing data with our central data repository when an online connection exists.

We are also developing RCTs to start in June for a deployment in India.
For the deployments in which we do have direct involvement, we receive updates from our partners with quantitative data from the built-in coach reports and attain qualitative data from our on-site visits. For example, we know that 20 out of 20 students in the Idaho Department of Corrections deployment have passed their GED using KA Lite.

Backing up data: is there any easy way to do it locally?
--------------------------------------------------------
Expand All @@ -199,12 +160,12 @@ changed versions, please run::

kalite manage setup

If you only want to backup the database, locate the ``.kalite/database/`` folder
and copy and restore that one.

to guarantee your database is compatible with the current version of KA Lite you have installed!
Note that online data back-ups occur if you "register" your KA Lite installation with an online account on our website.

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?
--------------------------------------------------------------------------------------------

Expand Down
4 changes: 2 additions & 2 deletions docs/installguide/install_all.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,15 @@ It can be installed by downloading the latest .deb on the Pi and installing it::
# Install dependencies
sudo apt-get install python-m2crypto python-pkg-resources nginx python-psutil
# Fetch the latest .deb
sudo wget https://learningequality.org/r/deb-pi-installer-0-14
sudo wget https://learningequality.org/r/deb-pi-installer-0-14 --no-check-certificate
# Install the .deb
sudo dpkg -i ka-lite-raspberry-pi*.deb

You can also add the PPA, see :ref:`ppa-installation`, and then
run ``sudo apt-get install ka-lite-raspberry-pi``.

After installing, you can setup a Wifi hotspot using this guide:
:ref:`raspberry-pi-wifi`_
:ref:`raspberry-pi-wifi`


Other options
Expand Down
Loading