New Project Provisioning Request

To be completed by a PMC member of the new project.

March 25, 2008

This form is used to request the infrastructure for projects that have completed a successful Creation Review and are beginning the Validation Phase of their project (under an existing Top-Level Project) at eclipse.org. These documents follow the Eclipse Project Lifecyle as described in the Eclipse Development Process and are intended to complement the information provided there. In general all inquiries related to project provisioning can be sent to the EMO.

 

This document is to be completed by a PMC member of the new project. After a successful Creation Review, the project enters the Validation Phase and additional infrastructure is created to support the initial work on the project:

  • CVS/SVN commit rights
  • CVS/SVN component structure
  • download site
  • a developer mailing list and
  • the project website

Ongoing changes to the project's core infrastructure are expected especially during the Validation Phase, as the project matures. Please consult the Project Implementation Phase Provisioning document for pointers on how to implement these changes.

This form is processed manually. Thus we request that you reduce the sysadmin overhead by only submitting complete data. Please wait until you have all the answers and then submit the completed form once. Multiple partial submission will (unfortunately) just confuse the situation. Thanks for your understanding.

If you have any questions, please send an email to the EMO.

 
Your Info
Name:
E-mail:
Phone number:
Development Process I have read and will follow the Eclipse Development Process
Project Info
New Eclipse Project:
Host Top-Level Project:
 
CVS/SVN Modules
Decide whether the project is going to use CVS or SVN for its source code repository. (Note that the project website will always be stored in CVS - this decision is about the project's source code.)
CVS         SVN
A list of the initial initial modules. Typical modules names are org.eclipse.[shortname].[component]. The short name is some variation of the project's Descriptive Name - the Acronym, a shortened version, or even the whole name. The project's optional Nickname is not a valid short name for CVS/SVN components. To make the sysadmins' lives easier, please enter the module names one per line.

Each Top-Level Project allocates the CVS/SVN modules to its sub-projects slightly differently. Please confirm your module layout with your PMC before you fill out this form. (Note for Technology sub-projects: that the Technology PMC allows only one org.eclipse.[shortname] module per project. Projects are encouraged to create whatever module/directory structure they need under that single top level module.)

 
Committer List

A list of the initial committers for the project. Note that each committer must have completed the e-forms and paper-forms as specified in the new committer process. The project cannot be provisioned without at least one committer and you cannot be a committer until you have completed these forms and agreements.
Name Email Address
1.
         another committer
Website update privileges
Download server privileges
Project Lead
 
Project Website
Each project has a web presence on www.eclipse.org. The content for a project web pages is stored in a separate CVS repository on dev.eclipse.org. The repository is automatically checked out to www.eclipse.org, and thereby enables website authors to use HTML and PHP to author websites directly on www.eclipse.org, does not require viewcvs, and paves the way for an eventual MySQL database backend. Only those committers designated above will be granted update rights to the project website CVS.

A directory of the form www.eclipse.org/[shortname] will be created for each new project. This also becomes the url for the project home page. A default index.html page containing the required frames is created in the website CVS repository.

Here's how it works:

1 - In Eclipse, create a new CVS Repository location:

Server: dev.eclipse.org
Path: /cvsroot/org.eclipse
Username/Password: your committer credentials are also used for website authoring
Website url: www.eclipse.org/[shortname]

2 - Checkout the "www" project, and you will see the project directories. Each of these directories has a single index.html file that sets up the frames and opens up main.html.

3 - It may take up to one minute to transfer committed content to www.eclipse.org but essentially committed changes are live.

There are some images which you may use in your web pages. These can be viewed at www.eclipse.org/images/.

The Tools and Technology Top-Level Projects have modeled the following conventions for project websites.

Filename
Purpose
www.eclipse.org/xyz/main.html
the content for the main project page
www.eclipse.org/xyz/faq.html
the project faq page
www.eclipse.org/xyz/download.html
the project downloads page
www.eclipse.org/xyz/plan.html
the project plan page
Project Proposal
The project proposal is automatically archived in the proposals archive.
Project Newsgroup
Projects typically have a eclipse.[parent project].[shortname] newsgroup. You will need to provide a description using the project status infrastructure. We strongly suggest that the wording include a link to the project's home page, e.g., www.eclipse.org/[shortname].
Project Mailing Lists
New projects typically have a single [shortname]-dev@ mailing list. When multiple components are being developed by independent teams, the new project may choose to have additional mailing lists of the form [shortname]-[component]-dev@. The short name can be an abbreviation of the Descriptive Name, or an Acronym, or the project's optional Nickname. The short name appears on the mailing list main page. You will need to provide the long description using the project status infrastructure
Mailing List Name Short Description
Builds
The project leads are responsible for builds and maintenance on eclipse.org. The frequency of these is dependent on the project needs. For more information see the Platform release engineering
Downloads
One or two appointed committers (see the checkboxes above) will have access to download.eclipse.org which is a high-bandwidth download server. For mirroring purposes, the link to download a file is /downloads/download.php?file=/tools/xyz/fileName. This will allow mirror site selection based on the file requested. We ask that you not link directly to "download.eclipse.org".

Because the downloads space is mirrored to several servers worldwide, we ask you use this space wisely, taking extra care when placing large files in this space, and performing regular file cleanups. Large directories use bandwidth while mirroring and deter new mirror sites because of high disk space requirements. Also, HTML and PHP files must not be placed on the download server.

Uploads to this space are via SFTP or SCP. Use any SFTP or SCP client, such as CoreFTP or WinSCP, to connect to download1.eclipse.org. Although you are connecting to download1.eclipse.org, links to files must be done to www.eclipse.org/downloads/download.php?file=.

RSYNC transfers can be arranged. Please consult the webmaster@eclipse.org for details on setting this up.
Bugzilla
A Bugzilla "product" is created for the new project. Underneath that product are a set of "components". There are two schemes for the component owners - some projects choose one, some choose the other:
  1. The component owners are actualy humans - project committers as listed above. With this scheme, the component owner receives notifications of new bugs for this component.  
    If you choose this scheme, enter the component owners' email addresses. The components owners must already have existing Bugzilla user accounts.
  2. The component owners are abstract "inbox" entities. With this scheme, anyone who wants to receive notifications of new bugs for this component uses the Bugzilla "watch this address" feature to watch the inbox email address. Thus plus for this scheme is that it is easy to change component owners and have multiple owners (just have them watch the inbox address); the minus is that if nobody is watching the inbox address, the notifications go to /dev/null.
    If you choose this scheme, enter the inbox email addresses in form "[short name].[component name]-inbox@eclipse.org". These bugzilla accounts do not have to exist (and, in fact, they should not exist).
Component Name Description Component Owner's Email Address
Math question: (5 - 1) divided by two:
FYI: The project is 'created' in three steps:
  1. First the CVS/SVN, user accounts, mailing-list, master home page (links to your page in the website CVS), download space on download.eclipse.org, and bugzilla components are created.
  2. Then the developer mailing lists and the hosting Top-Level Project main page are connected to the project
  3. The project lead creates the initial website and the project status information files.
  4. And then, voila, the project is "live".

This sequencing ensures that all the core infrastructure is ready and that the data and an initial project structure are in place, before the project goes live.