search

eclipse-gemoc / gemoc-studio

gemoc-studio
Eclipse Public License 1.0
25 stars 22 forks source link

Split documentation accross repositories? #21

Open ebousse opened 7 years ago

ebousse commented 7 years ago

I propose to split the GEMOC documentation currently only stored in gemoc-studio, into each of the other repositories. The idea would be to bring documentation fragments closer to the code that implement the features that they describe.

For instance, the documentation about concurrency is currently in gemoc-studio, while concurrency is in another repository.

combemale commented 7 years ago

+1

-- Benoit Combemale http://combemale.fr

Le 19 oct. 2017 à 10:46, Erwan Bousse notifications@github.com a écrit :

I propose to split the GEMOC documentation currently only stored in gemoc-studio, into each of the other repositories. The idea would be to bring documentation fragments closer to the code that implement the features that they describe.

For instance, the documentation about concurrency is currently in gemoc-studio, while concurrency is in another repository.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

dvojtise commented 6 years ago

In addition the documentation should be able to grow "organically" instead of being monolitic Typically with a set of anchors such as http://help.eclipse.org/oxygen/topic/org.eclipse.platform.doc.isv/guide/ua_help_content_nested.htm?cp=2_0_19_1_1_4 . This allows the various contributors add content to these points instead of having to edit the main document.

Note we do need to have both online and eclipse help. currently we generate all from a central point but cannot directly take advantage of these anchors, an approach would be to mimic http://help.eclipse.org/oxygen/index.jsp and expose the eclipse help of the studio on the web (but the question is then how to setup a server for this jsp stuff)

dvojtise commented 6 years ago

question posted on https://dev.eclipse.org/mhonarc/lists/incubation/msg00566.html to get help on this subject. wait and see

dvojtise commented 6 years ago

some pointers: (good google keyword for search: Eclipse Infocenter ) about self hosting jsp server with a studio help system: