You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by jv...@apache.org on 2002/03/22 16:12:59 UTC
cvs commit: jakarta-turbine-maven/xdocs musings.xml references.xml
jvanzyl 02/03/22 07:12:59
Modified: xdocs musings.xml references.xml
Log:
Cleaning up the docs.
Revision Changes Path
1.16 +52 -38 jakarta-turbine-maven/xdocs/musings.xml
Index: musings.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/musings.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- musings.xml 21 Mar 2002 19:15:03 -0000 1.15
+++ musings.xml 22 Mar 2002 15:12:58 -0000 1.16
@@ -15,14 +15,15 @@
</p>
<ul>
<li>
- figure out how to specify that aspects are required. i would like
+ Figure out how to specify that aspects are required. I would like
to be able to make a huge reactor that the aspectj team can use to watch
- the development of ajc.
+ the development of the AspectJ compiler.
</li>
<li>
Repository log analyser. Right now we have Juan's RCS file parser so
what would be the best way to leverage that tool. It would be great
- to have graphs of the the activity to see where the action is.
+ to have graphs of the the activity to see where the hot spots are
+ in the project's development.
</li>
<li>
Integrate JRefactory to do some source formatting according to a
@@ -30,25 +31,22 @@
JRefactory and other tools like that work from some sort of
source defintion. I believe the project object model can
store this information and we can make little adapters to
- work with the various configuration file formats for the
+ work with the various configuration file formats for the
various tools that are availble for use.
</li>
<li>
- audit
- </li>
- <li>
- The integration of Quilt.
- David Peugh's is working on this and Quilt is available
+ The integration of Quilt.
+ David Peugh's is working on this and Quilt is available
<a href="http://quilt.sourceforge.net/">here</a>.
</li>
<li>
- indexing tool for javadocs. search the repositories for code
- that might be useful.
- </li>
- <li>
Javadoc parsing has been added to the parser in Maven and it would
be awesome to produce a javadoc indexing tool to help make it
- easy to search through a lot of Javadocs.
+ easy to search through a lot of Javadocs. David Flanagan has a
+ tool called Jude which has been at version 0.9 for the last three
+ years. It is very functional and uses an Antlr parser so maybe he
+ would like to donate the code to Maven where it can be further
+ developed.
</li>
<li>
Find all unreferenced files in a project so that developers know
@@ -61,7 +59,9 @@
<li>
When doing large builds consult .cvspass in order to find overriding
values. at least make this the default. We want it to be easy for
- people to use existing configurations where possible.
+ people to use existing configurations where possible. In the same
+ vein use the configuration mechanism for any of the SCM systems
+ eventually.
</li>
<li>
Before warning users about jar that can't be distributed, check to make
@@ -70,15 +70,16 @@
<li>
Figure the scenerio where the project must generate sources before
building. We have some crappy deps in the fulcrum build that need
- to be cleaned up.
+ to be cleaned up. The dependencies between the targets need to
+ be well defined and documented.
</li>
<li>
The use of profiles for testing like we have in the tdk and torque.
- how they can be made to work easily for developers working in
+ How they can be made to work easily for developers working in
different environments. We also want to be able use multiple
profiles for testing so that a single developer can test
- several scenerios plus if you have a testing machine for say
- something like Turbine the profiles could get very sophisticated.
+ several scenerios. Also, if you have a testing machine for, say,
+ Turbine the profiles could get very sophisticated.
You may want to test multiple servlet containers using multiple
databases and you just want to cycle through the whole slew
of profiles looking for problems.
@@ -90,23 +91,23 @@
can't currently deploy the site because of this.
</li>
<li>
- integrate a simple link checker for the generated site so that
+ Integrate a simple link checker for the generated site so that
it is internally consistent.
</li>
<li>
- we need an easy way to access information from the project descriptor
+ We need an easy way to access information from the project descriptor
and we can't assume that the source of the information is an XML
file. We should access the object model directly. We would like to
be able to publish a site if the build is being controlled from
a database. So we might want to revisit the the way the DVSL works
- and create the documents from the object model and not the XML
+ and creates the documents from the object model and not the XML
file directly. We started out with the storage of the model in XML
- form because it's easy but we don't want to box ourselves in. I
- want to use Maven as a prototypical Turbine 3 application that
- is controlled at the application model level and I'm going to
+ form because it's easy but we don't want to box ourselves in.
+ Maven will be used as a prototypical Turbine 3 application that
+ is controlled at the application model level and we're going to
use OJB to store the project object model in various places using
the various persistence brokers available in OJB.
-
+
One simple example is being able to reuse the description from the
project descriptor in the documentation. The description, which would
be available as $project.description in the velocity templates, could
@@ -116,11 +117,12 @@
</li>
<li>
We need to make a glossary of terms for a project and we need a notation
- that would us to link terms anywhere in the documentation to the
- glossary of terms. We have something in the Tambora documentation that
- uses javascript so we could probably steal that, or alternatively a
- non-javascript solution. We just need accurate linking to terms. I
- started a glossary for turbine3 so we can use that as a starter.
+ that would allow us to link terms anywhere in the documentation to the
+ the definition of those terms in the glossary. We have something in the Tambora
+ documentation that uses javascript so we could probably steal that, or alternatively a
+ non-javascript solution can be employed. We just need accurate linking to terms.
+ A glossary for terms has been started for turbine3 so we can use that as an
+ example to start from.
</li>
<li>
Integration with Scarab, how to make setting up Scarab easy for
@@ -132,13 +134,13 @@
</li>
<li>
Integration with these other tools obviously point to a plugin type
- mechanism for adding different tools so I'm going to work on a small
+ mechanism for adding different tools so we're going to work on a small
API based on the project object model so that tools can be easily
added to plug in new tools.
</li>
<li>
Distributing a dependency graph resource that will allow a project
- to state its direct dependencies and allow the consulation of the stored
+ to state its direct dependencies and allow the consulation of the stored
dependency graph to find the indirect (run-time) dependencies because
you cannot force a project to keep track of another project's dependencies
because it's just not manageable.
@@ -149,7 +151,7 @@
tools to reverse engineer a project to produce UML diagrams.
</li>
<li>
- How to get subscribers to the various mailing lists. So we need some
+ How to get the number of subscribers to the various mailing lists. So we need some
sort of adapter to get at various systems like mailman or ezmlm.
</li>
<li>
@@ -158,10 +160,10 @@
</li>
<li>
A Java graphing package so that we can implement some of Tufte's
- ideas in graphical form. Is SVG a wise choice, does a browser need
- a plugin or is there an easy way to convert images. JGraph will
- produce SVG of a graph so we would need an easy way to convert
- it to an easily viewable image.
+ ideas in graphical representation of large data sets. Is SVG a wise
+ choice? does a browser need a plugin or is there an easy way to convert
+ SVG to common image formats. JGraph will produce SVG of a graph so we
+ would need an easy way to convert it to an easily viewable image.
</li>
<li>
Do we need to abstract out Ant so that projects can be built with
@@ -175,6 +177,18 @@
<li>
How to integrate @todo items that are listed in the source with
todos that are unrelated to currently existing source files.
+ </li>
+ <li>
+ A common format for project usecases. Scarab has made a start here so that
+ would be good to integrate.
+ </li>
+ <li>
+ A common format for a project roadmap. Take a look at some formats
+ provided by the Unified Software Development Process.
+ </li>
+ <li>
+ How to easy link to references. The same mechanism that is used to
+ link entries in the glossary can be used.
</li>
</ul>
</section>
1.4 +39 -2 jakarta-turbine-maven/xdocs/references.xml
Index: references.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/references.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- references.xml 5 Mar 2002 17:19:35 -0000 1.3
+++ references.xml 22 Mar 2002 15:12:58 -0000 1.4
@@ -9,7 +9,7 @@
<body>
<section name="References"/>
-
+
<references>
<reference>
@@ -22,6 +22,33 @@
</reference>
<reference>
+ <id>[Alexander, Timeless]</id>
+ <author>Alexander, Christopher</author>
+ <title>The Timeless Way of Building</title>
+ <location></location>
+ <publisher></publisher>
+ <date></date>
+ </reference>
+
+ <reference>
+ <id>[Alexander, Pattern]</id>
+ <author>Alexander, Christopher</author>
+ <title>A Pattern Language</title>
+ <location></location>
+ <publisher></publisher>
+ <date></date>
+ </reference>
+
+ <reference>
+ <id>[Alexander, Oregon]</id>
+ <author>Alexander, Christopher</author>
+ <title>The Oregon Experiment</title>
+ <location></location>
+ <publisher></publisher>
+ <date></date>
+ </reference>
+
+ <reference>
<id>[Beck, XP]</id>
<author>Beck, Kent</author>
<title>eXtreme Programming eXplained: Embrace Change</title>
@@ -56,7 +83,17 @@
<publisher>Addison-Wellsely</publisher>
<date>1998</date>
</reference>
-
+
+ <reference>
+ <id>[]</id>
+ <author></author>
+ <title>Unified Software Development Process</title>
+ <location>Reading, MA</location>
+ <publisher>Addison-Wellsely</publisher>
+ <date></date>
+ </reference>
+
+
</references>
</body>
</document>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>