db-jdo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andy Jefferson (JIRA)" <j...@apache.org>
Subject [jira] Created: (JDO-537) Upgrade Apache JDO site to encompass user-level documentation/guides etc
Date Sat, 29 Sep 2007 17:44:50 GMT
Upgrade Apache JDO site to encompass user-level documentation/guides etc
------------------------------------------------------------------------

                 Key: JDO-537
                 URL: https://issues.apache.org/jira/browse/JDO-537
             Project: JDO
          Issue Type: Improvement
          Components: site and infrastructure
            Reporter: Andy Jefferson
            Assignee: Andy Jefferson
             Fix For: JDO 2 maintenance release 1


The Apache JDO site is good as far as it goes, but is typically at a developer level. The
vast majority of users don't read the JDO specification, and certainly not in any detail.
It would benefit from a revamp to take on user-level docs describing basic JDO terminology
such as PersistenceManager, PersistenceManagerFactory, JDOQL, Extents etc etc. In addition
some simple worked examples would aid uptake. The JPOX site already has a selection of such
docs at
http://www.jpox.org/docs/jdo/jdo_overview.html
and they could be moved across.


The current site is generated using Anakia, but would likely be more extensible and cleaner
using Maven1 site/xdoc plugins. As a demonstration of this, there is an initial Maven1 version
of the Apache JDO site at
http://www.jpox.org/apachejdo/index.html
This demo has had very little configuration, and is located there temporarily to allow feedback,
and will be removed in the future. Maven1 site/xdoc allows "navigation.xml" (to define the
side navigation), "site.jsl" (to define the velocity process of putting together top, side,
body and bottom areas on each page), and 3 CSS files to control styling, fonts and such. The
side menu can benefit from submenus with expand/collapse to aid display of large amounts of
content.


I'd anticipate adding the following side menu groups, but others may have better ideas
* Documentation - with pages for different JDO concepts PM, PMF, JDOQL, Extent, etc
* Tutorials - very simple worked examples, things like 1-1, or replication, or how to have
an M-N with attributes

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message