Dave Johnson wrote:
On 6/8/06, Allen Gilliland <[EMAIL PROTECTED]> wrote:
Just poking around a bit more and I noticed that there are some various
bits of documentation stuff that are thrown into the application context
during build time. Thinks like ...
docs/*
I strongly object to removing the docs from the webapp. The docs for
the current version of the app should be made available within the
app. The should be moved to roller-ui so they are not polluting the
URL space.
I am fine with that. In general I think the issue with docs is a coin
flip for me. On one hand I definitely see the benefits of including the
docs in a browsable location of the app with each release. However, on
the flip side there is something to be said for not polluting the webapp
with things that people don't really need, we can package the docs in
the bundle and not in the webapp and if people want to move them into
the app then they can do so. there is also something to be said for
maintaining online documentation in a central location like
roller.apache.org/docs and not duplicating those docs over and over again.
CHANGES.txt
LICENSE.txt
NOTICE.txt
README.txt
I definitely believe these things should be part of the bundle that
people download when they get a release, but I don't think they should
actually be inside the webapp itself and therefore made available for
Right now the release is self-contained in a directory called "roller" and
I'd really like to keep it that way if at all possible.
i don't understand this comment. i consider the "release" and the
"webapp" to be 2 different things. the webapp is just what gets run in
the container, i.e. what you get in build/roller. the release is the
webapp plus whatever else we think is useful, typically like legal
notices, docs, examples, plugins/addons, etc.
unless i am thinking of the wrong directory then i believe you are just
talking about the "roller" webapp directory right?
i don't think we should plan to keep everything in there. i think that
directory is where we build the webapp from, but there should be another
directory that represents a release package, which would include the webapp.
people to browse to when the app is deployed. Many (maybe most/all?)
sites do not care to have that stuff inside that actually deployed
webapp.
I object here too. These should be part of the app, but they don't
need to be browsable, so they could be moved into WEB-INF.
really? I feel like that is against standard operating procedures. My
take on most app downloads is that you would get something like this ...
roller-x.y.z/
roller-x.y.z/CHANGES.txt
roller-x.y.z/LICENSE.txt
roller-x.y.z/NOTICE.txt
roller-x.y.z/README.txt
roller-x.y.z/bin/*
roller-x.y.z/docs/*
roller-x.y.z/plugins/*
roller-x.y.z/examples/*
roller-x.y.z/extras/*
roller-x.y.z/lib/*
roller-x.y.z/src/*
roller-x.y.z/roller.war (or we can do dist/roller?)
we don't necessarily have/need all those dirs, but you get the idea.
I don't see why all the legal/copyright/etc stuff needs to be inside the
deployed application? Nobody is going to look at it there. Plus it
would be duplicated assuming we include it at the root of the package as
well.
I think the same basically applies for the docs. Supposedly we want
people to look at the docs *before* deploying the application, and
that's why it makes sense that they exist outside the app.
-- Allen
- Dave
