Add Feel++ Eye2brain apps documentation

Question

Add Feel++ Eye2brain apps documentation

prudhomm opened this issue 6 years ago · comments

Christophe Prud'homme commented 6 years ago

Eye2brain applications on MSO4SC need to be documented:

application purchase specificities
data mangement
experiments configuration
visualisation

lsala · Answer 1 · Thu May 24 2018 20:57:01 GMT+0800 (China Standard Time)

Sorry @prudhomm could you be a little bit more specific where do we have to write this documentation?
I know that the application is already described here: http://book.mso4sc.cemosis.fr/pilots/0.1/feelpp/eye2brain/README/

And if I understand correctly, the documentation you are asking for is related "how to run the application and how to visualize the results", isn't it?
Therefore don't we need to know (or at least I'm not acknowledged) how is portal working with the application that works on the web interface?

Guillaume Dollé · Answer 2 · Fri May 25 2018 05:38:03 GMT+0800 (China Standard Time)

@lsala The documentation will be related to the portal from an end-user/developer point of view (explain how to use app, how to visualize results using the portal, and a link to the eye2brain book for full math doc). This doc is more the description of the different pilots.

@prudhomm We should probably reorganize a bit the navigation to better distinguish the technical doc (someone who install the platform), the end-user doc (someone who buy and use app) and a developer doc (someone who provide and sell app). For now, I think we can add a user component, and a feelpp module https://github.com/MSO4SC/book.mso4sc.eu/tree/master/docs

(@prudhomm Shouldn't the two first points go in a private documentation (component) ?)

@prudhomm Maybe we could propose to the techboard a fast-short mutual mso4sc documentation sprint with other partners for the first week of june to prepare ECMI? (Then we should prepare all the required documentation (blank) pages with navs so that partners have just to click the edit button to contribute directly to the content from github, it'd simplify the process) What do you think ?

lsala · Answer 3 · Mon May 28 2018 21:34:33 GMT+0800 (China Standard Time)

Thank you @gdolle for the answer, however it is not clear to me how I can explain in a doc the work of the application on the portal if I don't know how I can access the portal - if it's ready - and how it works

Guillaume Dollé · Answer 4 · Wed May 30 2018 04:49:05 GMT+0800 (China Standard Time)

@lsala I understand. When I come back we can have a look at that together with @jbwahl if you want.
Also, we have to re-add eye2brain apps in the portal since the last update, so we can do both things all-together.

Christophe Prud'homme · Answer 5 · Wed May 30 2018 06:18:12 GMT+0800 (China Standard Time)

@lsala there are several assignees, you are one of them. I currently cannot use the portal :( but I hope to be able to use it for all our apps. We will need to contribute documentation that is seriously lacking on how to run our applications on the portal. the issue is an attempt to organize the work and get people on board.