Jump to: navigation, search

Difference between revisions of "Development Resources/Project Plan/XML"

(New page: See bug 215301 for the standard project plan format.)
 
Line 1: Line 1:
See bug 215301 for the standard project plan format.
+
As per a resolution from the Board that led to [http://bugs.eclipse.org/215301 bug 215301], all projects are required to provide their current project plan in the following XML format.
 +
 
 +
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
 +
<?xml-stylesheet type="text/xsl" href="http://www.eclipse.org/projects/project-plan.xsl"?>
 +
<plan plan-format="1.0">
 +
    <release projectid="technology.dash" version="1.0"/>
 +
    <introduction>
 +
      ...html...
 +
    </introduction>
 +
    <release_deliverables>
 +
      ...html...
 +
    </release_deliverables>
 +
    <release_milestones>
 +
      <preamble>...html...</preamble>
 +
      <milestone date="7/1/2008" milestone="M1">...optional html...</milestone>
 +
      <milestone date="8/1/2008" milestone="M2">...optional html...</milestone>
 +
      <milestone date="9/1/2008" milestone="RC1">...optional html...</milestone>
 +
      <milestone date="6/28/2009" milestone="1.0"/>
 +
      <postamble>...html...</postamble>
 +
    </release_milestones>
 +
    <target_environments>
 +
      ...html...
 +
      <internationalization>
 +
        ...html...
 +
      </internationalization>
 +
    </target_environments>
 +
    <compatibility_with_previous_releases>
 +
      ...html...
 +
    </compatibility_with_previous_releases>
 +
    <themes_and_priorities>
 +
      <preamble>
 +
        ...html...
 +
      </preamble>
 +
      <theme name="Appealing to the Broader Community">
 +
        <committed>...bugzilla search url...</committed>
 +
        <proposed>...bugzilla search url...</proposed>
 +
        <deferred>...bugzilla search url...</deferred>
 +
      </theme>
 +
      <theme name="Design for Extensibility">
 +
        <committed>...bugzilla search url...</committed>
 +
        <proposed>...bugzilla search url...</proposed>
 +
        <deferred>...bugzilla search url...</deferred>
 +
      </theme>
 +
    </themes_and_priorities>
 +
    <appendix name="Project Refactoring">
 +
      ...html...
 +
    </appendix>
 +
  </plan>
 +
 
 +
Note that if your HTML blocks contain non-XML-parseable HTML, you'll want to enclose them in a CDATA section, e.g.,
 +
  <introduction><![[CDATA[ ... ]]></introduction>
 +
 
 +
Obviously, the milestone, theme and appendix elements can be repeated as many times as necessary. 
 +
 
 +
==Bugs as Plan Items==
 +
The goal of the bugzilla queries is to support the use of bugzilla items for planning. The project team should assign target milestones to each bug, including both defects and enhancements. Additionally, the team should assign keywords (or keywords-in-titles) to each bug entry in order to classify them into themes. The bugzilla queries would then be, e.g., "all 2.6M1, 2.6M2, 2.6M3, ..., 2.6 bugs with keyword 'designforextensibility'", etc.

Revision as of 00:03, 10 March 2008

As per a resolution from the Board that led to bug 215301, all projects are required to provide their current project plan in the following XML format.

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<?xml-stylesheet type="text/xsl" href="http://www.eclipse.org/projects/project-plan.xsl"?>
<plan plan-format="1.0">
   <release projectid="technology.dash" version="1.0"/>
   <introduction>
     ...html...
   </introduction>
   <release_deliverables>
     ...html...
    </release_deliverables>
   <release_milestones>
      <preamble>...html...</preamble>
      <milestone date="7/1/2008" milestone="M1">...optional html...</milestone>
      <milestone date="8/1/2008" milestone="M2">...optional html...</milestone>
      <milestone date="9/1/2008" milestone="RC1">...optional html...</milestone>
      <milestone date="6/28/2009" milestone="1.0"/>
      <postamble>...html...</postamble>
   </release_milestones>
   <target_environments>
     ...html...
     <internationalization>
       ...html...
     </internationalization>
   </target_environments>
   <compatibility_with_previous_releases>
     ...html...
   </compatibility_with_previous_releases>
   <themes_and_priorities>
     <preamble>
       ...html...
     </preamble>
     <theme name="Appealing to the Broader Community">
        <committed>...bugzilla search url...</committed>
        <proposed>...bugzilla search url...</proposed>
        <deferred>...bugzilla search url...</deferred>
     </theme>
     <theme name="Design for Extensibility">
        <committed>...bugzilla search url...</committed>
        <proposed>...bugzilla search url...</proposed>
        <deferred>...bugzilla search url...</deferred>
     </theme>
   </themes_and_priorities>
   <appendix name="Project Refactoring">
     ...html...
   </appendix>	
 </plan>

Note that if your HTML blocks contain non-XML-parseable HTML, you'll want to enclose them in a CDATA section, e.g.,

 <introduction><![[CDATA[ ... ]]></introduction>

Obviously, the milestone, theme and appendix elements can be repeated as many times as necessary.

Bugs as Plan Items

The goal of the bugzilla queries is to support the use of bugzilla items for planning. The project team should assign target milestones to each bug, including both defects and enhancements. Additionally, the team should assign keywords (or keywords-in-titles) to each bug entry in order to classify them into themes. The bugzilla queries would then be, e.g., "all 2.6M1, 2.6M2, 2.6M3, ..., 2.6 bugs with keyword 'designforextensibility'", etc.