My thought is this:
- documentation should be complete enough for the version that gets
released. It should be versioned according to that release, and
distributed either with it, or as a separate zip file alongside it.
This is very difficult to get from the wiki, so I suggest we continue
to write these in APT (as a module under the main SVN tree: archiva-
documentation).
- user-contributed content (cookbooks), faqs, and up-to-the-minute
information should be in the wiki. It should be structured, but can
be less stringently reviewed/organised. Sucking that into the site
(appropriately marked as user contributed content) is a good idea for
performance of the site. Good content from here may be absorbed into
the above documentation over time.
- for the web site itself (news, downloads, screencasts, stuff that
is not tied to any one release) - I don't mind whether it's wiki
(generated across) or stored in a separate SVN module using APT/xdoc,
or both.
- same for "developer content" that is in flux - there's obviously
stuff (that should be) generated from trunk by CI, but there's also
roadmaps and other stuff in the wiki. I'm inclined to have a separate
wiki space and publish this all to one section from multiple sources.
Does this gel with what you wanted?
Note that I already have a confluence template in the style of the
current site checked in to SVN so that we can do the cwiki thing once
set up.
Cheers,
Brett
On 25/09/2007, at 2:23 AM, Joakim Erdfelt wrote:
OK, I answered one of my questions just fine.
http://cwiki.apache.org/ACTIVEMQ/ == http://activemq.apache.org/
That's what I'd like to accomplish for Archiva too.
- Joakim
Joakim Erdfelt wrote:
A few questions, possible tweaks to this.
1) Why the split between ARCHIVADEV and ARCHIVA?
2) Is there any kind of Apache legal hiccups with the free
submittal of documentation without a CLA type document?
3) Can this cwiki be the homepage of archiva itself? Does it need
to be on cwiki.apache.org? Can't it be on http://maven.apache.org/
archiva/ ?
I would love to see us move away from the stodgy xdoc / apt way of
managing doc, to using a wiki *ANY WIKI* to be _the_ documentation
for Archiva. But I'm worried about the legal angle of it. We
probably couldn't bundle an export of the documentation into a PDF
format (for example) if it contains anonymous updates.
*shrug*
- Joakim
Brett Porter wrote:
Hi,
Archiva currently has a subsection of the Maven user's wiki,
which is a bit out of place.
I'd like to propose we create two spaces on cwiki.apache.org:
- ARCHIVADEV - for roadmap/proposals/etc. (edited by developers)
- ARCHIVA - for knowledge-base/faq type content (edited by users)
I will probably import the whole space into ARCHIVA, delete
anything not related to Archiva, then move the development pages
out. That will make it retain history, and should still be faster
than copying individual pages.
Both can use the template I already made to automatically be
generated to static HTML and be inserted into a subsection of the
Archiva site.
Thoughts?
- Brett
--
- Joakim Erdfelt
[EMAIL PROTECTED]
Open Source Software (OSS) Developer
--
Brett Porter - [EMAIL PROTECTED]
Blog: http://www.devzuz.org/blogs/bporter/
