[REDMINE1D-231] [RM-5917] Mettre a jour le manuel utilisateur Created: 05/Jul/23  Updated: 05/Jul/23

Status: In Progress
Project: 1D Redmine
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Normal
Reporter: Redmine-Jira Migtation Assignee: Redmine-Jira Migtation
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

Created on 2020-07-22 14:26:22 by Pierre-yves Chabaud. % Done: 10

Vérifier la conformité avec la doc du @parameter.json@ : https://projets.lam.fr/projects/amazed/wiki/AmazedParameters



 Comments   
Comment by Redmine-Jira Migtation [ 05/Jul/23 ]

Comment by Didier Vibert on 2020-09-28 08:06:17:
Pierre-Yves où se trouve la doc du @parameter.json@ ?

S'il faut la mettre à jour as-tu le script ou la commande utilisée par Guillaume pour l'exporter depuis le wiki ?

Comment by Redmine-Jira Migtation [ 05/Jul/23 ]

Comment by Pierre-yves Chabaud on 2020-10-07 08:25:36:
Dans le client PFS, la doc du @parameters.json@ se trouve dans le fichier @MANUAL.md@.
Je n'ai pas de moulinette pour exporter la page wiki vers le @MANUAL.md@.

D'une manière générale on souffre d'un manque de doc et particulièrement d'un système de génération automatique (via sphnx ou dioxygen ?). Je pense qu'on devrait générer un ticket pour la mise en place d'une doc automatique.

Comment by Redmine-Jira Migtation [ 05/Jul/23 ]

Comment by Didier Vibert on 2020-10-07 09:05:19:
Pierre-yves CHABAUD wrote in #note-2:
> Dans le client PFS, la doc du @parameters.json@ se trouve dans le fichier @MANUAL.md@.

ok je vais déjà lister ici ce qui a divergé. On pourra temporairement l'inclure à la main ?

> Je n'ai pas de moulinette pour exporter la page wiki vers le @MANUAL.md@.
>
> D'une manière générale on souffre d'un manque de doc et particulièrement d'un système de génération automatique (via sphnx ou dioxygen ?). Je pense qu'on devrait générer un ticket pour la mise en place d'une doc automatique.

yep. Du coup on attend cette moulinette de génération automatique ou il y a urgence à faire l'update du @MANUAL.md@ ?

Comment by Redmine-Jira Migtation [ 05/Jul/23 ]

Comment by Pierre-yves Chabaud on 2020-10-07 11:56:03:
On va faire un update du @MANUAL.md@ à la main dans un premier temps

Generated at Sat Feb 10 15:30:38 JST 2024 using Jira 8.3.4#803005-sha1:1f96e09b3c60279a408a2ae47be3c745f571388b.