Development Resources/Data Driven Project Website

From Eclipsepedia

< Development Resources
Revision as of 01:52, 28 July 2011 by Wayne.eclipse.org (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Projects can opt to use an automatically-generated project landing page. This page uses data from various sources, including [[Development Resources/HOWTO/Project Meta-Data|Project Metadata], Bugzilla, and IPZilla.

Projectsummary2.png

The title comes from the projectname metadata entry; if this entry is not specified, the value is obtained from the projects database that I maintain (so you can override the value, or remain at my mercy).

The description comes from a file provided by the project and referenced by the descriptionurl metadata entry. Since a lot of projects do a rather poor job of specifying this value (many just stuff a link to their project home page), we do a few relatively clever things to try and scavenge a useful value. By simply providing a link to a reasonable file, this part of the page can look pretty sharp. The logo comes from the logourl metadata entry. It's only displayed if it is actually provided.

Commits activity is generated from Dash data. It is only displayed if information is available. Dash uses the sourcerepository entries provided in the portal to do its work.

Portal-sourcerepositories.png

Company Activity provides a different view of the same Dash data and depends on the same metadata entries. This pie chart shows the relative contributions from the various companies that contribute development resources to the project. Only those companies that have contributed a least one commit in the last three months are displayed.

The Source Repositories section lists the repositories specified in the sourcerepositories metadata entry. This section provides handy links to the actual repositories.

The Releases section is built from the release metadata entries. Only the information that's provided is displayed. There are sub-entries that capture things like "new and noteworthy" documents, IP Logs, plans, etc.

The Reviews section is also built from project metadata, but it is metadata that is maintained on the project's behalf by the EMO.

The left side of the page provides other useful project information harvested from other metadata entries (like the wikiurl, updatesiteurl, and downloadsurl), and some handy navigation through the project hierarchy.

The right side displays information about the people involved in the project. Bold entries indicate project-specific activity within the last three months. Similarly, the list of supporting organizations contains only those projects who have had at least one committer make at least one commit in the last three months.

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://www.eclipse.org/projects/project.php?id=your.project.id");
?>

(with an appropriate substitution of your.project.id, of course).