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

Bug 215295

Summary:	[portal metadata to project summary mapping] How do you provide Description @ descriptionurl?
Product:	Community	Reporter:	Nick Boldt <nboldt>
Component:	Process	Assignee:	Bjorn Freeman-Benson <bjorn.freeman-benson>
Status:	RESOLVED FIXED	QA Contact:
Severity:	minor
Priority:	P2	CC:	bjorn.freeman-benson, denis.roy, karl.matthias, webmaster
Version:	unspecified
Target Milestone:	---
Hardware:	All
OS:	All
URL:	http://www.eclipse.org/projects/project_summary.php?projectid=modeling.emf
Whiteboard:

Description Nick Boldt

2008-01-14 23:25:24 EST

I **LOVE** the new project summary page [1]. Very cool!!

[1]http://www.eclipse.org/projects/project_summary.php?projectid=modeling.emf



              (waiting for the other show to drop...?)



However (saw that coming, eh?), I can't seem to figure out how to input the data for the project description.

I can input a descriptionurl, which I've done... but that doesn't appear in the project summary; instead, we see:

"No information has been provided by the project."

Checking the 'Explain' link next to the descriptionurl field in the portal, I'm directed to this page [2], which tells me that Description comes from descriptionurl, which is input via the portal. (Thanks, circular help system!) But there's no clue to the format of this file, or what's required for it to be parsed. Is it text? HTML? XML? 

[2]http://www.eclipse.org/projects/dev_process/project-status-infrastructure.php

So, per the request at the bottom of that page, I'm opening this bug. Let me reiterate how cool this new UI is -- I'm just looking to fill in the blanks in our metadata.

----

By the way...

"Here is the Project Release Timeline" and "Here is the project plan" are both missing a period (.) at the end of those sentences, for consistency w/ the other boxes.

And while I'm asking for help and enhancement... could the wiki link(s) be added to the 'Project Web Site' box?

Comment 1 Denis Roy

2008-01-15 13:30:33 EST

Phoenix has the same problem, and I just want to conform!  :-)

Ditto on the enthusiasm for the summary pages, BTW.  Love 'em.

Comment 2 Nick Boldt

2008-01-24 11:39:44 EST

Looks like some progress has been made here...

http://www.eclipse.org/modeling/mdt/project-info/executive-summary.html

maps directly to the Description field for

http://www.eclipse.org/projects/project_summary.php?projectid=modeling.mdt

as that's the doc mentioned in the portal's 'summary url' field.

However, 'summary url' is not (yet) mentioned here:

http://www.eclipse.org/projects/dev_process/project-status-infrastructure.php

Comment 3 Karl Matthias

2008-01-24 12:07:38 EST

Glad you guys like the project summary pages!  Admittedly we don't have enough documentation on the meta-data right now.  We're working on it.

What I think you've been seeing is some rather unclear logic in the code which looks first for 'descriptionurl' to be a fully-qualified HTTP URL.  Failing that, it checks if 'summaryurl' is fully-qualified.  Failing that, it tries to read the file in the relative web path for the project using the path in the 'descriptionurl' field.

This is really kind of an ugly workaround for projects which had data in one of those fields but not the other.  Ideally we would pick 'descriptionurl' and have everyone use that.

I'm going to say that's the recommended place to put this, and when our documentation is more developed that's what it will say, too.

Comment 4 Karl Matthias

2008-01-24 12:36:32 EST

I rigged up an image showing where all the fields come from.  I'll work with Bjorn to get this or something like it into the documentation.  It's here for now:

http://www.eclipse.org/projects/images/project_summary_doc.jpg

Comment 5 Bjorn Freeman-Benson

2008-02-05 02:30:27 EST

Re comment 3 - that wasn't actually how the code worked (I think there was a bug in there), so I cleaned up the logic and now it only uses descriptionurl.
Re comment 4 - I took your idea and made a full-fledged annotated graphic: http://www.eclipse.org/projects/dev_process/project-status-infrastructure-pic.php
I added the missing periods.

On the final item: could you open a new enhancement bugzilla for that and I'll whip it out - thanks.

Comment 6 Nick Boldt

2008-02-05 12:52:08 EST

(In reply to comment #5)
> > And while I'm asking for help and enhancement... could the wiki link(s) be
> > added to the 'Project Web Site' box?
> On the final item: could you open a new enhancement bugzilla for that and I'll
> whip it out - thanks.
 
You mean that one? OK, see bug 217871.