Jump to: navigation, search

Difference between revisions of "Development Resources/Data Driven Project Website"

(4 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
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 '''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.
+
The '''description''' comes from a file provided by the project and referenced by the ''descriptionurl'' metadata entry. The value in the metadata should point to a file containing the HTML to display as the project's description. A paragraph or two is recommended (perhaps this can be taken from the project's proposal). As a general rule, you should avoid messing around withthe presentation (i.e. style), or adding too many links in this content especially to content that is otherwise linked by the page (e.g. downloads). 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 [http://dash.eclipse.org Dash] data. It is only displayed if information is available. Dash uses the ''sourcerepository'' entries provided in the portal to do its work.  
+
Commits activity is generated from [http://dash.eclipse.org Dash] data. It is only displayed if information is available. Dash uses the ''sourcerepository'' entries provided in the portal to do its work. Note that Dash runs once a week on Sunday, so the charts will not immediately appear after specifying source repositories.
  
 
[[Image:Portal-sourcerepositories.png]]
 
[[Image:Portal-sourcerepositories.png]]
Line 22: Line 22:
  
 
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.
 
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.
 +
 +
=Company Logos=
 +
 +
Company logos sometimes appear under the project members on the right. Here's what you need in order to get your company's logo to show up in this pane:
 +
 +
*The company must be a [http://eclipse.org/membership/ member] of the Eclipse Foundation;
 +
*The company needs to have their logo uploaded to the Portal;
 +
*At least one committer has to be listed as an employee of the company in question;
 +
*The committer must be on this project; and
 +
*The committer must be active (must have made at least one commit in the last three months)
 +
 +
If all of those conditions are met and the logo is still not showing up, then it’s possible that the project meta-data doesn’t have the correct version control paths specified–this affects whether the committer is considered active by the dashboard.
 +
 +
=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:
 
If you want to use this page as your project home page, change the contents of your project's ''index.php'' file to:
Line 30: Line 44:
  
 
(with an appropriate substitution of ''your.project.id'', of course).
 
(with an appropriate substitution of ''your.project.id'', of course).
 +
 +
Note that the automatically-generated pages will continue to grow, change, and be updated.

Revision as of 10:11, 22 May 2012

Projects can opt to use an automatically-generated project landing page. This page uses data from various sources, including 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. The value in the metadata should point to a file containing the HTML to display as the project's description. A paragraph or two is recommended (perhaps this can be taken from the project's proposal). As a general rule, you should avoid messing around withthe presentation (i.e. style), or adding too many links in this content especially to content that is otherwise linked by the page (e.g. downloads). 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. Note that Dash runs once a week on Sunday, so the charts will not immediately appear after specifying source repositories.

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.

Company Logos

Company logos sometimes appear under the project members on the right. Here's what you need in order to get your company's logo to show up in this pane:

  • The company must be a member of the Eclipse Foundation;
  • The company needs to have their logo uploaded to the Portal;
  • At least one committer has to be listed as an employee of the company in question;
  • The committer must be on this project; and
  • The committer must be active (must have made at least one commit in the last three months)

If all of those conditions are met and the logo is still not showing up, then it’s possible that the project meta-data doesn’t have the correct version control paths specified–this affects whether the committer is considered active by the dashboard.

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

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

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