| <html> |
| <head> |
| <link rel="stylesheet" href="../default_style.css"> |
| <title>Top-Level Project Provisioning</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </head> |
| |
| <body text="#000000" bgcolor="#ffffff" link="#0000ee" vlink="#551a8b" alink="#ff0000"> |
| <table BORDER=0 CELLSPACING=5 CELLPADDING=2 WIDTH="100%" height="129" > |
| <tr> |
| <td ALIGN=LEFT width="67%"><font class=indextop>top-level project validation |
| phase provisioning</font><br> |
| <font class=indexsub>infrastructure for projects </font></td> |
| <td WIDTH="33%"> </td> |
| </tr> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| <tr> |
| <td align="center" valign="top"> |
| <p style="border-style: dashed"><b><font face="Arial,Helvetica" size="+1">These |
| pages are out-of-date. <br> |
| Revised and corrected versions of these pages are being developed. <br> |
| Please verify with all information on these pages with the <a href="mailto:emo@eclipse.org">EMO</a>.</font></b></p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p><br> |
| This document describes the infrastructure for new Top-Level Projects |
| (projects that propose a new PMC) that have completed a sucessful creation |
| review and are beginning the validation phase of their project at eclipse.org. |
| The <a href="projectvalidation.html">Project Validation Phase Provisioning</a> |
| document describes the infrastructure for new projects under an existing |
| Top-Level Project. These documents follow the Eclipse Project Lifecyle as described |
| in the <a href="../org/documents/Eclipse%20Development%20Process%202003_11_09%20FINAL.pdf">Eclipse |
| Development Process</a> and are intended to complement the information |
| provided there. In general all inquiries related to project provisioning |
| can be sent to the <a href="mailto:emo@eclipse.org">EMO</a> .<br> |
| </p> |
| </td> </tr> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| <tr bgcolor="#999999"> |
| <td align="left" valign="top" bgcolor="#0080C0"><b><font face="Arial,Helvetica" color="#FFFFFF"> |
| Eclipse Top-Level project validation phase infrastructure</font></b></td> |
| </TR> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=top border="0"> |
| <tr> |
| <td> <img src="validation.jpg" width="180" height="310"></td> |
| <td width="100%"> |
| <p>After a successful Creation Review, the project enters the Validation |
| Phase and additional infrastructure is created to support the initial |
| work on the project:</p> |
| <ul> |
| <li>CVS commit rights</li> |
| <li> CVS component structure</li> |
| <li>download site </li> |
| <li>a developer mailing list and</li> |
| <li> the project website<br> |
| </li> |
| </ul> |
| Please consult the <a href="#checklist">checklist</a> below for items |
| required to implement this core infrastructure. Each of the deliverables |
| can be emailed to the <a href="mailto:emo@eclipse.org">EMO</a>. |
| <p>The project is 'created' in two steps: </p> |
| <ol> |
| <li>CVS, user accounts, mailing-list, master home page (links to your |
| page in the <a href="#web">website CVS</a>), <a href="#downloadspace">download |
| space</a> on download.eclipse.org, and bugzilla </li> |
| <li> Developer mailing lists, hosting Top-Level Project main page and any additional |
| <a href="#newsgroups">newsgroups</a> are then connected to your |
| project making it "live".</li> |
| </ol> |
| |
| <p> This 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". <br> |
| <br> |
| Ongoing <a href="#changes">changes</a> to the project's core infrastructure |
| are expected especially during the Validation Phase, as the project matures. |
| Please consult the <a href="changes.html">Project Implementation Phase |
| Provisioning</a> document for pointers on how to implement these changes. |
| </p> |
| </td> </tr> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| <tr bgcolor="#999999"> |
| <td colspan="2" align="left" valign="top" bgcolor="#0080C0"><b><font face="Arial,Helvetica" color="#FFFFFF"> |
| <a name="newsgroups"></a>Project newsgroup</font></b></td> |
| </TR> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| <tr> |
| <td> |
| <p>At this stage, the proposal newsgroup can be repositioned as the project |
| newsgroup, or the team can archive the existing newsgroup (so it becomes |
| read-only) and start a new project newsgroup. <br><br> |
| </p> |
| </td> |
| </tr> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| <tr bgcolor="#999999"> |
| <td colspan="2" align="left" valign="top" bgcolor="#0080C0"><b><font face="Arial,Helvetica" color="#FFFFFF"> |
| </font><a name="web"></a><font face="Arial,Helvetica" color="#FFFFFF">Project |
| website</font></b></td> |
| </TR> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| |
| <tr> |
| <td> |
| <p>Each project has a web presense 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 by their project PMC will be granted update rights to the |
| project website CVS. As a bootstrap mechanism, the PMC will have committer |
| access to assist with web maintenance.<br> |
| <br> |
| A directory of the form <b>www.eclipse.org/[shortname]</b> will be |
| created by the webmaster 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. </p> |
| <p>Here's how it works:</p> |
| <p>1 - In Eclipse, create a new CVS Repository location:</p> |
| <blockquote> |
| <blockquote> |
| <p><b>Server</b>: dev.eclipse.org<br> |
| <b>Path</b>: /home/cvs/org.eclipse<br> |
| <b>Username/Password</b>: your committer credentials are also used |
| for website authoring<br> |
| <b>Website url</b>: www.eclipse.org/[shortname]</p> |
| </blockquote> |
| </blockquote> |
| <p>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.<br> |
| <br> |
| 3 - It may take up to one minute to transfer committed content to |
| www.eclipse.org but essentially committed changes are live.</p> |
| |
| <p>There are some images which you may use in your web pages. These can |
| be viewed at www.eclipse.org/images. </p> |
| |
| <p>The Tools and Technology Top-Level Projects have modelled the following |
| conventions for project websites. </p> |
| <table width="75%" border="1"> |
| <tr> |
| <td> |
| <div align="center"><b>Filename</b></div> |
| </td> |
| <td> |
| <div align="center"><b>Purpose</b></div> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <div align="center">www.eclipse.org/xyz/main.html</div> |
| </td> |
| <td> |
| <div align="center">the content for the main project page </div> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <div align="center">www.eclipse.org/xyz/faq.html</div> |
| </td> |
| <td> |
| <div align="center">the project faq page</div> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <div align="center">www.eclipse.org/xyz/download.html</div> |
| </td> |
| <td> |
| <div align="center">the project downloads page</div> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <div align="center">www.eclipse.org/xyz/plan.html</div> |
| </td> |
| <td> |
| <div align="center">the project plan page</div> |
| </td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table><p></p> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| <tr bgcolor="#999999"> |
| <td colspan="2" align="left" valign="top" bgcolor="#0080C0"><b><a name="downloadspace"></a><font face="Arial,Helvetica" color="#FFFFFF">Builds |
| and downloads</font></b></td> |
| </TR> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| |
| <tr> |
| <td> |
| <p><b>Builds </b><br> |
| 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: </p> |
| <blockquote> |
| <p>Eclipse project development - <a href="http://www.eclipse.org/eclipse/development/main.html">http://www.eclipse.org/eclipse/development/main.html</a><br> |
| Platform release engineering - <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-releng-home/main.html">http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-releng-home/main.html</a></p> |
| </blockquote> |
| <b>Downloads </b><br> |
| The project lead and their appointed committers will receive an account |
| and password on download1.eclipse.org which is a high-bandwidth download |
| server. For projects under the Tools Top-Level Project, for example, the directory will |
| be /home/www/tools/xyz. For mirroring purposes, however, the link to download |
| a file is http://www.eclipse.org/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" or "download1.eclipse.org" |
| <p>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.</p> |
| <p>Uploads to this space are via SFTP (preferred) or FTP. Use any SFTP client, |
| such as CoreFTP, to connect to download1.eclipse.org. Although you are |
| connecting to download1.eclipse.org, links to files must be done to download.eclipse.org. |
| <br> |
| <br> |
| RSYNC transfers can be arranged. Please consult the <a href="mailto:webmaster@eclipse.org">webmaster@eclipse.org</a> |
| for details on setting this up.</p> |
| </td> |
| </tr> |
| </table><p></p> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| <tr bgcolor="#999999"> |
| <td colspan="2" align="left" valign="top" bgcolor="#0080C0"><b><a name="changes"></a><font face="Arial,Helvetica" color="#FFFFFF">Changes |
| </font></b></td> |
| </TR> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| <tr> |
| <td> |
| <p><b> For more information see the <a href="changes.html">Project Implementation |
| Phase Provisioning</a> document. <br> |
| <br> |
| Getting changes to your infrastructure</b></p> |
| <p>If you need changes to your infrastructure, you need to send an email |
| to webmaster@eclipse.org or to the emo@eclipse.org. In general things |
| like password reset and creating new components are taken care of by the |
| webmaster. Other content related changes such as changes to web elements |
| on www.eclipse.org should be sent to <a href="mailto:emo@eclipse.org">emo@eclipse.org</a>. |
| When sending requests, please clearly identify the Top-Level Project and |
| Project you are working on so that requests that require PMC approval |
| or clarification can be properly routed to the correct PMC by the infrastructure |
| team.</p> |
| <p><b>Changes to your committers list</b><br> |
| Changes to the committers list, including adding new committers, is done |
| through <a href="mailto:emo@eclipse.org">emo@eclipse.org</a>. We also |
| track the committer's address and contact information. We use these lists |
| to determine the developer's voting rights on eclipse.org, so please help |
| us to keep them up to date! For more information see the <a href="changes.html">Project |
| Implementation Phase Provisioning</a> document. <br> |
| <br> |
| </p> |
| </td> |
| </tr> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=center> |
| <tr bgcolor="#999999"> |
| <td align="left" valign="top" bgcolor="#0080C0"><b><font face="Arial,Helvetica" color="#FFFFFF"> |
| <a name="checklist"></a>Top-Level project validation phase provisioning |
| checklist</font></b></td> |
| </TR> |
| </table> |
| <table width="100%" cellspacing=0 cellpadding=3 align=top border="1"> |
| <tr> |
| <td width="16%"> |
| <p><b>Item</b></p> |
| </td> |
| <td width="38%"><b> Description</b></td> |
| <td width="32%"><b>Project team deliverable</b></td> |
| <td width="14%"><b>Review by</b></td> |
| </tr> |
| <tr> |
| <td width="16%" >Committers list</td> |
| <td width="38%"> |
| <p>A list of the initial committers for the project.<br> |
| </p> |
| </td> |
| <td width="32%">A list of the initial committers with the following information:<br> |
| - name of the project and new top-level project<br> |
| - full name of the committer<br> |
| - email address of the committer<br> |
| - if available, the list of CVS components or modules to which the committer |
| will have update privileges</td> |
| <td width="14%">- nominated by PMC <br> |
| - approved by EMO </td> |
| </tr> |
| <tr> |
| |
| <td width="16%" >Committer Guidelines, Agreement, Questionnaire and Employer |
| Consent </td> |
| |
| <td width="38%"> |
| <p>The EMO is responsible for ensuring that documentation is in place |
| for new committers. <br> |
| <br> |
| Once the documentation is in place, the EMO will contact the webmaster |
| to provide the appropriate accesses to the new committers. </p> |
| </td> |
| <td width="32%"> |
| <p>- the project team may appoint a single contact to assist the new |
| committers in completing the required documentation</p> |
| <p> </p> |
| </td> |
| <td width="14%"> </td> |
| </tr> |
| <tr> |
| <td width="16%" >List of initial CVS components</td> |
| |
| <td width="38%">Typical components are:<br> |
| org.eclipse.[shortname].[component]<br> |
| <p> </p> |
| </td> |
| |
| <td width="32%">- a list of components along with a list of committers who |
| will have access to each component<br> |
| <br> |
| </td> |
| |
| <td width="14%">submitted by PMC and reviewed by EMO</td> |
| </tr> |
| <tr> |
| |
| <td width="16%" >Project website moves to website CVS</td> |
| |
| <td width="38%">- <i><a href="#web">See Website section above</a></i> <br> |
| - the project receives a website address on www.eclipse.org in the format |
| www.eclipse.org/[shortname]/<br> |
| -the website content is checked into the corresponding repository by |
| the project committers <br> |
| Note: Only those committers designated by their project PMC will be |
| granted update rights to the project website CVS. As a bootstrap mechanism, |
| the PMC will have committer access to assist with web maintenance.<br> |
| </td> |
| |
| <td width="32%">- a list of which committers have access to the website CVS<br> |
| - the new committers can coordinate the release of their new site with the |
| release of links from the project main page, newsgroups and mailing list |
| pages, etc. </td> |
| |
| <td width="14%">review by EMO</td> |
| </tr> |
| <tr> |
| <td width="16%" >Project description</td> |
| |
| <td width="38%">the project description is modified on the project main page |
| (www.eclipse.org/projects/index.html) to reflect change in status</td> |
| <td width="32%">- any requested edits to the project description</td> |
| |
| <td width="14%">review by EMO</td> |
| </tr> |
| <tr> |
| <td width="16%" >Proposal archived</td> |
| |
| <td width="38%">the successful proposal is archived in the proposal archive</td> |
| <td width="32%">- none</td> |
| |
| <td width="14%"> </td> |
| </tr> |
| <tr> |
| <td width="16%" >Newsgroup link on newsgroups page </td> |
| |
| <td width="38%">the <a href="#newsgroups">newsgroup</a> is moved from a standalone |
| position on the page a new top-level project section </td> |
| <td width="32%">- any requested edits to the newsgroup description</td> |
| |
| <td width="14%">review by EMO</td> |
| </tr> |
| <tr> |
| <td width="16%" >Mailing list name </td> |
| <td width="38%">- typical mailing list names are in the form [shortname]-dev@eclipse.org |
| <br> |
| - when multiple components are developed independently, component lists |
| are created in the form [shortname]-[component] -dev@eclipse.org</td> |
| <td width="32%">- confirmation of list name and/or component list names</td> |
| |
| <td width="14%">review by EMO</td> |
| </tr> |
| <tr> |
| <td width="16%" >Mailing list short description</td> |
| <td width="38%">- the short description appears on the mailing list main page</td> |
| <td width="32%">- short description based on the examples here <a href="http://www.eclipse.org/mail/index.html" target="_blank">http://www.eclipse.org/mail/index.html</a></td> |
| |
| <td width="14%">review by EMO</td> |
| </tr> |
| <tr> |
| <td width="16%" >Mailing list long description </td> |
| <td width="38%">- the long description appears on the introductory page to |
| the individual mailing list </td> |
| <td width="32%">- long description based on the example shown here <a href="http://dev.eclipse.org/mailman/listinfo/platform-dev" target="_blank">http://dev.eclipse.org/mailman/<br> |
| listinfo/platform-dev</a></td> |
| |
| <td width="14%">review by EMO</td> |
| </tr> |
| <tr> |
| |
| <td width="16%" >Download directory</td> |
| |
| <td width="38%"> |
| <p>- the project lead will submit the names of one or two committers |
| per project who will receive an account and password on download1.eclipse.org<br> |
| - <i><a href="#downloadspace">see Downloads above</a></i></p> |
| </td> |
| <td width="32%">- names of committers to be granted update rights to the |
| download site </td> |
| |
| <td width="14%">review by EMO</td> |
| </tr> |
| <tr> |
| <td width="16%" >Bugzilla </td> |
| <td width="38%">- Bugzilla product is created with sublisting for each component |
| and component milestone eg. <br> |
| <img src="bugzillacomponent.jpg" width="355" height="113"> <br> |
| </td> |
| <td width="32%">- initial list of components, milestones and component |
| owners</td> |
| |
| <td width="14%">review by EMO</td> |
| </tr> |
| </table> |
| <p></p> |
| <p></p> |
| </body> |
| </html> |
