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

Bug 236777

Summary: Will soon need a Ganymede Info Center
Product: Community Reporter: David Williams <david_williams>
Component: Cross-ProjectAssignee: Cross-Project issues <cross-project.inbox>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: ahunter.eclipse, bluesoldier, cdtdoug, ddykstal.eclipse, give.a.damus, greensopinion, jcayne, john.arthorne, kim.moir, lucas.bigeardel, moride.shigeki, nboldt, oisin.hurley, pnehrer, richard.gronback, ruediger.herrmann, slewis, steffen.pingel, webmaster
Version: unspecified   
Target Milestone: ---   
Hardware: PC   
OS: Windows XP   
Whiteboard:
Attachments:
Description Flags
WTP's script to copy doc jars to ganymede info center none

Description David Williams CLA 2008-06-11 22:29:33 EDT
Similar to 
http://help.eclipse.org/help33/index.jsp 

But, it would be preferable to not use numbers in the URL, and use "ganymede" instead. That's consistent with the goals and philosophy of the yearly simultaneous release. 

In past years, we've opened a bug, like this one, to attach the documentation jars, or, to provide the webmasters with a location from which to copy them. 

I thought I'd open this bug now, so we could start getting ready ... maybe start "building it up" when projects are fairly sure they have their final build. It be nice to have it ready on the simultaneous release date. 

thanks,
Comment 1 John Arthorne CLA 2008-06-12 10:42:55 EDT
+1 for "ganymede" in the URL rather than "eclipse33". This was always strange because most of the projects in the train don't have the "3.3" version number.
Comment 2 Denis Roy CLA 2008-06-12 10:47:13 EDT
+1 for help.eclipse.org/ganymede as well.  Good thinking.
Comment 3 Anthony Hunter CLA 2008-06-20 13:57:30 EDT
For GEF

org.eclipse.draw2d.doc.isv
org.eclipse.gef.doc.isv

For GMF

org.eclipse.gmf.doc.isv

all on the ganymede update site.

+1 for help.eclipse.org/ganymede as well.
Comment 4 Kim Moir CLA 2008-06-20 14:17:03 EDT
in directory
kmoir@node1:/home/data/httpd/download.eclipse.org/releases/ganymede/staging/plugins> org.eclipse.jdt.doc.user_3.4.0.v20080612-1340.jar
org.eclipse.pde.doc.user_3.3.0.v20080611-1530.jar
org.eclipse.platform.doc.user_3.4.0.v20080612-1340.jar

There is also the jdt.doc.isv and platform.doc.isv but we don't provide source features to Ganymede.
Comment 5 Joel Cayne CLA 2008-06-20 14:24:34 EDT
TPTP help is available at http://archive.eclipse.org/tptp/4.5.0/doc/tptp.helpdoc.zip for inclusion.

