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.

Sign up for GitHub

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

Jump to bottom

Docs updates for the 0.15 release #238

Merged
merged 5 commits into from
Jan 10, 2022
Merged

Docs updates for the 0.15 release #238

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d6c338f
Docs updates for the 0.15 release
radinamatic Dec 13, 2021
dd9fbf9
Removed hardcoded version
radinamatic Dec 21, 2021
1d73f4a
Added warning for permission problems during export.
radinamatic Dec 21, 2021
f442503
Reinforced the warning for private channels import in local networks
radinamatic Dec 21, 2021
dec6949
Final pass for Imps review
radinamatic Jan 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# FOR! DO NOT LET THEM BE TARGETTED AT MORE THAN ONE MINOR SERIES!
# I.E.: 0.1.x -- important to add 'dev' suffix for docs targetting development
# series.
DISPLAY_VERSION = "0.14"
DISPLAY_VERSION = "0.15"


# If extensions (or modules to document with autodoc) are in another directory,
Expand Down Expand Up @@ -177,6 +177,8 @@ def setup(app):
:format: html

.. |br| replace:: :raw-html:`<br /><br />`
.. |version| replace:: 0.15
.. |version-b| replace:: :raw-html:`<strong>0.15</strong>`


"""
Expand Down
2 changes: 1 addition & 1 deletion docs/install/initial_setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Here are definitions of concepts necessary to understand the available options i

* **Learn-only device**

Unlike a 'full device', on a learn-only device only the features for learners are available. Coaches and admins can sign in but will only see the *Learn* page. Learn-only devices also include automated data syncing functionality.
Unlike a 'full device', a learn-only device will have available only the features for learners. Coaches and admins can sign in but will only see the *Learn* page. Learn-only devices also include automated data syncing functionality.
indirectlylit marked this conversation as resolved.
Show resolved Hide resolved

Sync
Syncing is the process of synchronizing facility data (learners, groups, classes, learner progress, assignments) between devices that have the same facility. The facility is created once on a full device, and subsequently imported to other devices. Facility data can afterwards be synced between devices as long as they are on the same local network.
Expand Down
4 changes: 2 additions & 2 deletions docs/install/macos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ MacOS
Compatibility
-------------

Kolibri macOS app has been tested on High Sierra (10.13), Mojave (10.14), and Catalina (10.15) macOS releases.
Kolibri macOS app has been tested on Catalina (10.15) macOS release.

.. raw:: html

Expand All @@ -16,7 +16,7 @@ Kolibri macOS app has been tested on High Sierra (10.13), Mojave (10.14), and Ca
Install
-------

#. Download the `.dmg installer <https://learningequality.org/r/kolibri-mac-latest>`__ for Kolibri **version 0.14**.
#. Download the `.dmg installer <https://learningequality.org/r/kolibri-mac-latest>`__ for Kolibri **version** |version-b|.
#. Double-click the downloaded ``.dmg`` file.
#. Drag the Kolibri logo inside the **Applications** folder, and wait for the installation to finish.

Expand Down
2 changes: 1 addition & 1 deletion docs/install/python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Python EXecutable

On MacOS and Linux, follow these steps to run Kolibri with the ``PEX`` package.

#. Download the `PEX installer <https://learningequality.org/download/>`_ for Kolibri **version 0.14**.
#. Download the `PEX installer <https://learningequality.org/download/>`_ for Kolibri **version** |version-b|.
#. Make sure to **open the Terminal where you downloaded** the ``PEX`` file. For example, if you saved it in the *Downloads* folder, type this when you open the Terminal, and press Enter:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/install/raspberry_pi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Our image provides an out-of-the-box Kolibri experience pre-configurated with a

To use:

1. Download the `Raspberry Pi ZIP file <https://learningequality.org/download/>`_ for Kolibri **version 0.15**, or have it copied to your local drive.
1. Download the `Raspberry Pi ZIP file <https://learningequality.org/download/>`_ for Kolibri **version** |version-b|, or have it copied to your local drive.
2. Use any of the methods explained in the `official Raspberry Pi user guide <https://www.raspberrypi.com/documentation/computers/getting-started.html>`_ to write the image to a SD card.
3. Insert the SD card in the Raspberry Pi.
4. Power on the Raspberry Pi and wait. The process takes less than 5 minutes in a model 4, but in other models can take longer. You may observe some ``Failure`` messages during this process, which is normal.
Expand Down
2 changes: 1 addition & 1 deletion docs/install/ubuntu-debian.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Install from a .deb file

The advantages of downloading a ``.deb`` file is the portability: you can copy the file from device to device and install Kolibri without internet access.

#. Download the latest `.deb installer <https://learningequality.org/download/>`_ for Kolibri **version 0.14**, or have it copied to your local drive.
#. Download the latest `.deb installer <https://learningequality.org/download/>`_ for Kolibri **version** |version-b|, or have it copied to your local drive.
#. Run this command from the location where you downloaded the ``DEB`` file:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/install/windows.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Compatibility
Install
-------

#. Download the `Windows installer <https://learningequality.org/download/>`_ for Kolibri **version 0.14**.
#. Download the `Windows installer <https://learningequality.org/download/>`_ for Kolibri **version** |version-b|.
#. Double-click the downloaded ``.exe`` file.
#. Select the language for the installation.
#. Python 3 installer is included, confirm the installation or the upgrade to proceed.
Expand Down