[opencms-dev] Wiki for OpenCms documentation

[Joachim Zittmayr]

On Tue, 31 Oct 2006 10:07:00 -0500, "Marcus Popetz"
<marcus at roundpeg.com> said:
> On 10/31/06, Joachim Zittmayr <joachim at imap.cc> wrote:
> > so imho an oc-wiki needs some wiki-gods that keep track on all the
> > changes and (re)organize new, changed articles.
> > if u need volunteers for administering and clustering the wiki, i'll be
> 
> It would probably be good to have a discussion about how to organize
> the initial documentation.

yepp! copy that!

> I can see the following from my experience, with an additional
> MoreDocsNeedOn section in each section for people to list things
> they'd like to see more documentation on but don't have the ability to
> write themselves.  Sorta a voting system for where to spend time
> documenting things?
> 
> Installation/Setup/Configuration
>    Removing opencms/opencms/ with APache + modjk
>    Custom DB Driver INstallation/Setup
>    MultiSite configuration instructions
>    Load Balancing with Alkacon Clustering OCEE

i would separate installation and configuration, since the configuration
topic itself is big enough.
so maybe:

installation & setup:
    - basics and overview
    - app server related topics (tomcat, jetty, jboss, websphere,
    etc...)
    - Custom DB Driver INstallation/Setup
    - building from scratch

configuration & customization
    - opencms-xml-system-configs explained
    - advanced module config
    - action classes
    - making it ROOT-App (tomcat related)
    - Removing opencms/opencms/ with APache + modjk (apache related)
    - MultiSite configuration instructions
    - Load Balancing with Alkacon Clustering OCEE
    - Static Export configuration

integration
    - spring
    - hibernate
    - jbpm
    - mvnForum
    - other j2ee stuff
    - jmx

basic template developement:
    - basics and overview (what the hell is a site?)
    - lessons learned
    - common and frequent mistakes, NPEs
    - oc-taglibrary specifics(!)
>    ???  what subsections would be break this in to?
>    Building from Scratch?
>    Using existing Template One
>    Other example templates  (wouldn't a library of tons of templates be
>    nice?)

advanced development topics
    - core stuff
    - event handling

> XMLContent
>     Basics
>     Creating a new type
>     Custom add/remove scripts

    - custom widgets
    - configuring html-editor for the OpenCmsHtml-widget
    - other xml-content-type-configuration topics

>     Hooking xml content properties up to opencms file properties
>     Display examples
> Search
>     Configuration
>     Sample search results pages

    - common mistakes
    - writing only specific xml-element-data to the lucene index
    - lucene related: writing custom analyzers, stemmers, documents
 
> Performance Tuning
>     
>     Flex Cache tuning 
> 
> ?Basic Admin?:
>     Scheduled tasks config
> 

hints & tips
    - restypes available
    - which opencms core classes to use for specific tasks
    - all the hidden stuff that's extremly helpful or just good to know

nice2haves & wishlist
    - maybe alkacon is interested, what the community would like to have


just my 2 cents!
joachim

> Thoughts?  Maybe once we bounce this around a bit, we can come up with
> enough of a basic structure to get going on the docs?
> 
> -mp
> 
> _______________________________________________
> This mail is sent to you from the opencms-dev mailing list
> To change your list options, or to unsubscribe from the list, please
> visit
> http://lists.opencms.org/mailman/listinfo/opencms-dev
-- 
  Joachim Zittmayr
  joachim at imap.cc

-- 
http://www.fastmail.fm - The way an email service should be