[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Misty Stanley-Jones commented on HHH-5441: ------------------------------------------ Hi Steve! What actionable items am I responsible for in this? -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Steve Ebersole updated HHH-5441: -------------------------------- Issue Type: Improvement (was: Bug) Summary: Create "Getting Started Guide" (was: Reorgannize documentation) -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Steve Ebersole updated HHH-5441: -------------------------------- Description: 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 was:Containing task for the various subtasks in reorgannizing the Hibernate documentation -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Steve Ebersole reopened HHH-5441: --------------------------------- -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Steve Ebersole closed HHH-5441. ------------------------------- Resolution: Fixed -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Steve Ebersole commented on HHH-5441: ------------------------------------- Thanks Misty. Couple of thoughts: # Need to watch <xi:include ... parse="text" /> : https://jira.jboss.org/browse/MPJDOCBOOK-58 # You missed my inline question for you ;) "what's the best way to refer to content in other books?". Normally I'd use a biblio, but this "other book" is the new "Hibernate Developer Guide". # Is the a specific reason you split out certain file content via xinclude, but not others? Are the other left as an exercise for me? ;) -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] 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.) -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Misty Stanley-Jones commented on HHH-5441: ------------------------------------------ As for moving on to the next tutorial, reference them backward and forward. At the end of one chapter, include an <xinclude> to the next chapter. At the beginning of each chapter, include a link backward with a note that this example builds upon the previous one and changes the way that things are done. Does that approach make sense here? -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Steve Ebersole updated HHH-5441: -------------------------------- Fix Version/s: (was: 3.6.0.Beta3) 3.6.0.Beta4 -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Steve Ebersole commented on HHH-5441: ------------------------------------- Misty, wrt your comment about creating an examples.zip for the tutorials, I am ok with that in general *but* I still have the same versioning question I have asked before in relation to other things. Namely, how can I "link" the examples from say 3.6.1 from the documentation for 3.6.1 *without hardcoding the version into the documentation content*? I'd love to extract that stuff out into a zip because it (a) makes the doc much more concise and (b) makes it easier on the user. But, I am a little leery because of the above. -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Steve Ebersole updated HHH-5441: -------------------------------- Fix Version/s: (was: 3.6.0.Beta4) 3.6.0.CR1 Moving the overall task to CR1 because I still need to do the envers tutorial. The rest of the content is done -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira

[ http://opensource.atlassian.com/projects/hibernate/browse/HHH-5441?page=c... ] Steve Ebersole closed HHH-5441. ------------------------------- Resolution: Fixed -- 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.... - For more information on JIRA, see: http://www.atlassian.com/software/jira