Re: [ostorybook-dev] Interface utilisateur

[Bruno Raoult <braoult@xxxxxx>]

On 02/13/2017 06:15 PM, oStorybook wrote:
> Non, c'est assez clair.

Façon de voir, je parlais du PDF dans doc/hu :-)

> Ainsi dans le doc, le fichier du manuel (et aussi celui du futur site 
> web) est au format oStorybook. Si on fait les tests de développement 
> sur ce fichier il y a automatique modification. Résultat il faut 
> systématiquement l'ajouter au commit (donc mieux vaut éviter de 
> l'utiliser pour des tests).

Oui. C'est un soucis sur tous les projets. Mais ce n'est qu'un test 
d'import du format ostorybook lui-même, non ?
Je proposerais un répertoire "test files" ou équivalent, indépendant de 
la doc, qui pourrait rester stable et valide, même si le format de la 
base de données change.
Ce répertoire pourrait avoir divers fichiers (des bouquins, etc...) dans 
différentes langues, et différents formats d'import.
Un des formats d'import est OSB. Pour voir comment on sait lire les 
versions précédentes.

Pour moi, la doc devrait rester de la doc, pas du test (donc pas au 
format OSB, variable par principe), mais dans un format stable et 
universel (reconnu), genre odt.

> Sur ce point particulier il faut que je me réorganise pour ne 
> conserver dans le repository du projet, et donc à référencer dans GIT, 
> que les fichiers pertinents du projet. C'est d'ailleurs ce que tu 
> soulignes.

Oui. Je suis resté bloqué dessus depuis le début, et je voulais 
améliorer le repository.

> Je me demande même si l'idéal ne serait pas de séparer le GIT en trois 
> ensemble indépendants:
> - le code source (accès aux dev)
> - la documentation (accès aux traducteurs)
> - le site web (accès aux admins, en sachant qu'en principe les dev 
> sont admins)
>
> Puisque tu a un regard plus objectif sur la question, n'hésites pas à 
> formuler une hypothèse de nouvelle organisation.

Si on exclut qu'un dev soit forcément admin, oui, séparer la 
documentation utilisateur du dev me semble bien. Il ne resterait que 
"test-truc" pour les fichiers de test de lecture.
Le répertoire "doc" serait donc la doc développeur (qui en a besoin par 
ailleurs :-)

Pour la partie web, je ne sais pas. Puisqu'il s'agit de Guppy, qui a sa 
propre gestion par ailleurs, et ne sert pas au logiciel, je ne vois pas 
pourquoi l'intégrer.

Pour la partie "doc utilisateur", je ne vois pas. Ton idée d'avoir un 
différent repository (avec des odt ou rtf par version/langue par 
exemple) me semble bien.

Restera la question du packaging, dans ce cas (quand on veut construire 
un package final). Est-ce que la doc, pour un utilisateur final, 
doit-être locale, ou en ligne ? Dans tous les cas, je ne vois que le 
html en final (pas le source odt, ni le format OSB, pour d'évidentes 
raisons).

Ce qui se fait souvent, comme tu le sais: à l'install, on choisit une ou 
plusieurs langues, pour l'interface et/ou la doc, qui seront installées 
localement. Je suppose que garder toujours l'anglais est conservatif, si 
ça se passe mal. Ensuite, on peut ajouter/supprimer des langues 
localement (interface ou doc) indépendamment. Mais bon, c'est un vrai 
projet, pas vraiment celui du jour :-)

br.



--
oStorybook dev team