Skip to content

Commit

Permalink
Merge pull request #5630 from radinamatic/update-docs
Browse files Browse the repository at this point in the history
Scrubbed mentions of torrent and added warning to use Kolibri
  • Loading branch information
radinamatic authored Apr 16, 2021
2 parents e85c24b + 02447ac commit 7894f84
Show file tree
Hide file tree
Showing 10 changed files with 64 additions and 51 deletions.
Binary file added docs/Kolibri-launch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/developer_docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
Developer Docs
==============

.. warning::

**KA Lite is no longer under active development**

Our focus is now on our new learning platform, `Kolibri <https://learningequality.org/kolibri/>`__. If you’re just getting started, we highly recommend using Kolibri instead of KA Lite because it supports more content and will receive regular updates, and more ongoing support.

.. figure:: ../Kolibri-launch.png
:align: center

New users can experience Khan Academy and much more with Kolibri!


Useful stuff our devs think that the rest of our devs ought to know about.

.. toctree::
Expand Down
18 changes: 12 additions & 6 deletions docs/faq.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
Frequently Asked Questions
==========================

.. warning::

**KA Lite is no longer under active development**

Our focus is now on our new learning platform, `Kolibri <https://learningequality.org/kolibri/>`__. If you’re just getting started, we highly recommend using Kolibri instead of KA Lite because it supports more content and will receive regular updates, and more ongoing support.

.. figure:: Kolibri-launch.png
:align: center

New users can experience Khan Academy and much more with Kolibri!


Something isn't working - does KA Lite have log files?
------------------------------------------------------

Expand Down Expand Up @@ -55,12 +67,6 @@ There are many ways to set an environment variable either temporarily or permane
The change requires that you first stop the server, change the ``KALITE_HOME`` environment variable, and then copy the contents from the default ``.kalite`` directory to the new directory you just specified. When you start the server again, all your files should be seamlessly detected at that location.


I would like to download the videos for KA Lite via BitTorrent, is this possible?
---------------------------------------------------------------------------------

Yes! Please see the instructions for ":ref:`bulk-video-downloads`".


.. _content_pack_retrieve_offline:

How can I install a language pack without a reliable internet connection?
Expand Down
12 changes: 12 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ KA Lite Documentation
by `Learning Equality <https://learningequality.org/>`__


.. warning::

**KA Lite is no longer under active development**

Our focus is now on our new learning platform, `Kolibri <https://learningequality.org/kolibri/>`__. If you’re just getting started, we highly recommend using Kolibri instead of KA Lite because it supports more content and will receive regular updates, and more ongoing support.

.. figure:: Kolibri-launch.png
:align: center

New users can experience Khan Academy and much more with Kolibri!


Welcome to the KA Lite Documentation page! Here, you will find all the
information needed to set up the KA Lite software. Additionally, there's
information on how to manage KA Lite and how to perform role-specific
Expand Down
11 changes: 11 additions & 0 deletions docs/installguide/install_main.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
KA Lite Installation Guides
===========================

.. warning::

**KA Lite is no longer under active development**

Our focus is now on our new learning platform, `Kolibri <https://learningequality.org/kolibri/>`__. If you’re just getting started, we highly recommend using Kolibri instead of KA Lite because it supports more content and will receive regular updates, and more ongoing support.

.. figure:: ../Kolibri-launch.png
:align: center

New users can experience Khan Academy and much more with Kolibri!

Installers for a number of platforms are available, each with separate
installation steps. Click ahead for installation instructions, and if you're
updating be sure to check out our release notes.
Expand Down
5 changes: 0 additions & 5 deletions docs/installguide/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,11 +112,6 @@ Bug fixes
previously downloaded content packs, provided that you use an installer that does not
bundle the English content pack (Debian/Ubuntu packages or `pip`).

If you are downloading videos from torrent (see: :ref:`bulk-video-downloads`), you
should re-use the target directory of your previously downloaded videos, then only
396 videos need to be downloaded.


