[opencms-dev] Wiki for OpenCms documentation

[Jonathan Woods]

Yup, spot on.  There are several big concepts (like the VFS itself!) which
need to be explained up front, and yet which it's difficult to find out
anything about except the hard way.

A personal carp: I hope we can avoid the word 'template' wherever possible.
Partly for historical reasons, it's an over-used, mis-used word in the
OpenCms software, and the source of much confusion for newcomers, not least
because VFS resource properties are re-used in multiple contexts.  We'll
need to distinguish between 'template' as in the XML resource which provides
the starting structure/content for new xmlpage resources and 'template' as
in the JSP which acts as the view applied to a VFS resource.

Jon 

-----Original Message-----
From: opencms-dev-bounces at opencms.org
[mailto:opencms-dev-bounces at opencms.org] On Behalf Of Ron Wheeler
Sent: 31 October 2006 16:19
To: The OpenCms mailing list
Subject: Re: [opencms-dev] Wiki for OpenCms documentation

I would like to see an Overview section and some more in the installation. I
may be a bit off-base since I have almost no experience but I would love to
read the following pages if I could find them.


Overview
    OpenCMS philosophy
    OpenCMS terminology
    Introduction to the OpenCMS application structure and tools
    Introduction to OpenCMS Administration and Security
    Introduction to major features - (lots of forward references)
          Templates
          Search
          XML Content
    Alternative site structures
    Planning and documenting your site

Installation
    Finding and installing the prerequisites (could reference the OpenCMS
documentation which is pretty good)
    Database choices and  Custom DB Driver Installation/Setup
    Post-installation checkout
    Creating a new site
    Removing OpenCMS documents and non-essential components - What to keep?
    Securing the site - implementing your security policy
    Removing opencms/opencms/ with APache + modjk (or mod_proxy)
    MultiSite configuration instructions
    Load Balancing with Alkacon Clustering OCEE

Ron

Marcus Popetz wrote:
> 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.
>
> 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
>
>
> Template Developement:
>   ???  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?)
>
> XMLContent
>    Basics
>    Creating a new type
>    Custom add/remove scripts
>    Hooking xml content properties up to opencms file properties
>    Display examples
>
>
> Search
>    Configuration
>    Sample search results pages
>
> Performance Tuning
>    Static Export configuration
>    Flex Cache tuning
>
> ?Basic Admin?:
>    Scheduled tasks config
>
> 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
>
>

_______________________________________________
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