| <?xml version="1.0"?> |
| <document> |
| <!-- TODO: include back into site, after checking which are complete, add to instructions on how to contribute docs --> |
| <properties> |
| <title>Documentation Required</title> |
| <author email="brett@apache.org">Brett Porter</author> |
| </properties> |
| <body> |
| <section name="Documentation Required"> |
| <p> |
| This page lists some of the most pressing documentation needs. If you feel something is missing, please be sure |
| to let us know at the |
| <a href="/mail-lists.html">Maven Users Mailing List</a>. |
| </p> |
| <h4>Documentation for users</h4> |
| <ul> |
| <li>new SNAPSHOT handling - |
| <i>partially done on Brett's blog</i> |
| </li> |
| <li>guide to dependencies, including: |
| <ul> |
| <li>dependency scoping - <i>especially system scope</i></li> |
| <li>version range specifications</li> |
| <li>conflict resolution</li> |
| </ul> |
| </li> |
| <li>deployment mechanism</li> |
| <li>dependency management</li> |
| <li>plugin management - |
| <i>in progress by J Matthew Pryor and John Casey</i> |
| </li> |
| <li>plugin configuration</li> |
| <li>plugin downloading - |
| <i>partial on Brett's blogs</i> |
| </li> |
| <li>report generation</li> |
| <li>project inheritence and company wide strategy</li> |
| <li>plugin documentation</li> |
| <li>using POM-properties in conjunction with plugin configuration to abstract child-POM configs</li> |
| <li>archetypes - writing and using</li> |
| <li>plugin usage guide/summary for core plugins - <i>esp. release plugin</i></li> |
| <li>strategy for migrating from Ant builds</li> |
| <li>strategy for migrating from Maven 1.x builds - <i>esp. plugins that don't convert directly</i></li> |
| </ul> |
| <h4>Documentation for plugin authors</h4> |
| <ul> |
| <li>Beanshell examples</li> |
| <li>plugin writing guide</li> |
| <li>report writing guide</li> |
| <li>site customisation guide</li> |
| <li>common tips and tricks for accessing project/build data</li> |
| <li>guide to available parameter expressions</li> |
| <li>list of standards for submitting new plugins (minimum documentation, test coverage?)</li> |
| </ul> |
| <h4>Documentation for Maven developers</h4> |
| <ul> |
| <li>Lifecycle architecture</li> |
| <li>High level architecture, components explanation</li> |
| <li>Intro to Plexus</li> |
| <li>contributors guide (add to current and consolidate, walk through some first steps)</li> |
| </ul> |
| </section> |
| </body> |
| </document> |
| |
