[hibernate-issues] [Hibernate-JIRA] Commented: (HHH-5441) Create "Getting Started Guide"

[Misty Stanley-Jones (JIRA)]

    [ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=38085#action_38085 ] 

Misty Stanley-Jones commented on HHH-5441:
------------------------------------------

1. Do you mean the DTD stuff? I think it's OK to have it in, if it needs to be in the customer's file too. Maybe I'm missing something.
2. I think the best way right now is to name the book and point to the main Hibernate documentation download page. Use <citetitle> for the name of the book. You'll notice which parts I've touched because I have my editor set up to wrap at 80 columns. I rewrap paragraphs I work on. This helps with diffs later on.
3. I only got a little over halfway through the file. Today is my RHCE so I'm a little stressed. I think that all code should be in separate files, for ease of maintenance (you can give it to a developer to review, without him having to wade through Docbook to get to it, and your editor can properly indent it.)

> Create "Getting Started Guide"
> ------------------------------
>
>                 Key: HHH-5441
>                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441
>             Project: Hibernate Core
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Steve Ebersole
>            Assignee: Steve Ebersole
>             Fix For: 3.6.0.Beta3
>
>          Time Spent: 13m
>  Remaining Estimate: 0h
>
> High-level TOC
> - Preface (eventually (?DITA?) share this between the Getting Started Guide and the Developer Guide)
> - Engaging the Hibernate community
> - Obtaining Hiberate
> -- SourceForge release bundles
> -- Maven repository
> --- Discussion of artifacts and relationships between them
> - Native API tutorial
> - Annotations tutorial
> - EntityManager/JPA tutorial
> - Envers tutorial

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://opensource.atlassian.com/projects/hibernate/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira