Jump to: navigation, search

Difference between revisions of "Project Management Infrastructure/Project Metadata"

m (Development Resources/HOWTO/Project Meta-Data moved to Project Management Infrastructure/Project Metadata: Functionality has been deprecated out of the developer portal.)
Line 1: Line 1:
== What is Project Meta-Data?==
+
== What is Project Metadata?==
# Relatively static structural information such as the names of the project's mailing lists and newsgroups, the bugzilla products and CVS repository, etc.
+
# Relatively static structural information such as the project description and scope, the names of the project's mailing lists and newsgroups, the bugzilla products, source code repositories, etc.
 
# Historical information such as previous release downloads, release review slides and IP logs, etc.
 
# Historical information such as previous release downloads, release review slides and IP logs, etc.
 
# Status and future looking information such as the project and milestone plans, the features scheduled for the current release, release dates, etc.
 
# Status and future looking information such as the project and milestone plans, the features scheduled for the current release, release dates, etc.
  
 
=== Who maintains it?===
 
=== Who maintains it?===
Eclipse committers and project leads are responsible for maintaining their project's meta-data. This information is an important part of being an Eclipse project.
+
Eclipse committers and project leads are responsible for maintaining their project's metadata. This information is an important part of being an Eclipse project.
 
+
=== How do I maintain my meta-data?===
+
Use the [http://portal.eclipse.org/ portal].  Look in Eclipse Projects > [view] > [maintain] Project 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.
+
 
+
{| cellpadding="10" cellspacing="0" border="1"
+
!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. <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.
+
|-
+
|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. <nowiki>http://www.eclipse.org/woolsey</nowiki>, <nowiki>http://eclipse.org/woolsey</nowiki>, or <nowiki>http://wiki.eclipse.org/Woolsey</nowiki>) or relative (e.g. <nowiki>/woolsey</nowiki>). 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.
+
|}
+
 
+
===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.
+
 
+
{| 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).
+
|-
+
|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. <nowiki>http://wiki.eclipse.org/Woolsey</nowiki>) 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 <nowiki>http://wiki.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>.
+
|-
+
|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 <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]].
+
|}
+
 
+
===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.
+
 
+
==Where is Project Metadata used?==
+
 
+
===/projects/ page===
+
<table border="1">
+
<tr><th>What</th><th>Data Storage w/ Link to How to Update</th></tr>
+
<tr>
+
<td>Project Name</td><td> <b>projectname</b> in the project meta data. Use the  [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Info Page</td><td>Standard format page for all projects</td></tr>
+
<tr><td>Phase</td><td> Foundation internal database. Email [mailto:emo@eclipse.org emo@]
+
</td></tr>
+
<tr><td>Home Page</td><td> <b>projecturl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Newsgroup</td><td> <b>newsgroup.name</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Mailing List</td><td> <b>mailinglist.name</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Wiki</td><td> <b>wikiurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
 
+
<tr><td>IP Log</td><td> <b>iplogurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
</table>
+
 
+
===Standard project information page===
+
E.g., [http://www.eclipse.org/projects/project_summary.php?projectid=technology.dash Project Dash's standard information page]
+
 
+
For those more visual people, there's also an [http://wiki.eclipse.org/Image:Standard-project-page-annotated.gif annotated screenshot] of a standard information page.
+
<table border="1">
+
<tr>
+
    <td>Name</td><td> Foundation internal database. Email [mailto:emo@eclipse.org emo@]
+
</td></tr>
+
<tr><td>Download</td><td> <b>downloadsurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Description</td><td> <b>descriptionurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
This is a single URL for an HTML file in your project's web directory that contains a description of the project, its goals and
+
perhaps its status. If the url points to an eclipse.org website page, we attempt to extract the midcolumn contents as the paragraph.</td></tr>
+
<tr><td>Logo</td><td> <b>logourl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Commits Activity</td><td> <b>sourcerepository</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Newsgroups</td><td> <b>newsgroup.*</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
 
+
<tr><td>Mailing Lists</td><td> <b>mailinglist.*</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Source Repository</td><td> <b>sourcerepository.*</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Committers</td><td> Foundation internal database. Email [mailto:emo@eclipse.org emo@].
+
Activity is taken from the [http://dash.eclipse.org/dash/commits/web-app/ commits explorer]
+
driven by <b>sourcerepository</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
<em>Active</em> is any commit activity in the last three months, <em>participating</em> is any
+
in the last nine months.
+
Company logos are shows for [http://www.eclipse.org/membership/ member companies]
+
of active committers.</td></tr>
+
 
+
<tr><td>Leaders</td><td> Foundation internal database. Email [mailto:emo@eclipse.org emo@]
+
</td></tr>
+
<tr><td>Update site</td><td> <b>updatesiteurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Releases</td><td> <b>release.*</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
Valid release status includes: scheduled, completed, tentative.</td></tr>
+
 
+
<tr><td>Bugs</td><td> <b>bugzilla</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Website</td><td> Foundation internal database. Email [mailto:emo@eclipse.org emo@]
+
</td></tr>
+
<tr><td>Wiki</td><td> <b>wikiurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
 
+
<tr><td>Documentation</td><td> <b>documentationurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Articles</td><td> <b>articleurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Project Plan</td><td> <b>projectplanurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Mentors</td><td> Set by Architecture Council members using the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
</table>
+
 
+
===Project Plan Page===
+
<table border="1">
+
<tr><td>Project Plan</td><td> <b>projectplanurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
        Also see the [[Development_Resources/Project_Plan|documentation]].</td></tr>
+
</table>
+
 
+
===Mailing Lists Page===
+
The eclipse.org [http://www.eclipse.org/mail list of mailing lists].
+
<table border="1">
+
<tr> <td>Mailing List</td><td> <b>mailinglist.*</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Topics</td><td> Foundation internal database. Email [mailto:emo@eclipse.org emo@]
+
</td></tr>
+
</table>
+
 
+
===Newsgroups Page===
+
The eclipse.org [http://www.eclipse.org/newsgroups/ list of newsgroups].
+
<table border="1">
+
<tr> <td>Newsgroup</td><td> <b>newsgroup.*</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Topics</td><td> Foundation internal database. Email [mailto:emo@eclipse.org emo@]
+
</td></tr>
+
</table>
+
 
+
===Timeline===
+
The eclipse.org [http://www.eclipse.org/projects/timeline/ timeline page].
+
<table border="1">
+
<tr>
+
<td>Releases</td><td> <b>release.*</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
Valid release status includes: scheduled, completed, tentative.</td></tr>
+
</table>
+
 
+
 
+
== 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 "[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 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.
+
 
+
== Using the Infrastructure==
+
<span style="margin-right:6px; margin-top:5px; float:left; color:ivory; background:#FF9999; border:1px solid #444; font-size:30px; line-height:25px; padding-top:2px; padding-left:2px; padding-right:2px; font-family:times; ">R</span>All projects are [http://www.eclipse.org/org/documents/Eclipse_Project_Requirements.html required] to use the standard left menu on the project home page. See the [http://www.eclipse.org/projects/dev_process/project-status-infrastructure/left-menu.php detailed, but easy, instructions] for how to make that left menu appear.
+
  
 
[[Category:Development_Resources]]
 
[[Category:Development_Resources]]
 
[[Category:How to Contribute]]
 
[[Category:How to Contribute]]
 +
[[Category:Project Metadata]]

Revision as of 17:20, 19 February 2013

What is Project Metadata?

  1. Relatively static structural information such as the project description and scope, the names of the project's mailing lists and newsgroups, the bugzilla products, source code repositories, etc.
  2. Historical information such as previous release downloads, release review slides and IP logs, etc.
  3. Status and future looking information such as the project and milestone plans, the features scheduled for the current release, release dates, etc.

Who maintains it?

Eclipse committers and project leads are responsible for maintaining their project's metadata. This information is an important part of being an Eclipse project.