Bug fixes
^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion docs/installguide/system_requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Videos are not playing?
^^^^^^^^^^^^^^^^^^^^^^^

Presuming that you have videos on your ``.kalite/content`` folder from a
previous version of KA Lite or from a torrent, make sure you have checked the
previous version of KA Lite, make sure you have checked the
following common problems:

* Have you pressed "Scan videos" on the ``Manage->Videos`` page?
Expand Down
38 changes: 1 addition & 37 deletions docs/usermanual/userman_admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ In order for other users to be able to connect with the KA Lite from different c
Downloading Videos
------------------

Now that you've created a facility and user accounts, it's time to add video content to your local KA Lite installation! Since the videos can take up a large amount of space, you can choose to download only the videos that you need. If your device has enough space and you wish to download all of the videos, we recommend using the `Downloading Videos in Bulk`_ option.
Now that you've created a facility and user accounts, it's time to add video content to your local KA Lite installation! Since the videos can take up a large amount of space, you can choose to download only the videos that you need.


Downloading Individual Videos
Expand All @@ -458,42 +458,6 @@ After registering your device:
5. Click the the first "Download n new selected video(s)" button (colored green) in the top left box of the page. The button should also show you the total number of videos you have selected to download, as well as the total size of the content.
6. Once the download is completed, video content will be ready for Learners to watch!

.. _bulk-video-downloads:

Downloading Videos in Bulk
__________________________

The full set of videos, if downloaded through the KA Lite interface, will occupy more than 150GB.
If you want to download all the videos, we also have torrent files with resized videos (~33 GB for English). To fetch all
the videos, :url-pantry:`download and open the appropriate torrent file <content/>`.

Save the videos in the ``CONTENT_ROOT`` directory of your installation. By default, that
is the ``.kalite/content/`` folder in the *home directory* of the user running KA Lite.

On Windows, navigate to something like ``C:\Documents and Settings\<username>\.kalite\content``.

.. note:: If the drive where your ``.kalite/`` folder is located does not have enough free disk space,
you can change the path of the ``CONTENT_ROOT`` in your `Configuration Settings`_, and
define a different folder where your want to store videos. Remember to move the files
from your old ``/content/`` folder into the new one.

.. note:: The ``.kalite`` folder may be hidden on some systems, so you have to enable showing hidden
files and folders in your file browser.

After you copied in the new video files or changed the ``CONTENT_ROOT`` path, you need to register those changes with KA Lite:

1. Click the "Manage" tab at the top of the page.
2. Click on the "Videos" tab.
3. Click the "Scan content folder for videos" button (third one, colored blue) in the top left box of the page.

.. screenshot::
:user-role: admin
:url: /update/videos/
:navigation-steps:
:focus: #scan-videos | Click this to search your video folder for previously downloaded videos!
:class: screenshot

4. Once the scan is completed, video content will be ready for Learners to watch!

.. _adding_languages:

Expand Down
12 changes: 12 additions & 0 deletions docs/usermanual/userman_main.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
User Manual
============

.. warning::

**KA Lite is no longer under active development**

Our focus is now on our new learning platform, `Kolibri <https://learningequality.org/kolibri/>`__. If you’re just getting started, we highly recommend using Kolibri instead of KA Lite because it supports more content and will receive regular updates, and more ongoing support.

.. figure:: ../Kolibri-launch.png
:align: center

New users can experience Khan Academy and much more with Kolibri!


This guide assumes that you have already downloaded and installed the KA Lite software on your computer. If you have not yet completed these steps, please see the :doc:`../installguide/install_main`.

.. rubric:: Contents
Expand Down
5 changes: 3 additions & 2 deletions requirements_sphinx.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-r requirements_test.txt
sphinx
sphinx_rtd_theme
sphinx==1.8.5
sphinx_rtd_theme==0.4.3
sphinx-autobuild==0.7.1
sphinx-intl
# Required by screenshots.py to take screenshots in headless manner
pyvirtualdisplay

0 comments on commit 7894f84

Please sign in to comment.