Skip to content

Commit 39413a3

Browse files
committed
Merge pull request #4485 from learningequality/0.14.x
0.14.1
2 parents 9ab838e + 306de74 commit 39413a3

File tree

13 files changed

+111
-113
lines changed

13 files changed

+111
-113
lines changed

README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,29 @@
1-
[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.
1+
[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.
22

3-
[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.
3+
[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.
44

5-
#### Primary use cases include:
6-
* 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.
7-
* In **correctional facilities** and other environments where providing educational materials is of value, but users cannot be given general internet access.
8-
* **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.
5+
KA Lite is maintained by [Learning Equality](https://learningequality.org/), a small nonprofit startup based in San Diego.
6+
7+
Donate: https://learningequality.org/donate/
98

109
#### We would love for you to get involved!
1110
* **Learn how you can contribute code on our [KA Lite GitHub Wiki](https://github.com/learningequality/ka-lite/wiki)**
1211
* **Report bugs by [creating issues](https://github.com/learningequality/ka-lite/wiki/Report-Bugs-by-Creating-Issues)**
1312
* **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/).
1413

1514

16-
Official website: http://kalite.learningequality.org/
15+
Official website: https://learningequality.org/ka-lite/
1716

1817
---
1918

2019
#### Documentation
2120

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

2524
---
2625

2726
#### License information:
2827

29-
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.
30-
31-
#### Badges
32-
33-
[![Build Status](https://travis-ci.org/learningequality/ka-lite.png?branch=master)](https://travis-ci.org/learningequality/ka-lite)
34-
[![Coverage Status](https://coveralls.io/repos/learningequality/ka-lite/badge.svg)](https://coveralls.io/r/learningequality/ka-lite)
28+
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.
3529

data/version.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
0.14.1:
2+
release_date: "2015/10/02"
3+
git_commit: "0818d65"
4+
new_features:
5+
all: []
6+
students:
7+
coaches: []
8+
admins: []
9+
bugs_fixed:
10+
all:
11+
- Fix assessment items not getting translated (#4482)
12+
- Notify users that they need to restart their server after downloading a language pack (#4491)
13+
- Generate a new secret key when the server starts (#4494)
14+
students: []
15+
coaches: []
16+
admins: []
17+
118
0.14.0:
219
release_date: "2015/08/27"
320
git_commit: "c453dab"

docs/developer_docs/utility.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Django Management Commands
66

77
All Django management commands can be run by typing:
88

9-
``bin/kalite manage <command_name>``
9+
``kalite manage <command_name>``
1010

1111
in the root directory of the KA Lite project.
1212

@@ -16,4 +16,4 @@ generaterealdata
1616
This function is designed to produce example user data for testing various front end functionality, such as coach reports and content recommendation.
1717
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:
1818

19-
``bin/kalite manage generaterealdata``
19+
``kalite manage generaterealdata``

docs/faq.rst

Lines changed: 18 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Frequently Asked Questions
44
How do I install KA Lite?
55
-------------------------
66

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

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

24-
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:
25-
26-
#. If it doesn't already exist, create a file named local_settings.py in the ka-lite/kalite folder (the one containing settings.py)
27-
#. 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.
28-
**For example, on Windows:** ``CONTENT_ROOT="C:\\videos_location\\"``
29-
30-
**For example, on Linux:** ``CONTENT_ROOT="/home/me/videos_location/"``
31-
#. Restart your server. If you are unsure on how to do this, please see :ref:`restarting-your-server`.
32-
24+
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.
3325

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

44-
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:
45-
46-
* Download and install BitTorrent Sync
47-
* 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.
48-
* Click the "Enter a key or link" button, and enter ::
49-
50-
BT7AOITNAIP3X3CSLE2EPQJFXJXMXVGQI
51-
52-
* Then select the "content" folder inside your KA Lite installation as the "location" (unless you want the videos going somewhere else).
53-
* 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.
54-
* Please note that these are resized videos. All in all, this will take around 23GB of space.
55-
56-
57-
58-
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.
59-
60-
.. _BitTorrent Sync (btsync): http://www.bittorrent.com/sync
36+
Yes! Please see the instructions for ":ref:`bulk-video-downloads`".
6137

6238
Do I need the internet to run KA Lite?
6339
--------------------------------------
6440

6541
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.
6642

67-
Is KA Lite involved in getting devices into the hands of students, families, and communities?
68-
---------------------------------------------------------------------------------------------
69-
70-
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 info@learningequality.org.
71-
7243
How do you operate in the field?
7344
--------------------------------
7445

75-
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.
46+
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.
7647

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

111-
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.
112-
113-
Does KA Lite support peer to peer synchronization?
114-
--------------------------------------------------
115-
116-
Not yet. Peer to peer sync is a priority for KA Lite in the near future, but is not available yet.
82+
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.
11783

11884
Who maintains the KA Lite project?
11985
----------------------------------
12086

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

123-
.. _Foundation for Learning Equality, Inc: http://learningequality.org
89+
.. _Foundation for Learning Equality, Inc: https://learningequality.org
12490

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

128-
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.
94+
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.
95+
96+
.. _Learning Equality: https://learningequality.org
12997

13098
How can local curriculum be generated?
13199
--------------------------------------
132100

133-
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/>`_.
101+
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/>`_.
134102

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

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

140-
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.
108+
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.
141109

142110
What languages is KA Lite available in?
143111
---------------------------------------
@@ -174,21 +142,14 @@ How do I find out more?
174142

175143
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>`_!
176144

177-
What can be done with progress tracking during offline usage?
178-
-------------------------------------------------------------
179-
180-
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.
181-
182-
How does FLE measure the impact of KA Lite?
145+
How does Learning Equality measure the impact of KA Lite?
183146
-------------------------------------------
184147

185-
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.
186-
187-
KA Lite is capable to synchronize data with our central data repository when an online connection exists.
148+
Because KA Lite is freely available and designed to run offline, collecting impact data can be challenging.
188149

189-
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.
150+
KA Lite is capable of synchronizing data with our central data repository when an online connection exists.
190151

191-
We are also developing RCTs to start in June for a deployment in India.
152+
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.
192153

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

200161
kalite manage setup
201162

202-
If you only want to backup the database, locate the ``.kalite/database/`` folder
203-
and copy and restore that one.
204-
205163
to guarantee your database is compatible with the current version of KA Lite you have installed!
206164
Note that online data back-ups occur if you "register" your KA Lite installation with an online account on our website.
207165

166+
If you only want to backup the database, locate the ``.kalite/database/`` folder
167+
and copy and restore that one.
168+
208169
I skipped the step for downloading the assessment items during install, how can I do it now?
209170
--------------------------------------------------------------------------------------------
210171

docs/installguide/install_all.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,15 @@ It can be installed by downloading the latest .deb on the Pi and installing it::
7272
# Install dependencies
7373
sudo apt-get install python-m2crypto python-pkg-resources nginx python-psutil
7474
# Fetch the latest .deb
75-
sudo wget https://learningequality.org/r/deb-pi-installer-0-14
75+
sudo wget https://learningequality.org/r/deb-pi-installer-0-14 --no-check-certificate
7676
# Install the .deb
7777
sudo dpkg -i ka-lite-raspberry-pi*.deb
7878

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

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

8585

8686
Other options

0 commit comments

Comments
 (0)