Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

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

m ((4) Why is project status information important?)
 
(70 intermediate revisions by 7 users not shown)
Line 1: Line 1:
===(1) Using the Infrastructure===
+
This page's content has been moved to the [https://www.eclipse.org/projects/handbook/#pmi-metadata Eclipse Project Handbook].
<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.
+
  
===(2) What Meta-Data Does What===
+
==Use the Generated Content for Your Project Home Page==
The project meta-data is maintained by project committers via the portal. Missing information on various eclipse.org website pages are caused either (a) by the project not providing the meta-data, or (b) by the project not having an instance of that resource.
+
  
====/projects/ page====
+
If you want to use this page as your project home page, change the contents of your project's ''index.php'' file to:
<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].
+
<?php
</td></tr>
+
header("Location: http://projects.eclipse.org/projects/your.project.id");
</table>
+
?>
  
====Standard project information page====
+
(with an appropriate substitution of ''your.project.id'', e.g. technology.egit, of course).
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.
+
Note that the automatically-generated pages will continue to grow, change, and be updated.
<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].
+
Should be an html paragraph or two (recommended).
+
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].
+
==Where is Project Metadata Used==
</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].
+
Project metadata is used in a few different places today, and usage will continue to expand. Below are a few examples.
</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@]
+
* Projects using  [http://projects.eclipse.org/build-technology/tycho Tycho], or [https://projects.eclipse.org/build-technology/maven Maven]. The description and project logo are used here.
</td></tr>
+
* Projects participating in the [https://projects.eclipse.org/releases/kepler Kepler simultaneous release]. We'll add a page that includes descriptions, logos, links to the project plan, and maybe contact information.
<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].
+
The project description is used in a lot of different places. Keep your project description concise; it is a means by which you can encourage people to take a closer look at your project; do not try to describe every little nuance of your project in the description. Note that you can separate out a summary of your description that will be used in lieu of the longer form which will be displayed on the project page.
</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].
+
[[Category:Project Management Infrastructure]]
</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>
+
</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.og [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>
+
 
+
====Categories====
+
<table border="1">
+
<tr>
+
<td>Category</td><td> <b>categories</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Description</td><td> <b>paragraphurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
 
+
<tr><td>Homepage</td><td> <b>projecturl</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>Wiki</td><td> <b>wikiurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Docs</td><td> <b>documentationurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
<tr><td>Download</td><td> <b>downloadsurl</b> in the project meta data. Use the [http://portal.eclipse.org/ portal].
+
</td></tr>
+
</table>
+
 
+
===(3) When is project status information considered out-of-date?===
+
Different kinds of information go out of date at different rates and        times, but here's an easy checklist:
+
* 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.
+
* Historical information (downloads, release information, and so on)            and status summaries need updating with each release (obviously).
+
 
+
===(4) Why is project status information important?===
+
Eclipse projects belong to a larger community - Eclipse - which is comprised of a 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 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.
+
 
+
===(5) What is project status information?===
+
The project status information encompasses three kinds of        information:
+
# Relatively static structural information such as the names of the            project's mailing lists and newsgroups, the bugzilla products and            CVS repository, 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.
+
 
+
===(6) Who is responsible for maintaining the project status information?===
+
Each Eclipse project's project lead is responsible for maintaining        that project's status information. This information is an important part        of being an Eclipse project and thus while we acknowledge that it is        possible to write code without status information, it is not possible to        be an <i>Eclipse project</i> without providing status to the rest of the        community.
+
 
+
''This page is moderated by Anne Jacko and Bjorn Freeman-Benson (Eclipse Foundation)''
+
 
[[Category:Development_Resources]]
 
[[Category:Development_Resources]]
 
[[Category:How to Contribute]]
 
[[Category:How to Contribute]]
 +
[[Category:Project Metadata]]

Latest revision as of 14:40, 15 September 2015

This page's content has been moved to the Eclipse Project Handbook.

Use the Generated Content for Your Project Home Page

If you want to use this page as your project home page, change the contents of your project's index.php file to:

<?php
header("Location: http://projects.eclipse.org/projects/your.project.id");
?>

(with an appropriate substitution of your.project.id, e.g. technology.egit, of course).

Note that the automatically-generated pages will continue to grow, change, and be updated.

Where is Project Metadata Used

Project metadata is used in a few different places today, and usage will continue to expand. Below are a few examples.

  • Projects using Tycho, or Maven. The description and project logo are used here.
  • Projects participating in the Kepler simultaneous release. We'll add a page that includes descriptions, logos, links to the project plan, and maybe contact information.

The project description is used in a lot of different places. Keep your project description concise; it is a means by which you can encourage people to take a closer look at your project; do not try to describe every little nuance of your project in the description. Note that you can separate out a summary of your description that will be used in lieu of the longer form which will be displayed on the project page.

Back to the top