incubator-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Trustin Lee <trus...@gmail.com>
Subject Re: storing documentation in Subversion
Date Tue, 20 Dec 2005 07:48:07 GMT
Hello David,

2005/12/20, David Crossley <crossley@apache.org>:
>
> This is a topic that i often hear, not only at new projects.
> People are not sure what needs to be stored in svn and why.
>
> A while ago, Noel raised the issue on the infra@ list. [1]
> Unfortunately not much follow-up. So i wonder if we can
> resolve it here and then document the outcome.


This is an interesting issue, and I think it has to be resolved.  Sorry that
there were no many follow-ups.


> The current operating principle is that we store all
> source content in the official revision control system.
> Some people have said that that is a dictate.
>
> That includes everything: code, configuration files,
> source content for docs, letters received, meeting minutes,
> logos, everything.


What I cannot understand is 'why ASF infra team is providing wiki' if we
have to store all source content in the official RCS?  Does this mean what
we documented in wiki can cause a problem?

We also store generated documentation in SVN.
> This makes it very easy to restore or replicate
> the websites.


This has been always a good idea, but I guess some projects are not using
this technique for now.  For example, the projects which uses Maven as a
build tool look like deploy the site to the filesystem directly.  It would
be great if there's some standardized tool many build tools support.
Otherwise, is this issue just for Ant and Maven, or should site publishing
be done manually using 'svn' or 'cvs' command?)

With the advent of new documentation management tools
> (e.g. Lenya, JackRabbit, Daisy) and their potential
> use by ASF projects for their project documentation,
> we are seeing questions about how to enable the
> storage of the sources for documentation.


I always have imagined a web-based wiki application which stores its data in
a certain directory in SVN repository.  Perhaps, we could create this kind
of backend extension for our existing CMS.  Similarily, storing bugs and
issues information could be stored in SVN repository, all in human readable
text format.  Yes, this takes a lot of time.  Am I talking too ideally? :)

Trustin
--
what we call human nature is actually human habit
--
http://gleamynode.net/

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message