Skip to content

docs(plugins): mention the plugin catalog where plugins are installed #392

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

Merged
PierreRaybaut merged 1 commit into from
Oct 8, 2026
Merged

docs(plugins): mention the plugin catalog where plugins are installed #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions doc/features/advanced/plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ Plugins are automatically discovered at startup from multiple locations:
- The standalone distribution directory:
If using a frozen (standalone) build, the `plugins` folder located next to the executable is scanned.

- Plugins installed from a file:
Wheels and modules installed from **Plugins > Configure plugins...**, in the **Install plugins** tab (see :ref:`plugin_install_from_file`).
- Installed plugins:
Wheels and modules installed from **Plugins > Configure plugins...**, either from a file in the **Install plugins** tab (see :ref:`plugin_install_from_file`) or from the plugin catalog in the **Available plugins** tab (see :ref:`plugin_catalog`).

- The internal `datalab/plugins/builtin` folder (not recommended for user plugins):
This location is reserved for built-in or bundled plugins and should not be modified manually.
Expand Down Expand Up @@ -647,7 +647,7 @@ them. From the generated directory, install and validate the project with:
python -m pytest
python -m ruff check .

The generated ``pyproject.toml`` requires the current DataLab major version (for example ``datalab-platform >= 1.4, < 2``) and declares the project URLs when the GitHub account is known. The generated ``.github/workflows/release.yml`` publishes the plugin without any PyPI account: pushing a tag such as ``v0.1.0`` builds the wheel, checks that the tag matches the package version, attaches the wheel to a GitHub release, and prints the entry to submit to the `DataLab plugin catalog <https://github.com/DataLab-Platform/plugins>`_, including the SHA-256 digest of the wheel. Users then install the wheel with **Plugins > Configure plugins... > Install plugins** (see :ref:`plugin_install_from_file`).
The generated ``pyproject.toml`` requires the current DataLab major version (for example ``datalab-platform >= 1.4, < 2``) and declares the project URLs when the GitHub account is known. The generated ``.github/workflows/release.yml`` publishes the plugin without any PyPI account: pushing a tag such as ``v0.1.0`` builds the wheel, checks that the tag matches the package version, attaches the wheel to a GitHub release, and prints the entry to submit to the `DataLab plugin catalog <https://github.com/DataLab-Platform/plugins>`_, including the SHA-256 digest of the wheel. Users then install the wheel with **Plugins > Configure plugins... > Install plugins** (see :ref:`plugin_install_from_file`). Listing the plugin in the catalog is optional; once listed, it can also be installed from the **Available plugins** tab (see :ref:`plugin_catalog`).

How to develop a plugin?
------------------------
Expand Down Expand Up @@ -731,10 +731,7 @@ browser runtime, however:
- **Execution happens inside the browser** (WebAssembly), with no native file-system access
beyond the in-memory file system.

As a result, a plugin that relies on a custom graphical user interface may not be fully
compatible with DataLab-Web. A curated set of web-compatible plugins will be provided
separately; in the meantime, refer to the DataLab-Web documentation for the practical guide
to loading plugins in the browser.
As a result, a plugin that relies on a custom graphical user interface may not be fully compatible with DataLab-Web. The `DataLab plugin catalog <https://datalab-platform.com/plugins/>`_ indicates which of its plugins also support DataLab-Web. Refer to the DataLab-Web documentation for the practical guide to loading plugins in the browser.

Migrating from v0.20 to v1.0
----------------------------
Expand Down
12 changes: 6 additions & 6 deletions doc/locale/fr/LC_MESSAGES/features/advanced/plugins.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ msgstr "Répertoires de plugins supplémentaires : Tout nombre de répertoires s
msgid "The standalone distribution directory: If using a frozen (standalone) build, the `plugins` folder located next to the executable is scanned."
msgstr "Le répertoire de distribution autonome : Si vous utilisez une version gelée (autonome), le dossier `plugins` situé à côté de l'exécutable est analysé."

msgid "Plugins installed from a file: Wheels and modules installed from **Plugins > Configure plugins...**, in the **Install plugins** tab (see :ref:`plugin_install_from_file`)."
msgstr "Les plugins installés depuis un fichier : Wheels et modules installés depuis **Plugins > Configurer les plugins...**, dans l'onglet **Installer des plugins** (voir :ref:`plugin_install_from_file`)."
msgid "Installed plugins: Wheels and modules installed from **Plugins > Configure plugins...**, either from a file in the **Install plugins** tab (see :ref:`plugin_install_from_file`) or from the plugin catalog in the **Available plugins** tab (see :ref:`plugin_catalog`)."
msgstr "Les plugins installés : wheels et modules installés depuis **Plugins > Configurer les plugins...**, soit depuis un fichier dans l'onglet **Installer des plugins** (voir :ref:`plugin_install_from_file`), soit depuis le catalogue de plugins dans l'onglet **Plugins disponibles** (voir :ref:`plugin_catalog`)."

msgid "The internal `datalab/plugins/builtin` folder (not recommended for user plugins): This location is reserved for built-in or bundled plugins and should not be modified manually."
msgstr "Le dossier interne `datalab/plugins/builtin` (non recommandé pour les plugins utilisateur) : Cet emplacement est réservé aux plugins intégrés ou fournis et ne doit pas être modifié manuellement."
Expand Down Expand Up @@ -409,8 +409,8 @@ msgstr "Le projet comprend également un :class:`datalab.plugins.PluginInfo` sta
msgid "The template remains deliberately small. Add domain recipes, DataSet parameters, packaged examples, and specialized CI only when the plugin needs them. From the generated directory, install and validate the project with:"
msgstr "Le modèle reste volontairement réduit. Ajoutez des recettes métier, des paramètres DataSet, des exemples empaquetés et une intégration continue spécialisée uniquement lorsque le plugin en a besoin. Depuis le répertoire généré, installez et validez le projet avec :"

