Documenter la création d'un nouveau plugin

[maltaesousa]

Demande initiale de @maltaesousa

Extract est extensible à l'aide de plugins mais la documentation d'ajout d'un nouveau plugin est trop succincte.
Idéalement un dépôt exemple (boilerplate) devrait exister avec les instructions de build à la façon d'un "getting started".

Objectif

Documenter la création de nouveaux plugins de tâches et de connecteurs en mettant à disposition des boilerplates contenant une structure de base qui peut être facilement personnalisée.

Gestion des boilerplates

Deux façons de gérer ces boilerplates sont envisagées.

Solution idéale

Générer un boilerplate à la volée à l'aide d'un CLI en s'appuyant sur la libraire Maven Archetype. Il doit y avoir deux commandes distinctes en fonction du type de plugin (tâche ou connecteur).

Solution alternative

Dans le dossier extract/docs, ajouter deux répertoires :

extract-task-sample

extract-connector-sample

L'utilisateur pourra ainsi les copier à la racine pour les adapter à ses besoins.

Documentation

La documentation des boilerplates est directement inclue dans le code source.

Elle doit contenir une explication détaillée des différentes parties du code, ainsi que des exemples d'utilisation et des instructions sur la personnalisation.

Des instructions complètes sur le façon d'initialiser / builder le projet et sur l'utilisation des boilerplates doivent être présentes à la racine du répertoire extra/docs, dans un fichier getting-started.md

Critères d'acceptation

Identifiant	Description
255-1	Un boilerplate doit être mis à disposition pour les plugins de tâche
255-2	Un boilerplate doit être mis à disposition pour les plugins de connecteur
255-3	Les boilerplates doivent passer les tests par défaut
255-4	Le fichier getting-started.md doit documenter comment exploiter les boilerplates
255-5	Le fichier getting-started.md doit documenter comment initialiser / builder le projet

[yblatti]

Très juste. Tu penses aux plugin de tâches, de connecteurs, ou les deux ?

[maltaesousa]

Plutôt aux plugins de tâches.

Tu avais déjà mentionné l'appel à GDAL, on pourrait imaginer avoir le plugin GDAL dans un autre dépôt avec les instructions pour le builder, pour moi ça servirait déjà bien d'exemple. Ou alors un dépôt boilerplate avec un plugin "Hello world!"