On 27/04/2012 12:00, Tony Chemit wrote:
Hello,
En parlant de la documentation de Pollen, m'est venue une idée de générer un rapport Maven pour ApplicationConfig qui donne toutes les options possibles pour une implantation d'application config.
Il faudrait pour ce faire ajouter la notion de provider d'option (une classe qui donne juste le fqn de l'énum où y'a les options et le type de configuration).
Ce provider est chargé via un ServiceLoader, donc rien à faire pour client (ici le plugin maven).
Ensuite pour chaque configuration (wikity, topia, ..., application finale), on affiche un beau tableau où y'a toutes les optiosn avec leur description, valuer par defaut et type.
Tout ça est facile à faire et peu couteux et ça serait bien pratique pour ne pas l'écrire à la main et surtout c'est générable (donc ça suivra bien les évolutions des configurations).
Avant de mettre les jolies tableaux on pourrait aussi avoir en introduction un paragraphe qui explique comment fonctionne applicationConfig (la logique des configuration surchargé), où positionner son fichier de configuration (/etc, home, dir,...)
Je vote +1 pour faire ça. Je vais tenter ça ce week-end je pense.
Si y'a d'autres idées d'ici là je suis preneur Très bonne idée, je vote +1 aussi. Cette page apparaîtra seulement dans les rapports maven par contre ? Peut-être le rajouter manuellement sur une page d'installation pour les applications finales qui le nécessite.
Autre idée indépendante : Je pensais également au README.txt, a priori il devrait comporter tout ce qu'une page d'installation devrait avoir, non ? Ce serait peut-être intéressant de pouvoir le récupérer et/ou le synchroniser avec la documentation maven.