mward | 8c588c3 | 2011-02-25 13:56:26 +0000 | [diff] [blame] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
| 2 | <project> |
| 3 | <!-- |
| 4 | - This example is annotated to be instructive. In order to be instructive, the |
| 5 | - example is a mish-mash of information from a variety of projects. Obviously, |
| 6 | - when you write the project-info.xml file for your project, the file will |
| 7 | - contain information only about your one project. |
| 8 | --> |
| 9 | <!-- |
| 10 | - Unless otherwise specified, all URLs are to be specified using rooted relative |
| 11 | - paths. In other words: |
| 12 | - CORRECT: "/webtools/foo/bar.php" |
| 13 | - INCORRECT: "foo/bar.php" |
| 14 | - INCORRECT: "http://www.eclipse.org/webtools/foo/bar.php" |
| 15 | --> |
| 16 | |
| 17 | <!-- |
| 18 | - Each Eclipse project as an official name, e.g., |
| 19 | - "AJDT - AspectJ Development Tools Project" and a foundation database |
| 20 | - key, e.g., "technology.ajdt". These are stored in an Eclipse Foundation |
| 21 | - database; You can override the name stored on the database by filling |
| 22 | - the <name/> tag |
| 23 | --> |
| 24 | <name>Phoenix Project</name> |
| 25 | |
| 26 | <!-- |
| 27 | - Each project can also have a short name to be used in HTML lists and |
| 28 | - other horizontally challenged places. |
| 29 | --> |
| 30 | <short-name>Phoenix</short-name> |
| 31 | |
| 32 | <!-- |
| 33 | - Each Eclipse project has one or more Bugzilla products and components. |
| 34 | - Some projects also have a separate web page describing how to submit |
| 35 | - a bug, how bugs are prioritized, and other useful information. |
| 36 | - The <bugzilla> collects this information. |
| 37 | - |
| 38 | - <bugzilla url="..."> <product name="..."/> ... </bugzilla> |
| 39 | - The url is optional; if absent, the url will default to the Bugzilla |
| 40 | - page of the first product. Multiple <product>s are allowed. |
| 41 | --> |
| 42 | <bugzilla> |
| 43 | <product name="Phoenix"/> |
| 44 | </bugzilla> |
| 45 | |
| 46 | <!-- |
| 47 | - Committers and non-committer Contributors are the raison d'etre of |
| 48 | - an Eclipse project, thus each project should list and acknowledge these |
| 49 | - developers. Some of the Committers are 'special' in the sense that |
| 50 | - they are the project leaders. The <team> element contains the |
| 51 | - URL of the project's pages listing these important people. |
| 52 | --> |
| 53 | <team url="/phoenix/about.php" /> |
| 54 | |
| 55 | <!-- |
| 56 | - The source code of each Eclipse project is stored in CVS. Eclipse maintains |
| 57 | - a number of CVS repositories, thus the <cvs> element specifies which |
| 58 | - CVS repository and (if applicable) which root path stores this project's |
| 59 | - source code. |
| 60 | - |
| 61 | - A top-level project typically specifies only the repository: |
| 62 | - <cvs repository="/cvsroot/tptp"/> |
| 63 | - A sub-project includes the root path as well: |
| 64 | - <cvs repository="/cvsroot/technology/"> |
| 65 | - <module path="org.eclipse.higgins" /> |
| 66 | - </cvs> |
| 67 | --> |
| 68 | <cvs repository="/cvsroot/technology/"> |
| 69 | <module path="org.eclipse.phoenix" /> |
| 70 | </cvs> |
| 71 | |
| 72 | <!-- |
| 73 | - The description of an Eclipse project shows up in many places: the |
| 74 | - project's home page, perhaps the /projects/ page listing all the |
| 75 | - top-level projects, in the Roadmap, and so on. Some of the descriptions |
| 76 | - are separate HTML files (such as those described in |
| 77 | - http://phoenix.eclipse.org/projects/dev_process/project-status-infrastructure.php). |
| 78 | - It would be nice |
| 79 | - This <description> element contains two additional descriptions. |
| 80 | - 1. The optional <description url="..."> points to a web page with a larger |
| 81 | - description of the entire project. |
| 82 | - 2. The required <description paragraph-url="..."> points to a file |
| 83 | - containing a couple of simple HTML paragraphs describing the project. |
| 84 | - This file is often stored in the /project-info/ directory, thus the |
| 85 | - url would be something like "/tptp/project-info/description.html". |
| 86 | --> |
| 87 | <description url="/phoenix/about.php" |
| 88 | paragraph-url="/phoenix/project-info/project-page-paragraph.html"/> |
| 89 | |
| 90 | <!-- |
| 91 | - In addition to the description, each Eclipse project is also required to |
| 92 | - provide an up-to-date status summary. "Up to date" means revised at least |
| 93 | - quarterly. |
| 94 | - The required <summary paragraph-url="..."> points to a file |
| 95 | - containing a number of simple HTML paragraphs with an executive summary |
| 96 | - of the project status. |
| 97 | - This file is often stored in the /project-info/ directory, thus the |
| 98 | - url would be something like "/technology/project-info/executive-summary.html". |
| 99 | --> |
| 100 | <summary paragraph-url="/technology/phoenix/project-info/executive-summary.html"/> |
| 101 | |
| 102 | <!-- |
| 103 | - It is important to help new users get started with an Eclipse project |
| 104 | - because most Eclipse projects are solving some difficult technical |
| 105 | - problem and thus are somewhat complex. The <getting-started> element |
| 106 | - points to a web page on the project's site that describes how to |
| 107 | - get started using and extending the project's tools and frameworks. |
| 108 | --> |
| 109 | <getting-started url="/phoenix/docs/" /> |
| 110 | |
| 111 | <!-- |
| 112 | - It is also important to help new contributors get started with an Eclipse project. |
| 113 | - Most Eclipse projects have interesting/complex development environment |
| 114 | - setups or to-do lists. The <contributing> element |
| 115 | - points to a web page on the project's site that describes how to |
| 116 | - get started developing on, and contributing to, the project. |
| 117 | --> |
| 118 | <contributing url="/phoenix/docs/" /> |
| 119 | |
| 120 | <!-- |
| 121 | - Each Eclipse project is required to maintain a current Project IP Log. |
| 122 | - See http://www.eclipse.org/projects/dev_process/project-log.php |
| 123 | - The <ip-log> contains the URL of that log. If the project has |
| 124 | - other legal information as well, it can use the <legal> element |
| 125 | - instead and then include the IP Log information on the Legal web page. |
| 126 | --> |
| 127 | <ip-log url="" /> |
| 128 | <legal url="" /> |
| 129 | |
| 130 | <!-- |
| 131 | - Each Eclipse project has one or more mailing lists. |
| 132 | - Some projects also have a separate web page describing these lists |
| 133 | - while others rely on the main Eclipse mailing lists page. |
| 134 | - |
| 135 | - <mailing-lists url="..."> <list name="..."/> ... </mailing-lists> |
| 136 | - The url is optional; if absent, the url will default to the Eclipse |
| 137 | - mailing lists page. Multiple <lists>s are allowed. |
| 138 | - |
| 139 | - Note that currently mailing lists must be redundantly listed in |
| 140 | - the separate project-info/maillist file as well. |
| 141 | --> |
| 142 | <mailing-lists> |
| 143 | <list name="phoenix-dev"/> |
| 144 | </mailing-lists> |
| 145 | |
| 146 | <!-- |
| 147 | - Each Eclipse project has one or more newsgroups. |
| 148 | - Some projects also have a separate web page describing these lists |
| 149 | - while others rely on the main Eclipse newsgroups page. |
| 150 | - |
| 151 | - <newsgroups url="..."> <newsgroup name="..."/> ... </newsgroups> |
| 152 | - The url is optional; if absent, the url will default to the Eclipse |
| 153 | - newsgroups page. Multiple <newsgroups>s are allowed. |
| 154 | --> |
| 155 | <newsgroups> |
| 156 | <newsgroup name="eclipse.technology.phoenix" /> |
| 157 | </newsgroups> |
| 158 | |
| 159 | <!-- |
| 160 | - The dashboard attempts to measure the liveness of a project in many |
| 161 | - ways including the traffic on the mailing lists and newsgroups. There |
| 162 | - are other places where significant project-related traffic can occur |
| 163 | - including blogs and articles. When listed here, the dashboard incorporates |
| 164 | - them into the liveness measure (or rather, "will incorporate"). |
| 165 | --> |
| 166 | <articles> |
| 167 | </articles> |
| 168 | |
| 169 | <blogs> |
| 170 | </blogs> |
| 171 | |
| 172 | <!-- |
| 173 | - Each Eclipse project needs to have a plan both for its internal purposes |
| 174 | - (to guide development and resource allocation) and for the larger Eclipse |
| 175 | - community and ecosystem to understand what will be delivered and when |
| 176 | - it will be delivered. |
| 177 | --> |
| 178 | <project-plan url="" /> |
| 179 | |
| 180 | <!-- |
| 181 | - Each Eclipse project creates (optional) nightly builds and milestone builds, |
| 182 | - but the important builds of a project are the releases. This section of the |
| 183 | - status file records the completed (past) and scheduled (future) releases of |
| 184 | - the project. |
| 185 | - The status, name, and date are required attributes. The download is optional |
| 186 | - and only valid for completed releases; the plan is optional and valid for |
| 187 | - all releases. The three valid types of releases are, in order of ascending |
| 188 | - uncertainity: "completed", "scheduled", and "tentative". Dates can be |
| 189 | - specified as particular day DD/MM/YYYY (e.g., 22/03/2005) or a particular |
| 190 | - month MM/YYYY (e.g., 10/2005), or a quarter NQYYYY (e.g., 3Q2005). Obviously |
| 191 | - completed releases should include the exact day the release was completed. |
| 192 | - |
| 193 | - In the following example, we have three completed, two scheduled, and one |
| 194 | - tentative release. |
| 195 | --> |
| 196 | <releases> |
| 197 | </releases> |
| 198 | </project> |