|Paragraph || paragraphurl || This is a single URL for an HTML file in your project's web directory that contains a concise (e.g., 50 word) description of your project. The content of this file is intended to be aggregated with other project paragraphs in lists (e.g., release train projects, top-level project summary lists, ...). Keep the content as simple as possible (i.e. avoid left- or right-aligned images, div tags, etc.). The goal is to motivate readers to identify your project as interesting, not convey deep technical content. You may specify the URL as absolute (e.g. <nowiki>http://www.eclipse.org/woolsey/description.html</nowiki>) or relative to the web root (e.g. /woolsey/description.html). Note that however you choose to specify this value, the resulting URL must be relative to <nowiki>http://www.eclipse.org/</nowiki>.

+

|Paragraph || paragraphurl || This is a single URL for an HTML file in your project's web directory that contains a concise (e.g., 50-100 word) description of your project. The content of this file is intended to be aggregated with other project paragraphs in lists (e.g., release train projects, top-level project summary lists, ...). Keep the content as simple as possible (i.e. avoid left- or right-aligned images, div tags, lists, etc.). The goal is to motivate readers to identify your project as interesting, not convey deep technical content. You may specify the URL as absolute (e.g. <nowiki>http://www.eclipse.org/woolsey/description.html</nowiki>) or relative to the web root (e.g. /woolsey/description.html). Note that however you choose to specify this value, the resulting URL must be relative to <nowiki>http://www.eclipse.org/</nowiki>.

+

|-

+

|Description || descriptionurl || This is a single URL for an HTML file in your project's web directory that contains a short (e.g. 2-3 paragraph) description of your project. The content of this file is used, for example, in on the project summary page for your project. Keep the content as simple as possible (i.e. avoid left- or right-aligned images, div tags, etc.). The goal is to motivate readers to identify your project as interesting, not convey deep technical content. You may specify the URL as absolute (e.g. <nowiki>http://www.eclipse.org/woolsey/description.html</nowiki>) or relative to the web root (e.g. /woolsey/description.html). Note that however you choose to specify this value, the resulting URL must be relative to <nowiki>http://www.eclipse.org/</nowiki>.

|-

|-

|Short name || projectshortname || This is the short name (aka nickname) for your project. For example, the projectname for ECF might be Eclipse Communications Framework whereas the shortname would be ECF.

|Short name || projectshortname || This is the short name (aka nickname) for your project. For example, the projectname for ECF might be Eclipse Communications Framework whereas the shortname would be ECF.

Line 28:

Line 30:

|-

|-

|Download || downloadsurl || This is a single URL that points to the project's downloads. The link can be to any eclipse.org property. Relative links are assumed to be relative to <nowiki>http://www.eclipse.org</nowiki>.

|Download || downloadsurl || This is a single URL that points to the project's downloads. The link can be to any eclipse.org property. Relative links are assumed to be relative to <nowiki>http://www.eclipse.org</nowiki>.

+

|-

+

|Source Repository || sourcerepository || Multiple entries can be provided for the source repository. As the name suggests, this field lists the locations of the repositories that hold the source for your project. This information is used to inform your community of the location of these resources, but also to feed the Dash tools concerned with gathering commit statistics. Git repositories are specified using any valid Git URL (Git URLs must be relative to git.eclipse.org). CVS locations are e.g. /cvsroot/technology/org.eclipse.buckminster. SVN locations are e.g. /technology/org.eclipse.buckminster.

|}

|}

Line 35:

Line 39:

{| cellpadding="10" cellspacing="0" border="1"

{| cellpadding="10" cellspacing="0" border="1"

+

!Name !! Field !! Description

+

|-

|Newsgroups || newsgroup || You can specify multiple newsgroups. This information is used to inform your community of the newsgroups and forums available for your project (the same information is used to render links to both newsgroups and forums). For each newsgroup/forum, you specify the name, optional description, and type. The name is as it appears on the news server (e.g. eclipse.woolsey). A short description will help visitors decide which newsgroup or forum to visit and so it is highly recommended that you provide a value here. Generally a project will have a single "main" newsgroup/forum. This information is used when rendering newsgroups (in cases where there is only room to list one, the main newsgroup/forum is listed).

|Newsgroups || newsgroup || You can specify multiple newsgroups. This information is used to inform your community of the newsgroups and forums available for your project (the same information is used to render links to both newsgroups and forums). For each newsgroup/forum, you specify the name, optional description, and type. The name is as it appears on the news server (e.g. eclipse.woolsey). A short description will help visitors decide which newsgroup or forum to visit and so it is highly recommended that you provide a value here. Generally a project will have a single "main" newsgroup/forum. This information is used when rendering newsgroups (in cases where there is only room to list one, the main newsgroup/forum is listed).

|-

|-

Line 42:

Line 48:

|-

|-

|Docs || documentationurl || This is a single URL that points to the project's documentation. Typically this is a link into <nowiki>http://help.eclipse.org</wiki> (e.g. <nowiki>http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.egit.doc/help/EGit/User_Guide/User-Guide.html</nowiki>, but the link can be to any eclipse.org property. Relative links are assumed to be relative to <nowiki>http://www.eclipse.org</nowiki>.

|Docs || documentationurl || This is a single URL that points to the project's documentation. Typically this is a link into <nowiki>http://help.eclipse.org</wiki> (e.g. <nowiki>http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.egit.doc/help/EGit/User_Guide/User-Guide.html</nowiki>, but the link can be to any eclipse.org property. Relative links are assumed to be relative to <nowiki>http://www.eclipse.org</nowiki>.

+

|}

+

+

===More===

+

{| cellpadding="10" cellspacing="0" border="1"

+

!Name !! Field !! Description

+

|-

+

|Logo || logourl || A single URL that points to a file containing the logo for your project.

+

|-

+

|Update site || updatesiteurl || This value is a single URL that points to your project's main update site. The URL must be relative to <nowiki>http://download.eclipse.org/</nowiki>.

|Articles || articleurl || Specify multiple URLs to articles and other interesting links that reference your project. URLs are not restricted (i.e. you can link to articles posted outside of <nowiki>eclipse.org</nowiki>). Relative URLs are assumed to be relative to <nowiki>http://eclipse.org/</nowiki>

+

|-

+

|Project Plan || projectplanurl || This is a single URL that points to an XML file containing your project plan in the [[Development Resources/Project Plan | standard format]].

|}

|}

Line 160:

Line 183:

−

== When is project status information considered out-of-date?==

+

== When is project metadata considered out-of-date?==

−

Different kinds of information go out of date at different rates and times, but here's an easy checklist:

+

Project metadata is out-of-date if it does not match the infrastructure. For example, if the project has added a new project-announce@ mailing list, but the project metadata does not list that mailing list, then they are out of date.

−

* All structural status information is out-of-date if it does not match the infrastructure. For example, if the project has added a new project-announce@ mailing list, but the project status files do not list that mailing list, then they are out of date.

+

−

* Status summaries must be updated at least once a quarter. It's better to update them once a month.

+

Project metadata should be reviewed regularly; we recommend that it be updated at least once a quarter. Historical information (downloads, release information, and so on) should be updated with each release.

Eclipse projects belong to a larger community - Eclipse - which is comprised of not only the committers and developers on the project, but also the developers on other projects, plug-in developers outside the Eclipse projects, and the entire ecosystem surrounding Eclipse. In order to keep all these people up-to-date on the direction and status of the Eclipse projects, each project

+

