Skip to content

Document Kolibri's optional plugins in the user manual #261

Description

@indirectlylit

Overview

Add a user-manual page cataloguing Kolibri's optional plugins — the ones that ship as separate PyPI wheels rather than in core.

Context

  • The optional plugins now live in-tree in the Kolibri monorepo at python_packages/ and publish as independent PyPI wheels: kolibri-sentry-plugin, kolibri-oidc-client-plugin, kolibri-oidc-provider-plugin, kolibri-opensearch-plugin, kolibri-sync-extras-plugin.
  • context_translation (Extract the context_translation plugin into python_packages kolibri#14975) and demo_server (Extract the demo_server plugin into python_packages kolibri#14976) are being extracted into python_packages/ too.
  • Kolibri's developer docs cover the contributor view — adding and publishing a member package, and the plugin mechanism itself.
  • No page tells an admin which optional plugins exist, or how to install and enable one.
  • This supersedes the original 2020 framing, which assumed the plugins lived in separate repositories.
  • The migration moved their source in-tree.

The Change

  • Add an "Optional plugins" page to the user manual.
  • List each optional plugin with a one-line description of what it does.
  • Give the install command for each (pip install kolibri-<name>-plugin).
  • Give the enable step for each (via kolibri plugin enable).
  • Note each plugin's configuration, or state that it needs none.
  • Point to the plugin's python_packages/ source directory.
  • Cross-link the page from Kolibri's developer docs.

Out of Scope

  • The platform installers (server, debian, pi, app, gnome, android) — covered by their own migration issues and existing install docs.
  • The contributor "how to add a member package" flow — already in the developer docs.
  • Third-party or community plugins outside python_packages/.
  • In-platform plugin discovery/management — a separate future feature.

Acceptance Criteria

  • A user-manual page lists every python_packages/ optional plugin with a one-line description.
  • Each entry gives the install command.
  • Each entry gives the enable step.
  • Each entry states its configuration, or that it needs none.
  • Each entry links to its python_packages/ source directory.
  • Kolibri's developer docs link to the new page.

References

AI usage

Rewrote this 2020 issue with Claude Code to reflect the monorepo migration. Claude checked Kolibri's existing docs to confirm the catalogue gap.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions