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

Bug 338578

Summary:	[docs] generate ECF 3.5 javadocs and move to eclipse.org
Product:	[RT] ECF	Reporter:	Scott Lewis <slewis>
Component:	ecf.doc	Assignee:	Scott Lewis <slewis>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	bugs.eclipse.org
Version:	3.4.0
Target Milestone:	3.5.0
Hardware:	PC
OS:	Windows XP
Whiteboard:
Bug Depends on:
Bug Blocks:	329124

Description Scott Lewis

2011-03-01 14:10:10 EST

Currently our build produces javadoc for the ECF sdk here:

https://build.ecf-project.org/jenkins/job/C-HEAD-sdk.feature/javadoc/

This content has to be completed (as much as possible prior to 3.5), and moved/committed to eclipse.org CVS repo...making it available via http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api

Comment 1 Scott Lewis

2011-03-01 14:13:23 EST

Setting target milestone to 3.5

Comment 2 Scott Lewis

2011-03-01 14:14:05 EST

Trying again to set target milestone :).

Comment 3 Scott Lewis

2011-03-01 14:26:12 EST

Assigning to myself.

Comment 4 Markus Kuppe

2011-03-03 10:10:21 EST

Why does the javadoc have to be checked into CVS? Can't we just make it available via download.eclipse.org?

Comment 5 Scott Lewis

2011-03-03 10:21:27 EST

(In reply to comment #4)
> Why does the javadoc have to be checked into CVS? Can't we just make it
> available via download.eclipse.org?

It has to be checked into CVS to appear here:

http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api/

Sure we can make it available via download.eclipse.org as well, but the above is both convenient and there are quite a lot of existing links to the API (e.g. from wiki docs, etc) that would be nice to maintain.

Comment 6 Markus Kuppe

2011-03-03 10:24:29 EST

We could just place a redirect at the original location pointing to download.eclipse.org. Saves us from checking into CVS during the build.

Comment 7 Scott Lewis

2011-03-03 10:37:21 EST

(In reply to comment #6)
> We could just place a redirect at the original location pointing to
> download.eclipse.org. Saves us from checking into CVS during the build.

Ok by me...as long as it works for the webmasters.

Comment 8 Markus Kuppe

2011-03-03 11:11:45 EST

Why should the webmasters bother?

Comment 9 Scott Lewis

2011-03-03 12:10:24 EST

(In reply to comment #8)
> Why should the webmasters bother?

To introduce the redirect.

Comment 10 Markus Kuppe

2011-03-04 00:04:55 EST

What I had in mind was a simple index.html using a meta redirect. That way the redirect is totally in our control.

Comment 11 Markus Kuppe

2011-03-04 01:46:39 EST

FWIW: javadoc/ is now gets copied to download.eclipse.org (e.g. http://download.eclipse.org/rt/ecf/3.5Test/javadoc/)

Comment 12 Scott Lewis

2011-03-04 09:47:17 EST

I've added a redirect in http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api/index.html so that it now goes to http://download.eclipse.org/rt/ecf/3.5Test/javadoc/index.html

One weakness with this approach is that existing links to http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api/<path>/<to>/<doc>.html files will still go to old versions (i.e. not the new/3.5 versions).  But, since I can't do any more on this now, we'll live with it.

Markus...how/when is new content generated and uploaded to download.eclipse.org?

Resolving as fixed.

Comment 13 Markus Kuppe

2011-03-04 09:54:33 EST

(In reply to comment #12)

> Markus...how/when is new content generated and uploaded to
> download.eclipse.org?

Every time we press the build button.