Good day,
Maybe, under the "Introduction" section should be something like this:
- Introduction
- Overview ( what archiva is and what is solves )
- Quickstart
- Download *(we should make tar.gz, tar.bz2, zip, and war
all available)*
- Running it ( *with the default web server, db, etc
...then just point to the "System Administrator's Guide" for more info
*)
Also, maybe the "Users Guide" should come first before the "System
Administrators Guide" for two reasons:
(a.) so that new users can already start playing with it, and
(b.) This would probably be viewed more for its "Users Guide" than for its
"System Administrators Guide".
And lastly, I think there should be a "Community" and "How to contribute"
sub-section in the "Reference" which would contain, the IRC, ML/forums, etc
of the project. The "Community" information is one of the things I look for
in an opensource project, so that I know where to direct my questions. And
the "How to contribute" section would be nice as well not only for patches
but for wiki as well :-)
Just my 2 cents worth :-)
- Franz
On Nov 7, 2007 2:44 AM, Joakim Erdfelt <[EMAIL PROTECTED]> wrote:
> I'm back to the planning and writing of the documentation for 1.0 ...
>
> I'd like to bounce the outline off of everyone to see if there are any
> gaps / holes / completely idiotic decisions.
>
> *[Outline]*
>
>
> - Introduction
> - Download *(we should make tar.gz, tar.bz2, zip, and war all
> available)*
> - System Administrators Guide
> - Structure of Archiva. *(the filesystem reqs, database reqs,
> jndi usage, etc ...)*
> - Installing
> - Installing Standalone
> - Installing on Jetty.
> - Installing on Tomcat.
> - Installing on Geronimo.
> - *(any others that we have documented anywhere?)*
> - Databases
> - Embedded Derby DB
> - Using MySQL
> - Using Postgres *(not even sure this works)*
> - Security
> - Roles
> - Configuring for LDAP. *(I'll need Jesse's help here)*
> - WebDAV features
> - Runtime Configuration
> - Repositories
> - Proxy Connectors
> - Network Proxies
> - Consumers
> - Users Guide
> - Browsing.
> - Searching.
> - WebDAV Features.
> - Using Archiva as a Maven 2 repository.
> - Using Archiva as a Maven 1 repository.
> - Using Archiva as an Ivy repository.
> - Deploying Artifacts to Archiva using Maven 2.
> - Deploying Artifacts to Archiva using Maven 1.
> - Deploying Artifacts to Archiva using Ant.
> - Reference
> - FAQ. *(not sure what goes in here that isn't in the above
> sections, unless its just a list of topics / titles with links to the
> other
> content)*
> - Building / Hacking.
> - Mailing Lists.
> - Development Team.
> - Java APIDoc (javadoc).
> - Source Cross Reference.
> - Test Cross Reference.
>
> Input / Comments / Hate Mail / General Nitpicks / Completely Different
> Approaches are all welcome.
>
> --
> - Joakim Erdfelt
> [EMAIL PROTECTED]
>
>
