Skip to content

Commit a916b90

Browse files
docs(plugins): mention the plugin catalog where plugins are installed (#392)
Assisted-by: Claude Opus 5.5
2 parents d238dff + 521e493 commit a916b90

2 files changed

Lines changed: 10 additions & 13 deletions

File tree

‎doc/features/advanced/plugins.rst‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ Plugins are automatically discovered at startup from multiple locations:
117117
- The standalone distribution directory:
118118
If using a frozen (standalone) build, the `plugins` folder located next to the executable is scanned.
119119

120-
- Plugins installed from a file:
121-
Wheels and modules installed from **Plugins > Configure plugins...**, in the **Install plugins** tab (see :ref:`plugin_install_from_file`).
120+
- Installed plugins:
121+
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`).
122122

123123
- The internal `datalab/plugins/builtin` folder (not recommended for user plugins):
124124
This location is reserved for built-in or bundled plugins and should not be modified manually.
@@ -647,7 +647,7 @@ them. From the generated directory, install and validate the project with:
647647
python -m pytest
648648
python -m ruff check .
649649
650-
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`).
650+
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`).
651651

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

734-
As a result, a plugin that relies on a custom graphical user interface may not be fully
735-
compatible with DataLab-Web. A curated set of web-compatible plugins will be provided
736-
separately; in the meantime, refer to the DataLab-Web documentation for the practical guide
737-
to loading plugins in the browser.
734+
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.
738735

739736
Migrating from v0.20 to v1.0
740737
----------------------------

‎doc/locale/fr/LC_MESSAGES/features/advanced/plugins.po‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ msgstr "Répertoires de plugins supplémentaires : Tout nombre de répertoires s
9797
msgid "The standalone distribution directory: If using a frozen (standalone) build, the `plugins` folder located next to the executable is scanned."
9898
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é."
9999

100-
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`)."
101-
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`)."
100+
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`)."
101+
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`)."
102102

103103
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."
104104
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."
@@ -409,8 +409,8 @@ msgstr "Le projet comprend également un :class:`datalab.plugins.PluginInfo` sta
409409
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:"
410410
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 :"
411411

412-
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`)."
413-
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`)."
412+
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`)."
413+
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`)."
414414

415415
msgid "How to develop a plugin?"
416416
msgstr "Comment développer un plugin ?"
@@ -511,8 +511,8 @@ msgstr "**Pas d'interfaces graphiques propres à Qt.** Les plugins qui intègren
511511
msgid "**Execution happens inside the browser** (WebAssembly), with no native file-system access beyond the in-memory file system."
512512
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."
513513

514-
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."
515-
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."
514+
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."
515+
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."
516516

517517
msgid "Migrating from v0.20 to v1.0"
518518
msgstr "Migration de la v0.20 à la v1.0"

0 commit comments

Comments
 (0)