Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 480687

Summary:	Provide online help system for PolarSys working group
Product:	Community	Reporter:	Christophe Gatti <christophe.gatti>
Component:	Servers	Assignee:	Eclipse Webmaster <webmaster>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	denis.roy
Version:	unspecified
Target Milestone:	---
Hardware:	PC
OS:	Windows 7
Whiteboard:

Description Christophe Gatti

2015-10-26 13:08:06 EDT

Hi,

Soon, Capella will embed its documentation as Eclipse-help format. 
We would like to know if it could be possible to have a server help.polarsys.org as it is done for eclipse so that all projects from PolarSys could have their online documentation. 


Best regards,

Christophe.

Comment 1 Denis Roy

2015-10-26 16:07:40 EDT

+1, this should not be too complicated to set up.  As soon as you have doc plugins we can download, we'll install a headless Eclipse infocenter on Polarsys and add your plugins to it.

Comment 2 Christophe Gatti

2016-04-11 08:50:28 EDT

Hi Denis,

Documentation for Capella is available following this link: 

https://git.polarsys.org/c/capella/capella.git/tree/doc (master branch)

You will find all "Eclipse-help type" plugins in the "plugins" directory.

Could you setup everything so that we could have a "Capella" entry in doc.polarsys.org or help.polarsys.org or something like that? 

Then, we will have to discuss about when we could update it, and so on...


Best regards,

Christophe.

Comment 3 Denis Roy

2016-04-13 16:09:40 EDT

Hi Christophe, 

I have a basic infocenter running here:

http://help.polarsys.org/

Ideally, you would supply URLs to the jar files of the doc plugins.  I can pick them up from your downloads area.

When doc plugins are added, they are added to the Contents pane on the right.  See also: http://help.eclipse.org

From there, you can link to an entry. For instance, the Eclipse PHP docs are here:
http://help.eclipse.org/mars/topic/org.eclipse.php.help/html/index.html

Comment 4 Christophe Gatti

2016-04-14 04:22:36 EDT

Hi Denis,

Please find below the URLs to the jar files of the doc plugins for Capella 1.0.1:

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.commandline.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.diagrams.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.diffmerge.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.glossary.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.patterns.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.preferences.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.properties.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.re.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.transitions.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.ui.doc_1.0.0.2016-02-11_04-13-23.jar

https://hudson.polarsys.org/capella/job/capella-v1.0.x/73/artifact/result/publish/org.polarsys.capella/site.p2/plugins/org.polarsys.capella.validation.doc_1.0.0.2016-02-11_04-13-23.jar


Best regards,

Christophe.

Comment 5 Denis Roy

2016-04-14 15:49:33 EDT

I see a "Capella Guide" on http://help.polarsys.org.  Is that what you expect to see?

http://help.polarsys.org/help/topic/org.polarsys.capella.doc/html/toc.html?cp=1

Comment 6 Christophe Gatti

2016-04-15 03:59:28 EDT

Hi Denis,

Indeed, "Capella Guide" is the name we gave to the entry in the table of contents. 
Maybe we should change to just "Capella", it invites reflection.

Best regards and thanks, the result meets our expectations!

Comment 7 Denis Roy

2016-04-18 13:54:43 EDT

It's up to you. I cannot change it.

Let me know when you have major doc changes so we can update your plugins.