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

Fix broken links in dev docs #7815

Merged
merged 3 commits into from
Feb 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/backend_architecture/content/implementation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ ContentNode
``ContentNode`` is implemented as a Django model that inherits from two abstract classes, MPTTModel and ContentDatabaseModel.


* `django-mptt's MPTTModel <http://django-mptt.github.io/django-mptt/overview.html/>`__ allows for efficient traversal and querying of the ContentNode tree.
* `django-mptt's MPTTModel <https://django-mptt.readthedocs.io/en/latest/overview.html>`__ allows for efficient traversal and querying of the ContentNode tree.
* ``ContentDatabaseModel`` is used as a marker so that the content_db_router knows to query against the content database only if the model inherits from ContentDatabaseModel.

The tree structure is established by the ``parent`` field that is a foreign key pointing to another ContentNode object. You can also create a symmetric relationship using the ``related`` field, or an asymmetric field using the ``is_prerequisite`` field.
Expand Down
2 changes: 1 addition & 1 deletion docs/backend_architecture/uap/implementation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Collections
-----------

A ``Collection`` is implemented as a Django model that inherits from
`django-mptt's MPTTModel <http://django-mptt.github.io/django-mptt/>`__, which
`django-mptt's MPTTModel <https://django-mptt.readthedocs.io/en/latest/index.html>`__, which
allows for efficient traversal and querying of the collection hierarchy. For
convenience, the specific types of collections -- ``Facility``, ``Classroom``,
and ``LearnerGroup`` -- are implemented as _proxy models of the main
Expand Down
2 changes: 1 addition & 1 deletion docs/frontend_architecture/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ And **many** others. The complete specification for commonly shared modules can
import Vue from 'kolibri.lib.vue';
import CoreBase from 'kolibri.coreVue.components.CoreBase';

Adding additional globally-available objects is relatively straightforward due to the `plugin and webpack build system </pipeline/frontend_build_pipeline>`__.
Adding additional globally-available objects is relatively straightforward due to the :doc:`plugin and webpack build system <frontend_build_pipeline>`.

To expose something in the core app, add the module to the object in ``apiSpec.js``, scoping it to the appropriate property for better organization - e.g.:

Expand Down
10 changes: 7 additions & 3 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Python virtual environment

You should use a Python virtual environment to isolate the dependencies of your Python projects from each other and to avoid corrupting your system's Python installation.

There are many ways to set up Python virtual environments: You can use `Pipenv <https://pipenv.readthedocs.io/en/latest/>`__ as shown in the instructions below; you can also use `Virtualenv <https://virtualenv.pypa.io/en/stable/userguide/>`__, `Python 3 venv <https://docs.python.org/3/library/venv.html>`__, `Poetry <https://poetry.eustace.io>`__ etc.
There are many ways to set up Python virtual environments: You can use `Pipenv <https://pipenv.readthedocs.io/en/latest/>`__ as shown in the instructions below; you can also use `Virtualenv <https://virtualenv.pypa.io/en/latest/>`__, `Python 3 venv <https://docs.python.org/3/library/venv.html>`__, `Poetry <https://poetry.eustace.io>`__ etc.

.. note::
Most virtual environments will require special setup for non-Bash shells such as Fish and ZSH.
Expand Down Expand Up @@ -116,8 +116,12 @@ Environment variables can be set in many ways, including:

There are two environment variables you should plan to set:

* ``KOLIBRI_RUN_MODE`` (required): This variable is sent to our `pingback server <https://github.com/learningequality/nutritionfacts>`_, and you must set it to something besides an empty string. This allows us to filter development work out of our usage statistics. (There are also some `special testing behaviors <https://github.com/learningequality/nutritionfacts/blob/b150ec9fd80cd0f02c087956fd5f16b2592f94d4/nutritionfacts/views.py#L125-L179>`_ that can be triggered for special strings, as described elsewhere in the developer docs and integration testing gherkin stories.)
* ``KOLIBRI_HOME`` (optional): This variable determines where Kolibri will store its content and databases. It is useful to set if you want to have multiple versions of Kolibri running simultaneously.
* ``KOLIBRI_RUN_MODE`` (required)

This variable is sent to our `pingback server <https://github.com/learningequality/nutritionfacts>`_ (private repo), and you must set it to something besides an empty string. This allows us to filter development work out of our usage statistics. There are also some `special testing behaviors <https://github.com/learningequality/nutritionfacts/blob/b150ec9fd80cd0f02c087956fd5f16b2592f94d4/nutritionfacts/views.py#L125-L179>`_ that can be triggered for special strings, as described elsewhere in the developer docs and integration testing Gherkin scenarios.
* ``KOLIBRI_HOME`` (optional)

This variable determines where Kolibri will store its content and databases. It is useful to set if you want to have multiple versions of Kolibri running simultaneously.


Install Python dependencies
Expand Down
2 changes: 1 addition & 1 deletion docs/i18n.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Then messages are available from the ``$tr`` method on the translator object:
ICU message syntax
~~~~~~~~~~~~~~~~~~

All frontend translations can be parameterized using `ICU message syntax <https://formatjs.io/guides/message-syntax/>`__. Additional documentation is `available on crowdin <https://support.crowdin.com/icu-message-syntax/>`__.
All frontend translations can be parameterized using `ICU message syntax <https://formatjs.io/docs/core-concepts/icu-syntax>`__. Additional documentation is `available on crowdin <https://support.crowdin.com/icu-message-syntax/>`__.

This syntax can be used to do things like inject variables, pluralize words, and localize numbers.

Expand Down
2 changes: 1 addition & 1 deletion docs/release_process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Release process
===============

We maintain a set of `release process automation scripts <https://github.com/learningequality/kolibri-release-process/>`__ which automatically create internal next actions in `Notion <https://www.notion.so/learningequality/>`__. The processes there have separate sets of actions for:
We maintain a set of `release process automation scripts <https://github.com/learningequality/kolibri-release-process/>`__ (private repo) which automatically create internal next actions in `Notion <https://www.notion.so/learningequality/>`__. The processes there have separate sets of actions for:

* finals, beta, and release candidates
* major versus patch releases
Expand Down
2 changes: 1 addition & 1 deletion docs/stack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Preparation of client-side resources involves:
- Generating source maps
- Providing mechanisms for decoupled "Kolibri plugins" to interact with each other and asynchronously load dependencies

The *Makefile* contains the top-level commands for building Python distributions, in particular `wheel files <https://pythonwheels.com/>`__ (``make dist``) and `pex files <https://pex.readthedocs.io/en/stable/>`__ (``make pex``).
The *Makefile* contains the top-level commands for building Python distributions, in particular `wheel files <https://pythonwheels.com/>`__ (``make dist``) and `pex files <https://pex.readthedocs.io/en/latest/>`__ (``make pex``).

The builds are automated using `buildkite <https://buildkite.com/learningequality>`__, whose top-level configuration lives in the Kolibri repo. Other platform distributions such as `Windows <https://github.com/learningequality/kolibri-installer-windows>`__, `Debian <https://github.com/learningequality/kolibri-installer-debian>`__, and `Android <https://github.com/learningequality/kolibri-installer-android/issues>`__ are built from the wheel files and maintained in their own repositories.

Expand Down