Eclipse projects belong to a larger community - Eclipse - which is comprised of not only the committers and developers on the project, but also the developers on other projects, plug-in developers outside the Eclipse projects, and the entire ecosystem surrounding Eclipse. In order to keep all these people up-to-date on the direction and status of the Eclipse projects, each project needs to provide timely and accurate descriptive and project information. (See "[http://www.eclipse.org/projects/dev_process/development_process.php#2_4_Eclipse_Ecosystem 2.4 Eclipse Ecosystem]" in the Eclipse Development Process.)

−

needs to provide timely and accurate descriptive and status information. (See "[http://www.eclipse.org/projects/dev_process/development_process.php#2_4_Eclipse_Ecosystem 2.4 Eclipse Ecosystem]" in the Eclipse Development Process.)

+

−

The project status information drives a number of the eclipse.org web pages including [http://www.eclipse.org/ the categories on the home page], [http://www.eclipse.org/projects/dashboard/ the dashboard], [http://www.eclipse.org/projects/timeline/ the timeline], [http://www.eclipse.org/projects/ lists of projects], lists of [http://www.eclipse.org/mail/ mailing lists] and [http://www.eclipse.org/newsgroups/ newsgroups], status pages, and more.

+

The project metadata drives a number of the eclipse.org web pages including [http://www.eclipse.org/projects/listofprojects.php the project list], [http://www.eclipse.org/projects/timeline/ the timeline], [http://www.eclipse.org/projects/project.php?id=tools.cdt project summary/info pages], [http://www.eclipse.org/mail/ mailing lists], and more.

How do I maintain my meta-data?

What Meta-Data Do you Need to Provide?

In this section, we describe the many fields that you'll find in the portal.

Basic Information

You should minimally provide the following information for your project.

Name

Field

Description

Paragraph

paragraphurl

This is a single URL for an HTML file in your project's web directory that contains a concise (e.g., 50-100 word) description of your project. The content of this file is intended to be aggregated with other project paragraphs in lists (e.g., release train projects, top-level project summary lists, ...). Keep the content as simple as possible (i.e. avoid left- or right-aligned images, div tags, lists, etc.). The goal is to motivate readers to identify your project as interesting, not convey deep technical content. You may specify the URL as absolute (e.g. http://www.eclipse.org/woolsey/description.html) or relative to the web root (e.g. /woolsey/description.html). Note that however you choose to specify this value, the resulting URL must be relative to http://www.eclipse.org/.

Description

descriptionurl

This is a single URL for an HTML file in your project's web directory that contains a short (e.g. 2-3 paragraph) description of your project. The content of this file is used, for example, in on the project summary page for your project. Keep the content as simple as possible (i.e. avoid left- or right-aligned images, div tags, etc.). The goal is to motivate readers to identify your project as interesting, not convey deep technical content. You may specify the URL as absolute (e.g. http://www.eclipse.org/woolsey/description.html) or relative to the web root (e.g. /woolsey/description.html). Note that however you choose to specify this value, the resulting URL must be relative to http://www.eclipse.org/.

Short name

projectshortname

This is the short name (aka nickname) for your project. For example, the projectname for ECF might be Eclipse Communications Framework whereas the shortname would be ECF.

Homepage

projecturl

This is a single URL that points to your project's main page. The link can be to any eclipse.org property. Links can be absolute (e.g. http://www.eclipse.org/woolsey, http://eclipse.org/woolsey, or http://wiki.eclipse.org/Woolsey) or relative (e.g. /woolsey). Relative links are assumed to be relative to http://www.eclipse.org.

Download

downloadsurl

This is a single URL that points to the project's downloads. The link can be to any eclipse.org property. Relative links are assumed to be relative to http://www.eclipse.org.

Source Repository

sourcerepository

Multiple entries can be provided for the source repository. As the name suggests, this field lists the locations of the repositories that hold the source for your project. This information is used to inform your community of the location of these resources, but also to feed the Dash tools concerned with gathering commit statistics. Git repositories are specified using any valid Git URL (Git URLs must be relative to git.eclipse.org). CVS locations are e.g. /cvsroot/technology/org.eclipse.buckminster. SVN locations are e.g. /technology/org.eclipse.buckminster.

Community Contact Information

Be sure to provide information about your project's newsgroups, mailing lists, and more so that your community will know where to find you.

Name

Field

Description

Newsgroups

newsgroup

You can specify multiple newsgroups. This information is used to inform your community of the newsgroups and forums available for your project (the same information is used to render links to both newsgroups and forums). For each newsgroup/forum, you specify the name, optional description, and type. The name is as it appears on the news server (e.g. eclipse.woolsey). A short description will help visitors decide which newsgroup or forum to visit and so it is highly recommended that you provide a value here. Generally a project will have a single "main" newsgroup/forum. This information is used when rendering newsgroups (in cases where there is only room to list one, the main newsgroup/forum is listed).

Mailing Lists

mailinglist

You can specify multiple mailing lists. This information is used to inform your community of the mailing lists available for your project. For each mailing list, you specify the name, optional description, and type. The name is specified without the domain (e.g. woolsey-dev). A short description will help visitors decide which mailing list to use and so it is highly recommended that you provide a value here. Generally a project will have a single "main" mailing list. This information is used when rendering mailing lists (in cases where there is only room to list one, the main mailing list is listed).

Wiki

wikiurl

This is a link to the project's landing page in the wiki. You may specify the URL as absolute (e.g. http://wiki.eclipse.org/Woolsey) or relative to the wiki root (e.g. /Woolsey). Note that however you choose to specify this value, the resulting URL must be relative to http://wiki.eclipse.org/.

Docs

documentationurl

This is a single URL that points to the project's documentation. Typically this is a link into http://help.eclipse.org</wiki> (e.g. <nowiki>http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.egit.doc/help/EGit/User_Guide/User-Guide.html, but the link can be to any eclipse.org property. Relative links are assumed to be relative to http://www.eclipse.org.

More

Name

Field

Description

Logo

logourl

A single URL that points to a file containing the logo for your project.

Update site

updatesiteurl

This value is a single URL that points to your project's main update site. The URL must be relative to http://download.eclipse.org/.

Releases

release

Projects are required to make an entry for each release. Valid release status includes: scheduled, completed, tentative.

Bugs

bugzilla

Specify a Product Name, Component Name and URL for your project's bugs.

Articles

articleurl

Specify multiple URLs to articles and other interesting links that reference your project. URLs are not restricted (i.e. you can link to articles posted outside of eclipse.org). Relative URLs are assumed to be relative to http://eclipse.org/

Project Plan

projectplanurl

This is a single URL that points to an XML file containing your project plan in the standard format.

Inheritence

Currently sub-projects/components can inherit from their parent project by setting the "Inherit" key in the meta-data editor. This special key will cause web pages and other places where the meta-data is used, to override all values other than the projectname key. This is typically used for very small projects or components which do not need to maintain much information.

Activity is taken from the commits explorer
driven by sourcerepository in the project meta data. Use the portal.
Active is any commit activity in the last three months, participating is any
in the last nine months.
Company logos are shows for member companies

Timeline

When is project metadata considered out-of-date?

Project metadata is out-of-date if it does not match the infrastructure. For example, if the project has added a new project-announce@ mailing list, but the project metadata does not list that mailing list, then they are out of date.

Project metadata should be reviewed regularly; we recommend that it be updated at least once a quarter. Historical information (downloads, release information, and so on) should be updated with each release.

Why is project metadata information important?

Eclipse projects belong to a larger community - Eclipse - which is comprised of not only the committers and developers on the project, but also the developers on other projects, plug-in developers outside the Eclipse projects, and the entire ecosystem surrounding Eclipse. In order to keep all these people up-to-date on the direction and status of the Eclipse projects, each project needs to provide timely and accurate descriptive and project information. (See "2.4 Eclipse Ecosystem" in the Eclipse Development Process.)