Tweet
Coucou et tout d'abord félicitations pour le travail réalisé! Pas besoin d'être devin pour réaliser le temps que vous devez passer sur ce projet!
Une petite suggestion donc. Je viens de me lancer dans le monde de nagios après une petite période de documentation qui m'a inévitablement amenée à Oreon.
Ma remarque concerne l'ajout de services et de leurs arguments. Cela m'a pris pas mal de temps avant de réaliser que les arguments des commandes sont définis dans le fichier "checkcommands.cfg" (voilà c'est dit, peut être que ça aidera quelqu'un perdu comme je l'ai été :wink: ).
Il pourrait être très intéressant de présenter les arguments (leur ordre et leur définition rapide) d'une commande choisie au niveau de l'interface (javascript sur choix de la liste?), ou beaucoup plus simplement dans la doc. Je sais par expérience qu'une documentation est très fastidieuse à réaliser (je dois bien en faire une dizaine chaque année, selon le nombre de projets), surtout lorsque l'on développe soit même les applications: on finit par les connaitre par coeur et il n'apparait pas toujours évident qu'un utilisateur ai besoin de telle ou telle information
.
Sinon je penses qu'une simple référence à "checkcommands.cfg" en p.32 de la doc (juste après l'évocation de $ARGx$) pourrait être déjà particulièrement efficace en terme d'aide à l'utilisation.
Voili voilou, en espérant que cette remarque soit constructive...
Peut être reviendrais-je faire part de quelques constatations. En tout cas bravo, bonne continuation et bon courage pour la suite des choses!
Une petite suggestion donc. Je viens de me lancer dans le monde de nagios après une petite période de documentation qui m'a inévitablement amenée à Oreon.
Ma remarque concerne l'ajout de services et de leurs arguments. Cela m'a pris pas mal de temps avant de réaliser que les arguments des commandes sont définis dans le fichier "checkcommands.cfg" (voilà c'est dit, peut être que ça aidera quelqu'un perdu comme je l'ai été :wink: ).
Il pourrait être très intéressant de présenter les arguments (leur ordre et leur définition rapide) d'une commande choisie au niveau de l'interface (javascript sur choix de la liste?), ou beaucoup plus simplement dans la doc. Je sais par expérience qu'une documentation est très fastidieuse à réaliser (je dois bien en faire une dizaine chaque année, selon le nombre de projets), surtout lorsque l'on développe soit même les applications: on finit par les connaitre par coeur et il n'apparait pas toujours évident qu'un utilisateur ai besoin de telle ou telle information
.Sinon je penses qu'une simple référence à "checkcommands.cfg" en p.32 de la doc (juste après l'évocation de $ARGx$) pourrait être déjà particulièrement efficace en terme d'aide à l'utilisation.
Voili voilou, en espérant que cette remarque soit constructive...
Peut être reviendrais-je faire part de quelques constatations. En tout cas bravo, bonne continuation et bon courage pour la suite des choses!
Comment