Re: [eclipselink-users] EclipseLink 2.1 Documentation Proposal

["polly.c.chang" <polly.c.chang@xxxxxxxxx>]

Hurray!  Thank you so much for working on creating a new user guide.  I
experience much pain and anguish when trying to use the current one.  ;)

We also use DocBook for our company's internal documentation.  It was kind
of hard to adjust to at first, but we are used to it now, and the
documentation *is* a lot easier to maintain.  I see that you have a
procedure for using OpenOffice to edit the files.  I tried to use OpenOffice
before but couldn't get it to work.  I see that I was missing a few steps. 
So thanks for posting your process.  I'll give that a try too.

Thanks,
Polly 


djclarke wrote:
> 
> EclipseLink Committers and Users,
> 
> Based on community feedback we have decided that we should make some
> efforts to improve the EclipseLink User Guide (ELUG) currently hosted on
> the Eclipse Wiki @ http://wiki.eclipse.org/EclipseLink/UserGuide. This
> initial ELUG was based on the contribution of the original Oracle TopLink
> manual(s) converted directly into wiki content. While this was a great way
> to get started it does have some usability issues and contains older
> content that does not align with our current development efforts.
> 
> Our goal is address the requirements we have identified at
> http://wiki.eclipse.org/EclipseLink/Development/Documentation/Requirements.
> 
> Our proposed solution is to author new user guides using an open XML based
> content format with the content managed within the EclipseLink SVN
> repository. The format will be DocBook XML files. We are looking for
> feedback on the approach as well as recommendations, suggestions, best
> practice experience and of course contributors.
> 
> The first guide we propose creating is for EclipseLink JPA. We have
> started brain-storming a table of contents here:
> http://wiki.eclipse.org/EclipseLink/Development/Documentation/JPA
> 
> Please get involved with this important process and provide your feedback
> on the eclispelink-dev@xxxxxxxxxxx mailing list or on the discussion pages
> for the provided requirement and JPA guide wiki pages.
> 
> Cheers,
> 
> Doug
> 
> 
> _______________________________________________
> eclipselink-users mailing list
> eclipselink-users@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/eclipselink-users
> 
> 

-- 
View this message in context: http://old.nabble.com/EclipseLink-2.1-Documentation-Proposal-tp26831672p26849962.html
Sent from the EclipseLink - Users mailing list archive at Nabble.com.