+1 for help.eclipse.org/ganymede
Comment 6 Richard Gronback CLA 2008-06-20 15:41:14 EDT
(In reply to comment #3)
> For GMF
>
> org.eclipse.gmf.doc.isv

Actually, for GMF it's just org.eclipse.gmf.doc and can be gotten from here: http://ganymede-mirror1.eclipse.org/modeling/gmf/updates/milestones/plugins/org.eclipse.gmf.doc_1.2.0.v20080516-1143.jar

+1 for /ganymede
Comment 9 David Williams CLA 2008-06-21 04:54:00 EDT
Created attachment 105573 [details]
WTP's script to copy doc jars to ganymede info center

Sample script, to provide one way to copy all the WTP docs to the site of your choosing. 

Of course, feel free to Not use the script ... I'm sure you have your own ideas for "final Milestone script". 

Let me know fi any questions.
Comment 10 David Williams CLA 2008-06-21 22:55:36 EDT
(In reply to comment #4)

> 
> There is also the jdt.doc.isv and platform.doc.isv but we don't provide source
> features to Ganymede.
> 

Oh? Since when ... I like it! 

But, I think you mean "we don't provide source features to Ganymede update site". 

I assume you do still contribute them to "the Ganymede Simultaneous Release" and thus would still be part of this central info center. Right? 


Comment 14 Scott Lewis CLA 2008-06-23 10:46:53 EDT
For ECF

In directory slewis@node2 /home/data/users/slewis/downloads/technology/ecf/ganymede-update/plugins

org.eclipse.ecf.doc_1.3.0.v20080623-0046.jar
Comment 15 Kim Moir CLA 2008-06-23 10:50:45 EDT
regarding comment #10

Yes, I meant "we don't provide source features to Ganymede update
site"

The other update jars are 
org.eclipse.jdt.doc.isv_3.4.0.v20080612-1340.jar  org.eclipse.platform.doc.isv_3.4.0.v20080613-1330.jar

The are in 
http://download.eclipse.org/eclipse/testUpdates/plugins/

Tomorrow they will be in 
http://download.eclipse.org/eclipse/updates/3.4/plugins/
Comment 17 Doug Schaefer CLA 2008-06-23 11:25:43 EDT
The CDT user docs are here:

   org.eclipse.cdt.doc.user_5.0.0.200806171202

Thanks!
Comment 18 Nick Boldt CLA 2008-06-23 11:26:40 EDT
+1 for /help34 as a redirect to /ganymede so both will work.

--

For EMF, SDO & XSD:

/home/data/httpd/download.eclipse.org/modeling/emf/updates/milestones/plugins/
org.eclipse.xsd.doc_2.4.0.v200806091234.jar
org.eclipse.emf.doc_2.4.0.v200806091234.jar
org.eclipse.emf.ecore.sdo.doc_2.4.0.v200806091234.jar

For Net4j, CDO & Teneo:

/home/data/httpd/download.eclipse.org/modeling/emf/updates/milestones/plugins/
org.eclipse.emf.cdo.doc_1.0.0.v200806180411.jar
org.eclipse.emf.teneo.doc_1.0.0.v200806111928.jar
org.eclipse.net4j.doc_1.0.0.v200806180305.jar

For 4 projects from EMFT in Ganymede:

/home/data/httpd/download.eclipse.org/modeling/emft/updates/milestones/plugins/
org.eclipse.emf.compare.doc_0.8.0.v200806180301.jar
org.eclipse.emf.ecoretools.doc_0.8.0.v200806130600.jar
org.eclipse.emf.mint.doc_0.7.0.v200806172223.jar
org.eclipse.emf.search.doc_0.7.0.v200806130939.jar

For M2T:

/home/data/httpd/download.eclipse.org/modeling/m2t/updates/milestones/plugins/
org.eclipse.jet.doc_0.9.0.v20080522.jar

For M2M:

/home/data/httpd/download.eclipse.org/modeling/m2m/updates/milestones/plugins/
org.eclipse.m2m.atl.doc_2.0.0.v200806101117.jar
org.eclipse.m2m.qvt.oml.doc_1.0.0.v20080611-1330.jar

For MDT (OCL mentioned above):

/home/data/httpd/download.eclipse.org/modeling/mdt/updates/milestones/plugins/
org.eclipse.uml2.doc_2.2.0.v200805201350.jar
Comment 20 Shigeki Moride CLA 2008-06-23 21:19:05 EDT
For DSDP-NAB:
/home/data/httpd/download.eclipse.org/dsdp/nab/updates/plugins/org.eclipse.nab.mwt.doc_0.9.6.200806181757.jar
Comment 21 Eclipse Webmaster CLA 2008-06-24 10:04:28 EDT
After copying over all of the jar files on this bug I've started the infocenter on help.eclipse.org/ganymede.  Everything looks ok from here.

-M.
Comment 22 Denis Roy CLA 2008-06-24 10:19:08 EDT
Might want to give this page an update too:

http://www.eclipse.org/documentation

Comment 24 Eclipse Webmaster CLA 2008-06-24 10:38:53 EDT
I've added the STP jar files and updated the documentation page.

-M.
Comment 25 Steffen Pingel CLA 2008-06-24 16:04:53 EDT
I currently don't see Mylyn in the table of contents. Should that be picked automatically by the page (jar link is on comment 19)?
Comment 26 Eclipse Webmaster CLA 2008-06-24 16:21:20 EDT
I've restarted the infocenter, but mylyn still fails to appear in the index.  The jar is in the right place and has the right permissions:

build:# ls -Fla org.eclipse.mylyn.help.ui_3.0.0.v20080619-1900.jar
-rw-r----- 1 wwwrun www 890638 Jun 24 10:00 org.eclipse.mylyn.help.ui_3.0.0.v20080619-1900.jar

-M.
Comment 27 Steffen Pingel CLA 2008-06-24 16:41:28 EDT
Thanks Denis. I checked the plug-in and it appears that the toc.xml file is in a doc/ folder which probably causes it to not get picked up by the help system. We'll retry contributing Mylyn documentation for the next update of the release train...
Comment 28 Steffen Pingel CLA 2008-06-24 16:42:22 EDT
Args. Thanks Matt!
Comment 29 Denis Roy CLA 2008-06-27 16:12:17 EDT
Matt, how about we wrap up this bug:

1. Make /ganymede the default redirect for 'help.eclipse.org'

2. Add the 'Latest Release' banner you see here, which includes the Eclipse logo:
http://help.eclipse.org/help33/index.jsp

3. Change the 'Latest release' banner for 3.3, above, to 'Archived Release' as seen here:
http://help.eclipse.org/help32/index.jsp

4. Retire 3.1 help, http://help.eclipse.org/help31/index.jsp
--> Add a redirect to /help31* to www.eclipse.org/documentation
Comment 30 Eclipse Webmaster CLA 2008-07-07 14:20:49 EDT
Ok,  1,3 and 4 are done.  Item 2 is proving to be difficult, even after getting some good advice from Chris at IBM, I still cannot get the banner to update on the test server.

-M.
Comment 31 Eclipse Webmaster CLA 2008-07-11 10:00:27 EDT
Ok so thanks to some more advice from Chris and his discussion with the p2 team I've managed to build a custom plugin that alters the banner for the Ganymede infocenter as requested in comment #29.

-M.
Comment 32 Denis Roy CLA 2008-07-11 10:03:33 EDT
(In reply to comment #31)
> Ok so thanks to some more advice from Chris and his discussion with the p2 team
> I've managed to build a custom plugin that alters the banner for the Ganymede
> infocenter as requested in comment #29.

IMHO it really shouldn't be that difficult to create a custom banner for help.  I suggest you open a bug against Platform/UA requesting either a simplification of this process, or better docs, then post the bug number back here for reference.
Comment 33 Nick Boldt CLA 2008-07-11 11:18:33 EDT
(In reply to comment #31)
> Ok so thanks to some more advice from Chris and his discussion with the p2 team
> I've managed to build a custom plugin that alters the banner for the Ganymede
> infocenter as requested in comment #29.

We seem to have some mixed branding going on here. This bug refers to help.eclipse.org as "Info Center", but the help.eclipse.org landing page calls itself "Eclipse documentation" and talks about using the "Eclipse help system"

Admittedly all three refer to the same thing, but shouldn't we be consistent? 
Comment 34 Eclipse Webmaster CLA 2008-07-11 14:43:58 EDT
Ok, I've filed bug 240527 asking for either updated docs or a better way to specify a custom banner.

-M.
Comment 35 Peter Nehrer CLA 2008-09-28 22:47:34 EDT
Shouldn't documentation updates from Ganymede SR1 show up in the Infocenter? It doesn't look like it's been updated/restarted.
Comment 36 David Williams CLA 2009-04-05 00:37:29 EDT
(In reply to comment #35)
> Shouldn't documentation updates from Ganymede SR1 show up in the Infocenter? It
> doesn't look like it's been updated/restarted.
> 

And now SR2? I do not know of any specific issues, but would be nice if a utility or script could be written that was "smart" enough to rsync any "new" information bundles (at any point in time). 

To make this happen, though, projects would have to supply a "final" location to copy from (I see some of these provided are from "staging" sites ... which makes sense for pre-release bundles). 

And, projects would have to provide a reasonable "copy" pattern that would match all potential updates, such as 
.../org.eclipse.jdt.doc.user_3.4.*.jar
(though I'm not even sure how to write such a pattern, is is regex, or just "*" matches anything)

If no one is volunteers to write that script, I suggest we close this bug, and request people open specific bug when they see specific problems, or need specific files updated. 

Comment 37 Steffen Pingel CLA 2009-04-06 06:26:25 EDT
We have restructered the Mylyn docs to work with the web-based help system. 

Webmasters, could you try adding the latest Mylyn help plug-ins again:

http://download.eclipse.org/tools/mylyn/update/e3.4/plugins/org.eclipse.mylyn.help.ui_3.1.0.v20090315-1500-e3x.jar
http://download.eclipse.org/tools/mylyn/update/e3.4/plugins/org.eclipse.mylyn.wikitext.ui_1.0.0.v20090315-1500-e3x.jar
Comment 38 Eclipse Webmaster CLA 2009-04-07 10:38:45 EDT
I've added the Mylyn doc plugins and restarted the infocenter and things look ok.

I'm going to close this bug(as the infocenter is up and running), and suggest that a new bug should be opened requesting an update to the SR2 docs.

-M.
Comment 39 David Green CLA 2009-04-07 12:17:49 EDT
Looks like the Mylyn feature reference was added but not the WikiText User Guide, which should appear under "Tasks" in the table of contents.  It's contributed by this plug-in:

http://download.eclipse.org/tools/mylyn/update/e3.4/plugins/org.eclipse.mylyn.wikitext.ui_1.0.0.v20090315-1500-e3x.jar
Comment 40 Eclipse Webmaster CLA 2009-04-07 13:08:41 EDT
I added both of the plugins listed in comment #27.

/home/data/httpd/help.eclipse.org/ganymede/eclipse/plugins> ls -fla | grep mylyn
-rw-r-----  1 wwwrun www  1798326 2009-04-07 10:28 org.eclipse.mylyn.help.ui_3.1.0.v20090315-1500-e3x.jar
-rw-r-----  1 wwwrun www  1357016 2009-04-07 10:28 org.eclipse.mylyn.wikitext.ui_1.0.0.v20090315-1500-e3x.jar

Perhaps there is a bug in the Wikitext plugin?

-M.
Comment 41 David Green CLA 2009-04-07 13:22:22 EDT
Could it be that the infocenter doesn't load plug-ins that have dependencies on things like org.eclipse.ui?
Comment 42 Denis Roy CLA 2009-04-07 15:26:10 EDT
(In reply to comment #41)

This is entirely possible, as the infocenter runs as a dedicated, headless server.  Can you decouple them?
Comment 43 David Green CLA 2009-04-21 23:29:10 EDT
(In reply to comment #42)
> This is entirely possible, as the infocenter runs as a dedicated, headless
> server.  Can you decouple them?

I've decoupled them and confirmed that the WikiText help can load from within the help center web application.  Any chance of getting this one deployed?

For Mylyn WikiText http://download.eclipse.org/tools/mylyn/update/weekly/e3.4/plugins/org.eclipse.mylyn.wikitext.help.ui_1.1.0.I20090410-1800-e3x.jar
Comment 44 Eclipse Webmaster CLA 2009-04-22 09:46:26 EDT
I've added the new Mylyn plugin and the wikitext help seems to be under the 'Tasks User guide' is that correct?

-M.
Comment 45 David Green CLA 2009-04-22 10:46:56 EDT
(In reply to comment #44)
> I've added the new Mylyn plugin and the wikitext help seems to be under the
> 'Tasks User guide' is that correct?

Thanks, that's fabulous.  I know that having WikiText under Tasks User Guide is a little odd.  I'm hoping to have that changed for Mylyn 3.2
Comment 46 David Green CLA 2009-04-22 10:49:33 EDT
Interestingly if you search for 'Mylyn' or 'WikiText' there are no results.  Is there a way to rebuild the search index?
Comment 47 Eclipse Webmaster CLA 2009-04-22 13:09:33 EDT
Hmmm, I get results for both wikitext and mylyn in the search.

-M.
Comment 48 David Green CLA 2009-04-22 14:36:52 EDT
Oops! it seems that I had a search scope defined.  Sorry for your trouble, and thanks very much!