Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [cross-project-issues-dev] Feature names and descriptions

I've opened a new bug [1] to specifically track changes to the details page.

Suppressing source pages is a good idea. But it's not as big a problem as you might think. The JSON file I gave you is the contents of the repository. The packages themselves don't include everything you see there. The list of features that are already on the details pages (which includes very few "source" features) (e.g. [2]) will just be translated into human readable form.

You'll see in comment 2 on the new bug, that I've already suggested that we streamline the list of features in other ways.

Wayne

[1] https://bugs.eclipse.org/bugs/show_bug.cgi?id=408025
[2] http://eclipse.org/downloads/packages/eclipse-modeling-tools/junosr2

On 05/14/2013 10:53 AM, Eike Stepper wrote:
Hi Wayne,

I wonder if it would be possible (and make sense) to exclude the *.source features from the resulting pages.

Cheers
/Eike

----
http://www.esc-net.de
http://thegordian.blogspot.com
http://twitter.com/eikestepper



Am 14.05.2013 16:26, schrieb Wayne Beaton:
Chris is still working on it. He'll let us know when he has something to show us via Bug 404861 [1]. I'll update that
bug with this information.

In the meantime, I've attached the JSON dump of the information that Chris will be using to populate the page (generated
out of downloads/releases/kepler/201305100900/features/).

HTH,

Wayne

[1] https://bugs.eclipse.org/bugs/show_bug.cgi?id=404861

On 05/14/2013 05:49 AM, Oberhuber, Martin wrote:

Hi Wayne,

Can you provide a preview URL of the packages pages ?

That would greatly help understanding what the final thing will look like, and how my feature’s text blends with other
feature’s text.

Thanks,

Martin

--

*Martin Oberhuber*, SMTS / Product Architect – Development Tools, *Wind River*

direct +43.662.457915.85  fax +43.662.457915.6

*From:*cross-project-issues-dev-bounces@xxxxxxxxxxx [mailto:cross-project-issues-dev-bounces@xxxxxxxxxxx] *On Behalf
Of *Wayne Beaton
*Sent:* Monday, May 13, 2013 9:19 PM
*To:* cross-project-issues-dev@xxxxxxxxxxx
*Subject:* [cross-project-issues-dev] Feature names and descriptions

Greetings folks!

We're working on some updates to the packages pages. As part of this, we're going to display actual feature
information rather than just a bunch of ids.

e.g on the "details" page for the Eclipse IDE for Java EE Developers [1], instead of showing the feature id, "
org.eclipse.jdt", we'll show the feature label, "Eclipse Java development tools (binary runtime and user documentation).".

We haven't quite decided yet, but we may try to work in the description.

I've written a little script to extract this information directly from the features as they exist in the Kepler
repository.

I've done a quick review, and have found a few misspelling and some other odd things. Since this information is used
in other places, I think that it's pretty important to get it right.

For example, the description for "Acceleo" (org.eclipse.acceleo) is "Acceleo". I'm not sure that this provides anybody
with a compelling reason to install this feature.

There are several features with descriptions that seem to assume that the reader will know what it is based on the
project name (MoDisco, QVT, and some of the Mylyn subprojects stand out). IMHO, these descriptions should give me a
reason to look into the project and find out more.

There are inconsistencies in format as well. Some are a few words or a phrase, some are complete sentences, some are
short paragraphs, and some use bullets. I'm a fan of providing one or two sentences (no bullets or newlines) to
concisely describe the feature.

Please take a few minutes to look at your feature labels and descriptions to make sure that the information that
you're providing is helpful for your intended audience. Please take a few minutes to makes sure that the descriptions
use correct spelling and grammar.

Thanks,

Wayne


[1] http://eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/junosr2

--
Wayne Beaton
Director of Open Source Projects, The Eclipse Foundation <http://www.eclipse.org>
Learn about Eclipse Projects <http://www.eclipse.org/projects>
EclipseCon France 2013 <http://www.eclipsecon.org/france2013>



_______________________________________________
cross-project-issues-dev mailing list
cross-project-issues-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev

--
Wayne Beaton
Director of Open Source Projects, The Eclipse Foundation <http://www.eclipse.org>
Learn about Eclipse Projects <http://www.eclipse.org/projects>
EclipseCon France 2013 <http://www.eclipsecon.org/france2013>


_______________________________________________
cross-project-issues-dev mailing list
cross-project-issues-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev


_______________________________________________
cross-project-issues-dev mailing list
cross-project-issues-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev


--
Wayne Beaton
Director of Open Source Projects, The Eclipse Foundation
Learn about Eclipse Projects
EclipseCon
          France 2013

Back to the top