From a3c5ac34f02c00281778365ba18c818b524708c5 Mon Sep 17 00:00:00 2001 From: Radina Matic Date: Wed, 24 Feb 2021 20:15:21 -0800 Subject: [PATCH 1/3] Fix broken links in dev docs --- docs/backend_architecture/content/implementation.rst | 2 +- docs/frontend_architecture/core.rst | 2 +- docs/getting_started.rst | 10 +++++++--- docs/i18n.rst | 2 +- docs/release_process.rst | 2 +- docs/stack.rst | 2 +- 6 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/backend_architecture/content/implementation.rst b/docs/backend_architecture/content/implementation.rst index ffb409d465..3e6a9012ea 100644 --- a/docs/backend_architecture/content/implementation.rst +++ b/docs/backend_architecture/content/implementation.rst @@ -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 `__ allows for efficient traversal and querying of the ContentNode tree. + * `django-mptt's MPTTModel `__ 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. diff --git a/docs/frontend_architecture/core.rst b/docs/frontend_architecture/core.rst index 13dc81e2a6..bdaafc8f0c 100644 --- a/docs/frontend_architecture/core.rst +++ b/docs/frontend_architecture/core.rst @@ -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 `__. +Adding additional globally-available objects is relatively straightforward due to the :doc:`plugin and webpack build system `. 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.: diff --git a/docs/getting_started.rst b/docs/getting_started.rst index d4faede2b0..6f63b5d439 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -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 `__ as shown in the instructions below; you can also use `Virtualenv `__, `Python 3 venv `__, `Poetry `__ etc. +There are many ways to set up Python virtual environments: You can use `Pipenv `__ as shown in the instructions below; you can also use `Virtualenv `__, `Python 3 venv `__, `Poetry `__ etc. .. note:: Most virtual environments will require special setup for non-Bash shells such as Fish and ZSH. @@ -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 `_, 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 `_ 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 `_ (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 `_ 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 diff --git a/docs/i18n.rst b/docs/i18n.rst index 61074dca91..c9f8c38793 100644 --- a/docs/i18n.rst +++ b/docs/i18n.rst @@ -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 `__. Additional documentation is `available on crowdin `__. +All frontend translations can be parameterized using `ICU message syntax `__. Additional documentation is `available on crowdin `__. This syntax can be used to do things like inject variables, pluralize words, and localize numbers. diff --git a/docs/release_process.rst b/docs/release_process.rst index 13b4b9794a..ff480e3079 100644 --- a/docs/release_process.rst +++ b/docs/release_process.rst @@ -3,7 +3,7 @@ Release process =============== -We maintain a set of `release process automation scripts `__ which automatically create internal next actions in `Notion `__. The processes there have separate sets of actions for: +We maintain a set of `release process automation scripts `__ (private repo) which automatically create internal next actions in `Notion `__. The processes there have separate sets of actions for: * finals, beta, and release candidates * major versus patch releases diff --git a/docs/stack.rst b/docs/stack.rst index fee586cc80..b08b319543 100644 --- a/docs/stack.rst +++ b/docs/stack.rst @@ -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 `__ (``make dist``) and `pex files `__ (``make pex``). +The *Makefile* contains the top-level commands for building Python distributions, in particular `wheel files `__ (``make dist``) and `pex files `__ (``make pex``). The builds are automated using `buildkite `__, whose top-level configuration lives in the Kolibri repo. Other platform distributions such as `Windows `__, `Debian `__, and `Android `__ are built from the wheel files and maintained in their own repositories. From c8dcf3ad345bc5ebbd18bf4c0a4bf47a76db4250 Mon Sep 17 00:00:00 2001 From: Radina Matic Date: Wed, 24 Feb 2021 20:29:48 -0800 Subject: [PATCH 2/3] One more broken link fixed --- docs/backend_architecture/uap/implementation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/backend_architecture/uap/implementation.rst b/docs/backend_architecture/uap/implementation.rst index 60a2530005..4fbd26beab 100644 --- a/docs/backend_architecture/uap/implementation.rst +++ b/docs/backend_architecture/uap/implementation.rst @@ -5,7 +5,7 @@ Collections ----------- A ``Collection`` is implemented as a Django model that inherits from -`django-mptt's MPTTModel `__, which +`django-mptt's MPTTModel `__, 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 From 3ee357493b76695b9933d6cf6264bc3c6aa48cd7 Mon Sep 17 00:00:00 2001 From: Radina Matic Date: Wed, 24 Feb 2021 20:39:53 -0800 Subject: [PATCH 3/3] Run linter --- docs/getting_started.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 6f63b5d439..31d70150c2 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -117,10 +117,10 @@ 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 `_ (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 `_ 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.