msgid "The generated ``pyproject.toml`` requires the current DataLab major version (for example ``datalab-platform >= 1.4, < 2``) and declares the project URLs when the GitHub account is known. The generated ``.github/workflows/release.yml`` publishes the plugin without any PyPI account: pushing a tag such as ``v0.1.0`` builds the wheel, checks that the tag matches the package version, attaches the wheel to a GitHub release, and prints the entry to submit to the `DataLab plugin catalog <https://github.com/DataLab-Platform/plugins>`_, including the SHA-256 digest of the wheel. Users then install the wheel with **Plugins > Configure plugins... > Install plugins** (see :ref:`plugin_install_from_file`)."
msgstr "Le ``pyproject.toml`` généré exige la version majeure courante de DataLab (par exemple ``datalab-platform >= 1.4, < 2``) et déclare les URL du projet lorsque le compte GitHub est connu. Le fichier ``.github/workflows/release.yml`` généré publie le plugin sans compte PyPI : pousser une étiquette comme ``v0.1.0`` construit le wheel, vérifie que l'étiquette correspond à la version du package, joint le wheel à une release GitHub et affiche la fiche à soumettre au `catalogue de plugins DataLab <https://github.com/DataLab-Platform/plugins>`_, avec l'empreinte SHA-256 du wheel. Les utilisateurs installent ensuite le wheel avec **Plugins > Configurer les plugins... > Installer des plugins** (voir :ref:`plugin_install_from_file`)."
msgid "The generated ``pyproject.toml`` requires the current DataLab major version (for example ``datalab-platform >= 1.4, < 2``) and declares the project URLs when the GitHub account is known. The generated ``.github/workflows/release.yml`` publishes the plugin without any PyPI account: pushing a tag such as ``v0.1.0`` builds the wheel, checks that the tag matches the package version, attaches the wheel to a GitHub release, and prints the entry to submit to the `DataLab plugin catalog <https://github.com/DataLab-Platform/plugins>`_, including the SHA-256 digest of the wheel. Users then install the wheel with **Plugins > Configure plugins... > Install plugins** (see :ref:`plugin_install_from_file`). Listing the plugin in the catalog is optional; once listed, it can also be installed from the **Available plugins** tab (see :ref:`plugin_catalog`)."
msgstr "Le ``pyproject.toml`` généré exige la version majeure courante de DataLab (par exemple ``datalab-platform >= 1.4, < 2``) et déclare les URL du projet lorsque le compte GitHub est connu. Le fichier ``.github/workflows/release.yml`` généré publie le plugin sans compte PyPI : pousser une étiquette comme ``v0.1.0`` construit le wheel, vérifie que l'étiquette correspond à la version du package, joint le wheel à une release GitHub et affiche la fiche à soumettre au `catalogue de plugins DataLab <https://github.com/DataLab-Platform/plugins>`_, avec l'empreinte SHA-256 du wheel. Les utilisateurs installent ensuite le wheel avec **Plugins > Configurer les plugins... > Installer des plugins** (voir :ref:`plugin_install_from_file`). L'inscription du plugin au catalogue est facultative ; une fois inscrit, il peut aussi être installé depuis l'onglet **Plugins disponibles** (voir :ref:`plugin_catalog`)."

msgid "How to develop a plugin?"
msgstr "Comment développer un plugin ?"
Expand Down Expand Up @@ -511,8 +511,8 @@ msgstr "**Pas d'interfaces graphiques propres à Qt.** Les plugins qui intègren
msgid "**Execution happens inside the browser** (WebAssembly), with no native file-system access beyond the in-memory file system."
msgstr "**L'exécution a lieu dans le navigateur** (WebAssembly), sans accès natif au système de fichiers au-delà du système de fichiers en mémoire."

msgid "As a result, a plugin that relies on a custom graphical user interface may not be fully compatible with DataLab-Web. A curated set of web-compatible plugins will be provided separately; in the meantime, refer to the DataLab-Web documentation for the practical guide to loading plugins in the browser."
msgstr "Par conséquent, un plugin qui repose sur une interface graphique personnalisée peut ne pas être entièrement compatible avec DataLab-Web. Un ensemble sélectionné de plugins compatibles avec le navigateur sera fourni séparément ; en attendant, reportez-vous à la documentation de DataLab-Web pour le guide pratique de chargement des plugins dans le navigateur."
msgid "As a result, a plugin that relies on a custom graphical user interface may not be fully compatible with DataLab-Web. The `DataLab plugin catalog <https://datalab-platform.com/plugins/>`_ indicates which of its plugins also support DataLab-Web. Refer to the DataLab-Web documentation for the practical guide to loading plugins in the browser."
msgstr "Par conséquent, un plugin qui repose sur une interface graphique personnalisée peut ne pas être entièrement compatible avec DataLab-Web. Le `catalogue de plugins DataLab <https://datalab-platform.com/plugins/>`_ indique lesquels de ses plugins prennent aussi en charge DataLab-Web. Reportez-vous à la documentation de DataLab-Web pour le guide pratique de chargement des plugins dans le navigateur."

msgid "Migrating from v0.20 to v1.0"
msgstr "Migration de la v0.20 à la v1.0"
Expand Down
Loading