On 13 Oct 2010, at 10:52 PM, Wendy Smoak wrote:
Help with the website is always welcome.
The source code for the website is here:
http://svn.apache.org/repos/asf/maven/site/trunk/
The home page is down at
http://svn.apache.org/repos/asf/maven/site/trunk/src/site/xdoc/index.xml.vm
(Most other pages are under src/site/apt).
If you need help editing/building/submitting a patch, come join us on
the dev list and ask.
(Graham, would you be okay with having your post adapted for the
website, should someone have the time and energy to work on it?)
Definitely.
I think some key points maven needs to make are these:
- "Maven already knows how to do stuff. Now step aside, and let maven
do what it has to do, don't get in maven's way".
- "You don't need to customise maven to fit your project, customise
your project to fit maven".
- "If you need to document your build, you're doing it wrong".
Maven knows how to do stuff. So do developers who know how to use maven.
If you've used maven correctly, you don't need to document anything at
all. You tell your new developer "here's the URL of the maven-
generated site, off you go".
The developer knows where on the site to find the location of the
project in SCM. The developer checks out the project. The developer
knows how to build the project. The developer knows how to obtain all
the dependencies. The developer knows how to release the project when
they're done. The developer didn't need to read a single piece of
documentation that wasn't autogenerated for your project.
As soon as you need to start documenting things, you're starting to go
wrong. Practically, you may have to document some things, such as
where to get certificates for access, but you should strive to keep
this documentation to zero or as near zero as humanly possible.
Documentation costs money to write, it costs money to read, it costs
money when someone missed the vital bit of the documentation and
things go wrong. This is where the "configuration by convention"
really shines. If you know the convention, you don't need to waste
time with documentation, troubleshooting, customisation, you just get
on with it.
Regards,
Graham
--
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscr...@maven.apache.org
For additional commands, e-mail: users-h...@maven.apache.org
