Jump to: navigation, search

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

(Viewing and Editing Project Metadata)
 
(37 intermediate revisions by the same user not shown)
Line 1: Line 1:
== What is Project Metadata?==
+
This page's content has been moved to the [https://www.eclipse.org/projects/handbook/#pmi-metadata Eclipse Project Handbook].
# 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.
+
# 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?===
+
==Use the Generated Content for Your Project Home Page==
Eclipse committers and project leads are responsible for maintaining their project's metadata. This information is an important part of being an Eclipse project.
+
  
==Viewing and Editing Project Metadata==
+
If you want to use this page as your project home page, change the contents of your project's ''index.php'' file to:
  
The complete listing of all current [http://projects.eclipse.org/list-of-projects Eclipse projects] provides one starting point for viewing projects. From here, you can link directly to a project information page. Navigation options are provided to help you move from one project to another.
+
<?php
 +
header("Location: http://projects.eclipse.org/projects/your.project.id");
 +
?>
  
Here is an example of a project page (visit the [http://projects.eclipse.org/projects/technology.egit live project page]).
+
(with an appropriate substitution of ''your.project.id'', e.g. technology.egit, of course).
  
[[Image:PMI-project-page.png]]
+
Note that the automatically-generated pages will continue to grow, change, and be updated.
  
If you are a project committer, you can authenticate with the system by clicking the "Login" link. Once logged in, you will have the ability to edit the information being displayed.
+
==Where is Project Metadata Used==
  
[[Image:PMI-edit.png]]
+
Project metadata is used in a few different places today, and usage will continue to expand. Below are a few examples.
  
There are several sections on the page. When you switch the page into "Edit" mode, you will be provided with lots of help regarding the contents of each of the fields (note that the help text is currently rendered below the fields).
+
* 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.
 +
* 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.
  
===Description and Scope===
+
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.
At the top are the description and the scope. The description should  be suitable for display with a collection of other projects (e.g. [http://projects.eclipse.org/build-technology/maven Use of Maven Build Technology]). A single paragraph is generally appropriate for the description.
+
 
+
The scope is intended for a more select audience; generally speaking the scope should be taken directly from the project's proposal. Project members have the ability to change the text of the project scope, but should be careful to avoid changing the meaning. If the meaning of the scope needs to change, consult your PMC regarding a restructuring review.
+
 
+
===More===
+
 
+
There is a lot more information displayed on this page. We'll fill in these details over the coming days and weeks.
+
  
 +
[[Category:Project Management Infrastructure]]
 
[[Category:Development_Resources]]
 
[[Category:Development_Resources]]
 
[[Category:How to Contribute]]
 
[[Category:How to Contribute]]
 
[[Category:Project Metadata]]
 
[[Category:Project Metadata]]

Latest revision as of 13: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.