Dave Johnson wrote:
On 6/8/06, Allen Gilliland <[EMAIL PROTECTED]> wrote:
Dave Johnson wrote:
> Right now we just ship two things 1) the self contained webapp and
> 2) the source release. To run Roller all you need is #1. I don't see a
> compelling reason to change that yet. Plus, I believe that docs and
> license/notices should be embedded in the app.
I see. Well, my opinion is that's kinda "eh". I prefer a more standard
bundle for a number of reasons ...
I'm curious, what open source webapps have you looked at that use
this standard directory structure?
hmmm, well there's these ...
apache-ant-1.6.3/
commons-httpclient-2.0.2/
commons-lang-2.1/
hibernate-3.0/
jakarta-jmeter-2.0.3/
jakarta-log4j-1.2.8/
jakarta-struts-1.1/
jakarta-taglibs-standard-1.1.2/
javamail-1.3.1/
mysql-connector-java-3.0.14-production/
... and that's just a quick selection from the packages i have currently
exploded on my workstation. all of them follow 2 simple conventions
which i think we should use as well ...
1. the expoloded package contains the version number.
2. the package contains a simple directory structure which includes
ALLCAPS files at the root, plus docs and other dirs with the rest of the
files.
1. It's 100% essential that we start marking releases with version
numbers. When you tar/gzip the package it should come out in a
directory such as roller-x.y.z.
I don't think it's 100% essential.
I was being overly dramatic, but I still think there is almost no good
reason not to do that.
2. As we have been discussing there are certainly things that belong in
the downloadable package but not in the webapp itself.
I still think docs, and even the install doc, belongs in the webapp
and should be browsable. I also believe license/notice file belongs
embedded in the app itself.
This can be debated all day, so maybe someone from ASF can offer any
suggestions based on how other ASF projects usually do it?
3. Eventually we should package as a .war file and not just a directory
tree for the app, and in that case it makes more sense to have an actual
bundle with the .war included, rather than making the .war the only
distribution.
Yes, .war packaging is a good thing.
4. Using a bundle gives us much more flexibility to include other things
that may be useful to the user, but which shouldn't really be directly
included in the core webapp. themes? plugins? editors?
I'd prefer to make themes, plugins and editors available separately,
but I do agree that there will be some other things that belong there.
I agree, they should be separate, i was mainly using it as an example.
The point is that there are things that should be part of the
downloadable Roller distribution that don't belong in the webapp.
I don't really think it's ideal to only package the webapp for the
release and then end up having to put things in the webapp which
shouldn't be there so that that they are in the download. It's not that
hard to setup a very simple structure for the download bundle and make
it part of the build process. I am more than willing to do this.
If you have time to do that and to update the install / dev guide
accordingly,
then please write up a short proposal for the new release dir structure.
Affirmative.
-- Allen
- Dave
