Si vous connaissez déjà le potentiel de XWiki et que vous vous reconnaissez dans son esprit communautaire dynamique et ses valeurs open-source, nous avons une grande nouvelle pour vous ! En combinant votre passion pour le logiciel XWiki avec l'application intuititive App Within Minutes (AWM), vous pouvez créer votre propre application et la publier sur le dépôt d'extensions de XWiki afin que n'importe qui dans le monde puisse l'utiliser.

Ce tutoriel vous montrera comment publier votre application sur extensions.xwiki.org et ce qui fait qu'une extension soit qualitative.

Étape 1 : Créer votre application

Dans votre instance XWiki, créez votre application avec App Within Minutes.

Etape 2 : Télécharger le fichier XAR

Sur la page d'accueil de l'application, sélectionnez « Exporter » à partir du bouton « Plus d'actions » et sélectionnez le format XAR. Par défaut, toutes les pages de l'application, imbriquées sous la page d'accueil de l'application, sont incluses dans l'exportation. Dans le cas ci-dessous, la page principale de l'application est « Quarterly reporting ».

Étape 3 : Créer la page d'extension

Le fichier XAR téléchargé doit être uploadé sur la page des extensions du wiki. Si vous n'avez pas de compte, vous devez d'abord vous enregistrer.

Après avoir créé un compte, écrivez le nom de votre nouvelle application et cliquez sur « Contribuer ». Une nouvelle page contenant des informations sur l'extension s'ouvrira.

Sur la nouvelle page, remplissez les champs suivants :

  • Nom de l'application
  • Type (XAR)
  • Catégorie (application)
  • Sommaire (1 ligne de texte sur ce à quoi l'application peut servir)
  • Description (expliquer l'objectif, comment utiliser la nouvelle application et comment uploader des captures d'écran)

Cliquez ensuite sur « Enregistrer et visualiser » et accédez à la page de la nouvelle extension. En bas de la page, vous placerez votre fichier XAR dans la section Attachments (pièces jointes).

Enfin, la dernière chose que vous devez faire pour vous assurer que votre application fonctionne est de cliquer sur « Modifier » et ajouter :

  • L'URL de téléchargement (dans les pièces jointes, cliquez à droite sur le fichier XAR pour obtenir l'adresse du lien, puis collez-la dans le champ URL de téléchargement)
  • La version : 1.0 (puisque c'est la première)

Après avoir sauvegardé, vous devriez voir « Installable with the Extension Manager » et un bouton avec « Download v1.0 » comme ci-dessous :

Comment s'assurer que votre application répond aux normes de qualité ?

Bien que nous encouragions les enthousiastes de l'open-source à contribuer au projet open-source XWiki, l'équipe de développement XWiki doit également s'assurer que les applications publiées sont utiles et utilisables. Voici donc quelques points à retenir lorsque l'on contribue avec une application réalisée avec App Within Minutes :

  1. L'application doit être suffisamment générique pour que le plus grand nombre d'utilisateurs possible la trouve utile. C'est quelque chose que l'on acquiert avec le temps et la pratique. En outre, vous pouvez valider votre idée dans notre forum XWiki.
  2. Il est essentiel de fournir une description qualitative lors de la création d'une nouvelle extension ! Cela signifie que la description doit :

1\*. Contenir la fonction de l'extension et ses caractéristiques ;
1\*. Contenir Une capture d'écran claire de l'application ;
1\*. Expliquer comment les utilisateurs doivent l'utiliser ;
1\*. Documenter chaque fonctionnalité et fournir une capture d'écran ou une vidéo claire.

Voici quelques autres recommandations pour créer une bonne documentation pour votre extension.

Avertissement:

⚠ Si vous ne respectez pas ces normes minimales de qualité pour le déploiement d'une application, vous risquez de voir votre application supprimée.

Vous pouvez consulter la documentation des extensions existantes et essayer de vous inspirer de ce que vous voyez. Nous vous encourageons également à apporter vos propres améliorations si vous pensez que cela peut améliorer l'expérience de l'utilisateur.

Ressources open-source supplémentaires