archiva-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Joakim Erdfelt <joa...@erdfelt.com>
Subject Re: [Planning] Documentation for 1.0
Date Wed, 07 Nov 2007 05:16:14 GMT


Maria Odea Ching wrote:
> The outline looks good to me (yay 1.0!)
>   

Time for a mexican wave...

     \o\ \o/ /o/

> I just have a few questions/suggestions here:
> - I assume that the proxying would fall under the "Using Archiva as a *****
> Repository" sections?
>   

Actually, the section for Proxy Connectors is the place for that.
I think we need to be careful how we use the word "proxy" in our
documentation and be clear when we refer to "proxy connector" vs
"network proxy", as they are 2 separate concepts both with the word "proxy".

> - I think  we should also include Reporting/Reports in the Users Guide
>   

Reporting, yeah!  I knew I forgot something! doh!

> - On the "Consumers" section, maybe we could also put an example on how to
> create your own consumer and plug it into Archiva? I remember doing a
> separate consumer to demonstrate how this can be done (it's in the
> archiva-sandbox).
>   

That sounds like 2 concepts.  One documenting their purpose (in the
system admin user guide) and another documenting how to create a
consumer (more appropriate in the hacking / building documents).  wdyt?

> If you need some hands with the documentation, I'd be glad to help :)
>   

Help.  Yes!  Much appreciated.
I'll be getting the outline committed and the individual pages stubbed
out as soon as possible.
Any help should be easy at that point, as there should be be a clear
place / scope defined / for the documentation.

>
> Thanks,
> Deng
>   

No ... Thank you!

- Joakim

> On 11/7/07, Joakim Erdfelt <joakim@erdfelt.com> 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
>>   joakim@erdfelt.com
>>
>>
>>     
>
>   


Mime
View raw message