You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Stan Bradbury (JIRA)" <de...@db.apache.org> on 2006/02/02 20:58:03 UTC

[jira] Created: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

[WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
------------------------------------------------------------------------------------------------------------------------

         Key: DERBY-913
         URL: http://issues.apache.org/jira/browse/DERBY-913
     Project: Derby
        Type: Improvement
  Components: Documentation  
    Versions: 10.2.0.0    
    Reporter: Stan Bradbury
 Assigned to: Stan Bradbury 


I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: SRC-Review-Ch3-4rv1.1.zip
                Review-WWD-Ch3-4rv1.1.zip

Chapters 3 and 4 (Activites 2 and 3) - Revision based on review and feedback of initial drafts March 23.  Significant rewrite to Chapter 4 (original draft ~750 word - rv1.1 ~1325 words)

SRC-Review-Ch3-4rv1.1.zip - DITA files needed to build just chapters 3 and 4 with REVIEW title

Review-WWD-Ch3-4rv1.1.zip - PDF document and program files needed for the activities

Please post comments to derby-user.  

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf, workingwithderby0306.pdf, wwdDitaSrc0306_Ch1and2.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Commented: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Jean T. Anderson (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-913?page=comments#action_12375664 ] 

Jean T. Anderson commented on DERBY-913:
----------------------------------------

Only the new Working With Derby doc fails to build on Linux, the other Derby docs build successfully, so perhaps there's a subtle difference in how the new files are set up. I see the failure on Fedora Core 3 and Suse.

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf, workingwithderby0306.pdf, wwdDitaSrc0306_Ch1and2.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Commented: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Jean T. Anderson (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-913?page=comments#action_12376606 ] 

Jean T. Anderson commented on DERBY-913:
----------------------------------------

Committed COMMITwwdCh1-4.diff, revision 397327.
I made one more change to the build.xml for Linux, modifying the value parameter on line 176 from
"workingwithderby.fo" to "WorkingWithDerby.fo", and 'ant all' now succeeds.

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: COMMITwwdCh1-4.diff, CheckCommitWWD-Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: COMMITwwdCh1-4.diff
                CheckCommitWWD-Ch1-4.pdf

Attempt two (tested and working): Patch to add
CH 3 and 4,  update Ch 1 and 2 and update build.xml so the WWD doc builds properly on case sensative systems like Linux.

COMMITwwdCh1-4.diff - the DIFF to patch the codeline
CheckCommitWWD-Ch1-4.pdf - the PDF file generated from the fileset - can be used to view / validate the changes.

The SVN Staus output after applying the PATCH and performing the 'svn add' s

  stan.test/trunk> svn status
?      COMMITwwdCh1-4.diff
M      src/workingwithderby/WorkingWithDerby.ditamap
M      src/workingwithderby/twwdIntro.dita
M      src/workingwithderby/twwdactivity1.dita
M      src/workingwithderby/twwdactivity1_Setup.dita
A      src/workingwithderby/rwwdactivity3.dita
A      src/workingwithderby/twwdactivity2.dita
A      src/workingwithderby/twwdactivity3_Setup.dita
M      src/workingwithderby/cwwdactivities.dita
M      src/workingwithderby/rwwdcopyright.dita
M      build.xml

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: COMMITwwdCh1-4.diff, CheckCommitWWD-Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: workingwithderby0306.pdf)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: 4COMMIT_wwd_Ch1-4.diff, 4COMMIT_wwd_Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: WWDditaSrc0220.zip)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: 4COMMIT_wwd_Ch1-4.diff, 4COMMIT_wwd_Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: WorkingWithDerbyV1.1.html)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: 4COMMIT_wwd_Ch1-4.diff, 4COMMIT_wwd_Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: 4COMMIT_wwd_Ch1-4.diff)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Resolved: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury resolved DERBY-913.
---------------------------------

    Fix Version/s: 10.2.0.0
       Resolution: Fixed

Document was completed and committed to the documents codeline on May 22.  Subtask for contributing the associated demonstartion programs and build file modifications is ready for commit.  No further work needed. Will close this issue when 10.2 is released. 

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>                 Key: DERBY-913
>                 URL: http://issues.apache.org/jira/browse/DERBY-913
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.2.0.0
>            Reporter: Stan Bradbury
>         Assigned To: Stan Bradbury
>             Fix For: 10.2.0.0
>
>         Attachments: CheckCommitWWD-Ch1-4.pdf, COMMIT_Complete_WWD.diff, COMMITwwdCh1-4.diff, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, ReviewPDF_wwdCh5and6rv1.0.zip, ReviewSRC_wwdCh5and6rv1.0.zip, SRC-Review-Ch3-4rv1.1.zip, WWD_Complete_BuiltDocsAll.zip, WWD_Complete_DitaSrc.zip, WWD_Complete_WorkingWithDerby.pdf
>
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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

        

[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: WorkingWithDerbyV1.1.html

Revised Proposal and Outline/Topic list for Working with Derby (revision 1.1).
I want to thank Kathy Saunders and Jean Anderson for their help in brainstorming the simplified flow and easier to understand topic presentation represented by this revision.   Please download revision 1.1 of the WWD proposal and let me know what you think.  

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDhtml0220.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: WWDditaSrc0222.zip
                workingwithderby0222.pdf

Revision of Ch 1 and 2 (v0222).  DITA source files (WWDditaSrc0222.zip)and generated PDF review document (workingwithderby0222.pdf) for Chapters 1 and 2 of Working With Derby. Please review and provide to feedback to derby-user@db.apache.org with the subject line beginning [WWD]. 
Revision 0222 was made based on the feedback presented in this message: http://mail-archives.apache.org/mod_mbox/db-derby-user/200602.mbox/%3c43FAA7C9.5040200@apache.org%3e

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDhtml0220.zip, WorkingWithDerbyV10.html, workingwithderby0222.pdf
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: WWDditaSrc0323.zip)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Commented: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Jean T. Anderson (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-913?page=comments#action_12412843 ] 

Jean T. Anderson commented on DERBY-913:
----------------------------------------

Committed patch COMMIT_Complete_WWD.diff, revision 408786.

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: COMMIT_Complete_WWD.diff, COMMITwwdCh1-4.diff, CheckCommitWWD-Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, ReviewPDF_wwdCh5and6rv1.0.zip, ReviewSRC_wwdCh5and6rv1.0.zip, SRC-Review-Ch3-4rv1.1.zip, WWD_Complete_BuiltDocsAll.zip, WWD_Complete_DitaSrc.zip, WWD_Complete_WorkingWithDerby.pdf
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: COMMIT_Complete_WWD.diff

FOR COMMIT:
Codeline patch containing the completed Working With Derby files, revision 1.0
.  
File name: COMMIT_Complete_WWD.diff
Patch has been tested as follows:
  - Applied patch to codeline on Linux without problem
  - Preformed build of complete document set

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: COMMIT_Complete_WWD.diff, COMMITwwdCh1-4.diff, CheckCommitWWD-Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, ReviewPDF_wwdCh5and6rv1.0.zip, ReviewSRC_wwdCh5and6rv1.0.zip, SRC-Review-Ch3-4rv1.1.zip, WWD_Complete_BuiltDocsAll.zip, WWD_Complete_DitaSrc.zip, WWD_Complete_WorkingWithDerby.pdf
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: WorkingWithDerbyV10.html)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: 4COMMIT_wwd_Ch1-4.diff, 4COMMIT_wwd_Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Commented: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-913?page=comments#action_12367582 ] 

Stan Bradbury commented on DERBY-913:
-------------------------------------

   ==> Will resubmit modified sections and restart the review process ===
I wanted to give everyone a heads up that I'll incorporate the cool work Andrew did on http://issues.apache.org/jira/browse/DERBY-1019. To reduce confusion, I'm suspending the review.  I will be presenting a revised outline for WWD then rework the initial sections and restart the review process.


> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDhtml0220.zip, WorkingWithDerbyV10.html, workingwithderby0222.pdf
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: wwdDitaSrc0306_Ch1and2.zip
                workingwithderby0306.pdf

Version 1.2 of Chapters 1 and 2 of Working With Derby - based on the version 1.1 proposal and outline:
wwdDitaSrc0306_Ch1and2.zip - the dita source files and ditamap for Chap 1 and 2

workingwithderby0306.pdf - PDF for Review and comment:  Chap 1 and 2.

Also requesting specific feed back on the  following two items:
I would appreciate comment (support for or alternatives to) the following:

1) The basic organization of each activity (BASIC ACTIVITY FORMAT).  INTENT: The organization separates explanations (body text) from the command examples and output.  This allows people that just want to execute the commands to jump to the 'Activity Sequence' and launch into using the product without reading any explanation at all.     BASIC ACTIVITY FORMAT:
Each activity begins with a  bulleted list that describe the commands that appear in the 'Activity sequence' that follows.  The 'Activity Sequence' shows the commands and output (for most a cut-N-paste from a command shell).  Occasionally a LABEL will appear in the 'Activity Sequence' where there is a difference between Windows and Unix syntax to identify the OS the example represents. 

2) Referencing the Derby installation file path.  I see setting and using the environment variable DERBY_HOME (currently called DERBY_INSTALL) to indicate the filesystem path to the DERBY installation as the best way to provide command syntax examples (e.g.   java -jar $DERBY_HOME/derbytools.jar ij)
 With the changes made by DERBY-1019 is one of the few 'setup' steps that remain before launching into IJ.
Is there a better way?



> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDhtml0220.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf, workingwithderby0306.pdf, wwdDitaSrc0306_Ch1and2.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: 4COMMIT_wwd_Ch1-4.pdf)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: WWD_Complete_DitaSrc.zip
                WWD_Complete_BuiltDocsAll.zip
                WWD_Complete_WorkingWithDerby.pdf

Completed document source files and Generated output files in PDF, HTML multiple file and HTML book formats.  

SVN is current down so I cannot create patch for commit to the repository at this time.  Will create patch to commit the completed work when repository access is restored.

Files attached:
WWD_Complete_DitaSrc.zip
   The DITA source files for the entire document
WWD_Complete_BuiltDocsAll.zip
  Archive containing the Generated document in all three formats
WWD_Complete_WorkingWithDerby.pdf
   The Generated PDF document for easy download and review

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: COMMITwwdCh1-4.diff, CheckCommitWWD-Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, ReviewPDF_wwdCh5and6rv1.0.zip, ReviewSRC_wwdCh5and6rv1.0.zip, SRC-Review-Ch3-4rv1.1.zip, WWD_Complete_BuiltDocsAll.zip, WWD_Complete_DitaSrc.zip, WWD_Complete_WorkingWithDerby.pdf
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Commented: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-913?page=comments#action_12376592 ] 

Stan Bradbury commented on DERBY-913:
-------------------------------------

The build.xml submitted for COMMIT in file:  COMMITwwdCh1-4.diff 
will correct this problem.  DITA will post this misleading message (Content is not allowed in prolog) when the ditamap file cannot be found.  In this case the problem stemed from entering the filename in all lower-case in the build.xml (i.e. workingwithderby.ditamap) rather than the proper mixed-case format of the actual filename:  WorkingWithDerby.ditamap.

This is the misleading error posted from the ant build:

   [xslt] Loading stylesheet /home/jta/DB-DERBY-SVN/derby/docs/trunk/DITA-OT1.1.2.1/xsl/preprocess/topicpull.xsl 
     [xslt] home/jta/DB-DERBY-SVN/derby/docs/trunk/temp/dita.list:1:1: Fatal Error! Content is not allowed in prolog. 


> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: COMMITwwdCh1-4.diff, CheckCommitWWD-Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: ReviewPDF_wwdCh5and6rv1.0.zip
                ReviewSRC_wwdCh5and6rv1.0.zip

Initial reveiw files (rv 1.0) for Working With Derby Ch 5 and 6
  >> Please review and send comments to derby-user@db.apache.org.  Please code the subject line with '[WWD]'

ReviewPDF_wwdCh5and6rv1.0.zip - Contains the generated PDF and the program files needed to perform Activity 4 (Ch 5)

ReviewSRC_wwdCh5and6rv1.0.zip - The DITA source files to generate the review PDF


> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: COMMITwwdCh1-4.diff, CheckCommitWWD-Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, ReviewPDF_wwdCh5and6rv1.0.zip, ReviewSRC_wwdCh5and6rv1.0.zip, SRC-Review-Ch3-4rv1.1.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: WWDditaSrc0220.zip
                WWDhtml0220.zip

DITA source files (WWDditaSrc0220.zip)and generated HTML (WWDhtml0220.zip) for Chapters 1 and 2 of Working With Derby.  Please review and provide to feedback to derby-user@db.apache.org with the subject line beginning [WWD]. 

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: WWDditaSrc0220.zip, WWDhtml0220.zip, WorkingWithDerbyV10.html
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: WWDpdfNjava0323.zip)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: 4COMMIT_wwd_Ch1-4.diff, 4COMMIT_wwd_Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Commented: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Jean T. Anderson (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-913?page=comments#action_12374450 ] 

Jean T. Anderson commented on DERBY-913:
----------------------------------------

Committed patch FINAL_wwd_ch_1and2.diff , revision 394000, for the first two chapters.

Note: the Working With Derby doc builds fine on Windows and 'ant all' succeeds building all docs. But the new doc failed to build on a Fedora Core 3 linux machine with this error:

topicpull:
     [xslt] Transforming into /home/jta/DB-DERBY-SVN/derby/docs/trunk/temp
     [xslt] Processing /home/jta/DB-DERBY-SVN/derby/docs/trunk/temp/dita.list to /home/jta/DB-DERBY-SVN/derby/docs/trunk/temp/dita.dita.pull
     [xslt] Loading stylesheet /home/jta/DB-DERBY-SVN/derby/docs/trunk/DITA-OT1.1.2.1/xsl/preprocess/topicpull.xsl
     [xslt] home/jta/DB-DERBY-SVN/derby/docs/trunk/temp/dita.list:1:1: Fatal Error! Content is not allowed in prolog.
     [xslt] Failed to process /home/jta/DB-DERBY-SVN/derby/docs/trunk/temp/dita.list

BUILD FAILED
/home/jta/DB-DERBY-SVN/derby/docs/trunk/build.xml:117: The following error occurred while executing this line:
/home/jta/DB-DERBY-SVN/derby/docs/trunk/build.xml:168: The following error occurred while executing this line:
/home/jta/DB-DERBY-SVN/derby/docs/trunk/DITA-OT1.1.2.1/pretargets.xml:136: Fatal error during transformation

I'll try building it on a linux machine with a more current kernel.

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf, workingwithderby0306.pdf, wwdDitaSrc0306_Ch1and2.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


Re: [jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by Andrew McIntyre <mc...@gmail.com>.
On 4/26/06, Jean T. Anderson <jt...@bristowhill.com> wrote:
>
> yes; I suggest deleting 4COMMIT_wwd_Ch1-4.diff and 4COMMIT_wwd_Ch1-4.pdf
> to reduce the clutter in the attachments for DERBY-913.

I happened to remove the ability to delete attachments and comments by
non-administrators as a by-product of removing the ability to delete
issues.

I've removed the requested files and some of the other clutter related
to chapters 1 and 2 now that they have been committed.

andrew

Re: [jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Stanley Bradbury wrote:
> Jean T. Anderson wrote:
... <deleted info about patch failure>
> Hi Jean -
> I think the 'svn up' might be the problem - I performed an 'svn co' to
> refresh my local copy prior to making the changes and creating the DIFF
> - would this sync up my copy?   I will read up on these commands and may
> follow-up with more questions.  I'm a newbie to the PATCH process so
> please bear with me.

Don't worry about being a newbie -- none of us were born knowing svn.

> John pointed out a typ-O that I can also fix before creating the new
> patch.  Should I delete the original DIFF file from the JIRA issue
> because it is not correct and should not be used?

yes; I suggest deleting 4COMMIT_wwd_Ch1-4.diff and 4COMMIT_wwd_Ch1-4.pdf
to reduce the clutter in the attachments for DERBY-913.

 -jean



Re: [jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by Stanley Bradbury <St...@gmail.com>.
Jean T. Anderson wrote:

>Stan Bradbury (JIRA) wrote:
>  
>
>>     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]
>>
>>Stan Bradbury updated DERBY-913:
>>--------------------------------
>>
>>    Attachment: 4COMMIT_wwd_Ch1-4.diff
>>                4COMMIT_wwd_Ch1-4.pdf
>>
>>Document patch submitted to be committed:
>>
>>FILE:  4COMMIT_wwd_Ch1-4.diff - the patch file:
>>   Adds Chapters 3 and 4
>>   Updates Chapters 1 and 2
>>   Updates build.xml to correct build problems on Linux
>>
>>FILE:  4COMMIT_wwd_Ch1-4.pdf
>>  PDF document generated from the above patch files.  Can be used to review changes and additions.
>>    
>>
> ...
>The patch is failing with hunk failures on the build.xml, which is a
>little odd since this is just the second patch and you're the only one
>doing patches right now:
>
>   patching file build.xml
>
>   Reversed (or previously applied) patch detected!  Assume -R? [n] y
>   Hunk #2 FAILED at 36.
>   Hunk #3 FAILED at 104.
>   Hunk #4 succeeded at 154 (offset -3 lines).
>   2 out of 4 hunks FAILED -- saving rejects to file build.xml.rej
>
>Did you 'svn up' your working copy before creating the patch? I'll email
>you the build.xml.rej separately.
>
> -jean
>
>  
>
Hi Jean -
I think the 'svn up' might be the problem - I performed an 'svn co' to 
refresh my local copy prior to making the changes and creating the DIFF 
- would this sync up my copy?   I will read up on these commands and may 
follow-up with more questions.  I'm a newbie to the PATCH process so 
please bear with me.

John pointed out a typ-O that I can also fix before creating the new 
patch.  Should I delete the original DIFF file from the JIRA issue 
because it is not correct and should not be used?




Re: [jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Stan Bradbury (JIRA) wrote:
>      [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]
> 
> Stan Bradbury updated DERBY-913:
> --------------------------------
> 
>     Attachment: 4COMMIT_wwd_Ch1-4.diff
>                 4COMMIT_wwd_Ch1-4.pdf
> 
> Document patch submitted to be committed:
> 
> FILE:  4COMMIT_wwd_Ch1-4.diff - the patch file:
>    Adds Chapters 3 and 4
>    Updates Chapters 1 and 2
>    Updates build.xml to correct build problems on Linux
> 
> FILE:  4COMMIT_wwd_Ch1-4.pdf
>   PDF document generated from the above patch files.  Can be used to review changes and additions.
 ...
The patch is failing with hunk failures on the build.xml, which is a
little odd since this is just the second patch and you're the only one
doing patches right now:

   patching file build.xml

   Reversed (or previously applied) patch detected!  Assume -R? [n] y
   Hunk #2 FAILED at 36.
   Hunk #3 FAILED at 104.
   Hunk #4 succeeded at 154 (offset -3 lines).
   2 out of 4 hunks FAILED -- saving rejects to file build.xml.rej

Did you 'svn up' your working copy before creating the patch? I'll email
you the build.xml.rej separately.

 -jean

Re: [jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by John Embretsen <Jo...@Sun.COM>.
Stan Bradbury (JIRA) wrote:

>      [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]
> 
> Stan Bradbury updated DERBY-913:
> --------------------------------
> 
>     Attachment: 4COMMIT_wwd_Ch1-4.diff
>                 4COMMIT_wwd_Ch1-4.pdf
> 
> Document patch submitted to be committed:
> 
> FILE:  4COMMIT_wwd_Ch1-4.diff - the patch file:
>    Adds Chapters 3 and 4
>    Updates Chapters 1 and 2
>    Updates build.xml to correct build problems on Linux
> 
> FILE:  4COMMIT_wwd_Ch1-4.pdf
>   PDF document generated from the above patch files.  Can be used to review changes and additions.


I think you forgot to change "proper" to "properly", page 14 (Activity 
3, step 2).

Thanks,


-- 
John

[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: 4COMMIT_wwd_Ch1-4.diff
                4COMMIT_wwd_Ch1-4.pdf

Document patch submitted to be committed:

FILE:  4COMMIT_wwd_Ch1-4.diff - the patch file:
   Adds Chapters 3 and 4
   Updates Chapters 1 and 2
   Updates build.xml to correct build problems on Linux

FILE:  4COMMIT_wwd_Ch1-4.pdf
  PDF document generated from the above patch files.  Can be used to review changes and additions.

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: 4COMMIT_wwd_Ch1-4.diff, 4COMMIT_wwd_Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf, workingwithderby0306.pdf, wwdDitaSrc0306_Ch1and2.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Commented: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-913?page=comments#action_12369119 ] 

Stan Bradbury commented on DERBY-913:
-------------------------------------

Additional topics suggested by Ian Leslie to Derby-user on Feb 2, 2006
email archive URL: http://mail-archives.apache.org/mod_mbox/db-derby-user/200602.mbox/%3c163F7F1E1F71E343991916E5E3E0277F014286B4@server06.klocwork.com%3e

=== Excerpt:
  Based on the next things I searched out information on I suggest the following additional
modules:

1) A module showing a more complex example of inserting data.  Introduce
the notion of temporary tables and show how they can be used to hold
simple data so that a more complex insert can be performed to populate a
database.  I am thinking here of something with a normalized set of
tables and how to insert data such that the ids of one table join with
another.  As someone with little SQL or database experience, creating
and populating the schema for my data was challenging (I have a friend
who helped design a good schema - but I was thinking that more advanced
database example would help us novices a lot).  I had to fall back on my
friend again for the SQL to perform the loading because the insert
examples I read in the documentation were all very simple.

2) A module showing how to use update.  I have discovered that each
database uses update slightly differently.  Some non trivial examples of
update (perhaps with the more advanced database idea above) would be
helpful.

3) A module showing how to produce and then connect to a read only
database.  Same thing in a .jar'ed database.  The documentation has a
good recipe at the moment but a step by step example to build on would
be even better.

I think the modules you have already will be very interesting I simply
wanted to suggest you add a few more.



> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDhtml0220.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: workingwithderby0222.pdf)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: 4COMMIT_wwd_Ch1-4.diff, 4COMMIT_wwd_Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Commented: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-913?page=comments#action_12375662 ] 

Stan Bradbury commented on DERBY-913:
-------------------------------------

I've double checked the DITA files and it does not appear to be a syntax error in the files.  I'm guessing it is a problem with the toolkit on Linux but will need to setup a test environment to invetigate further.

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf, workingwithderby0306.pdf, wwdDitaSrc0306_Ch1and2.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: WWDpdfNjava0323.zip
                WWDditaSrc0323.zip

The newly completed chapters 3 and 4. Includes the java programs WwdEmbedded and WwdUtils.
Also included are the revisions of chapters 1 and 2  
Format Change NOTE:
Chapters 1 - 4 contain a structural change to the Basic Activity Format the descriptive text is interspersed with the example commands and output.

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf, workingwithderby0306.pdf, wwdDitaSrc0306_Ch1and2.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: FINAL_wwd_ch_1and2.diff
                FINAL_wwd_ch_1and2.pdf

  FOR SVN COMMIT:  DIFF file of the Working With Derby document Ch 1 and 2 (the Introduction and Activity 1)
  filename:  FINAL_wwd_ch_1and2.diff

FOR Review / Validation:  PDF file generated from the above DITA source files.
   filename: FINAL_wwd_ch_1and2.pdf

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf, workingwithderby0306.pdf, wwdDitaSrc0306_Ch1and2.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: WWDditaSrc0222.zip)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: wwdDitaSrc0306_Ch1and2.zip)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: 4COMMIT_wwd_Ch1-4.diff, 4COMMIT_wwd_Ch1-4.pdf, FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip, WWDditaSrc0222.zip, WWDditaSrc0323.zip, WWDhtml0220.zip, WWDpdfNjava0323.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Andrew McIntyre updated DERBY-913:
----------------------------------

    Attachment:     (was: WWDhtml0220.zip)

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement

>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: FINAL_wwd_ch_1and2.diff, FINAL_wwd_ch_1and2.pdf, Review-WWD-Ch3-4rv1.1.zip, SRC-Review-Ch3-4rv1.1.zip
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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


Re: Holistic getting started approach

Posted by Daniel John Debrunner <dj...@apache.org>.
Sunitha Kambhampati wrote:

> Daniel John Debrunner wrote:
> < snip - lots of great stuff>
> 
>> Can these jars be executed directly, I thought on windows one could
>> double-click a jar file and have it run right away, doesn't seem to
>> happen on my machine though?
>>
>>  
>>
> I found this on http://java.sun.com/j2se/1.4.2/docs/guide/jar/jarGuide.html
> 
> "On Microsoft Windows systems, the Java 2 Runtime Environment's
> installation program will register a default association for Jar files
> so that double-clicking a Jar file on the desktop will automatically run
> it with javaw -jar. Dependent extensions bundled with the application
> will also be loaded automatically. This feature makes the end-user
> runtime environment easier to use on Microsoft Windows systems"

Hmmm, javaw is going to be a problem for ij because I think it starts
with no system in/out or a console. I did try that with my ij.jar and it
just hung and could not be killed with ^C

Dan.



Re: Holistic getting started approach

Posted by Sunitha Kambhampati <ks...@gmail.com>.
Daniel John Debrunner wrote:
< snip - lots of great stuff>

>Can these jars be executed directly, I thought on windows one could
>double-click a jar file and have it run right away, doesn't seem to
>happen on my machine though?
>
>  
>
I found this on http://java.sun.com/j2se/1.4.2/docs/guide/jar/jarGuide.html

"On Microsoft Windows systems, the Java 2 Runtime Environment's 
installation program will register a default association for Jar files 
so that double-clicking a Jar file on the desktop will automatically run 
it with javaw -jar. Dependent extensions bundled with the application 
will also be loaded automatically. This feature makes the end-user 
runtime environment easier to use on Microsoft Windows systems"

On Win2k, I can/tried to register the default association for the jar 
(derbynet.jar) file with javaw.exe, but not sure how to give the 
argument -jar..  anyone know ? 

Thanks,
Sunitha.


Re: Holistic getting started approach

Posted by Daniel John Debrunner <dj...@apache.org>.
Maybe on the downloads page we could have some text/icon that indicated
which is the release people are recommended to download.

Dan.

Re: Holistic getting started approach

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Jean T. Anderson wrote:
> Daniel John Debrunner wrote:
>>Jean T. Anderson wrote:
>>
>>>The charter itself belongs in a different page that is linked to from
>>>this one. If there are no objections, I'll go ahead and make that change
>>>sometime soon.
>>
>>Sounds good, I also think the link to the proposal could be removed from
>>the links on the main page. Maybe the new charter page could just have a
>>link to the 'incubator proposal' as a historical reference.
>  
> Sounds good, thanks for the suggestion.

These changes are live at db.apache.org/derby.

 -jean

Re: Holistic getting started approach

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Daniel John Debrunner wrote:
> Jean T. Anderson wrote:
> 
> 
>>The charter itself belongs in a different page that is linked to from
>>this one. If there are no objections, I'll go ahead and make that change
>>sometime soon.
> 
> 
> Sounds good, I also think the link to the proposal could be removed from
> the links on the main page. Maybe the new charter page could just have a
> link to the 'incubator proposal' as a historical reference.

Sounds good, thanks for the suggestion.

 -jean


Re: Holistic getting started approach

Posted by Daniel John Debrunner <dj...@apache.org>.
Jean T. Anderson wrote:

> The charter itself belongs in a different page that is linked to from
> this one. If there are no objections, I'll go ahead and make that change
> sometime soon.

Sounds good, I also think the link to the proposal could be removed from
the links on the main page. Maybe the new charter page could just have a
link to the 'incubator proposal' as a historical reference.

Dan.


Re: Holistic getting started approach

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Øystein Grøvlen wrote:
> Jean T. Anderson wrote:
>  ...
> If you look at the home pages for Torque or PostgreSQL you immediately
> get the feeling that these are home pages for a software products.  I
> think our homepage more gives the impression of being a home page for a
> development project.  I think this is the wrong approach.  Our "front
> page" should focus on attracting users of Derby.  The heading "The
> Apache Derby Project" appeals more to potential developers of Derby.
> 
> Some suggestions:
> - The header should only say "Apache Derby".

great idea.

> - A table of contents make the page pretty dull.  I think the fact that
> we feel we need a TOC indicates that there are probably too much stuff
> on the front page.  (If you look at the Postgres front page, it is
> mostly links to other pages.)

forrest, the software used for generating the site, automatically
generates that TOC -- and I agree there's too much on this page,
especially since I added the "What is Derby?" and "Downloads" sections.  :-)

The charter itself belongs in a different page that is linked to from
this one. If there are no objections, I'll go ahead and make that change
sometime soon.

> - I do not know what is technically possible, but having more columns
> will bring more information to the top of the page.  At least on my
> laptop, I still have to scroll down to find the link to downloads and
> the news.
> - The fact that people are not able to find downloads in the menu on the
> left side, indicates that something is probably wrong with the design.
> Maybe the text is to small and does not show well due to the background
> color.

The page layout (including the menu and tabs) depends on the forrest
skin used. Right now the default skin is in place. Anyone should feel
free to test/develop/suggest other skins, keeping in mind that Derby is
using forrest 0.7 -- details are at
http://db.apache.org/derby/papers/derby_web.html . For example, ddlutils
and ojb use a different skin but if I remember right both those sites
are at forrest 0.6: see http://db.apache.org/ddlutils/ ,
http://db.apache.org/ojb/ . So just stick to forrest 0.7 features.

at any rate, if anyone wants to suggest a new skin, that'd be great --
go for it!

 -jean

Re: Holistic getting started approach

Posted by Øystein Grøvlen <Oy...@Sun.COM>.
Jean T. Anderson wrote:

> That home page is another thing that could use serious redesign, :-) 
> something simpler that links to the charter.
> 
> Torque has a home page that provides a synopsis and a link to the most 
> current release:  http://db.apache.org/torque/ . (Moving that up after 
> their "What is Torque?" section would make it instantly visible.) And I 
> like the way JDO has the news on the home page (http://db.apache.org/jdo/).
> 

If you look at the home pages for Torque or PostgreSQL you immediately 
get the feeling that these are home pages for a software products.  I 
think our homepage more gives the impression of being a home page for a 
development project.  I think this is the wrong approach.  Our "front 
page" should focus on attracting users of Derby.  The heading "The 
Apache Derby Project" appeals more to potential developers of Derby.

Some suggestions:
- The header should only say "Apache Derby".
- A table of contents make the page pretty dull.  I think the fact that 
we feel we need a TOC indicates that there are probably too much stuff 
on the front page.  (If you look at the Postgres front page, it is 
mostly links to other pages.)
- I do not know what is technically possible, but having more columns 
will bring more information to the top of the page.  At least on my 
laptop, I still have to scroll down to find the link to downloads and 
the news.
- The fact that people are not able to find downloads in the menu on the 
left side, indicates that something is probably wrong with the design. 
Maybe the text is to small and does not show well due to the background 
color.

--
Øystein

Re: Holistic getting started approach

Posted by John Embretsen <Jo...@Sun.COM>.
Jean T. Anderson wrote:

> I added "What is Apache Derby?" and "Downloads" sections to the home 
> page at http://db.apache.org/derby/ (but left the charter as is).
> 
> Feel free to tweak.
> 
> -jean


I think it's excellent! Good job :)

-- 
John

Re: Holistic getting started approach

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Jean T. Anderson wrote:
> ...
> That home page is another thing that could use serious redesign, :-) 
> something simpler that links to the charter.
> 
> Torque has a home page that provides a synopsis and a link to the most 
> current release:  http://db.apache.org/torque/ . (Moving that up after 
> their "What is Torque?" section would make it instantly visible.) And I 
> like the way JDO has the news on the home page (http://db.apache.org/jdo/).
> 
> So maybe a revamped Derby home page could have something like:
> 
>   What is Derby? (brief description and link to charter)
>   Downloads
>   News

I added "What is Apache Derby?" and "Downloads" sections to the home 
page at http://db.apache.org/derby/ (but left the charter as is).

Feel free to tweak.

-jean

Re: Holistic getting started approach

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
John Embretsen wrote:
> Jean T. Anderson wrote:
> 
> 
>> (3) It's hard to find the downloads
>>
>> I'm surprised by the number of requests I get which are "where are the 
>> downloads?" Even though downloads are on the home tab, they clearly 
>> aren't visible. So make downloads its own tab?
>>
>> The real estate of a web browser can accommodate only so many tabs, so 
>> we have to choose carefully. I'm hoping to free up some time soon to 
>> look more closely at each of these areas.
> 
> 
> That is somewhat surprising, yes. One alternative approach that might 
> help (if adding a new "Downloads" tab is too much), is to add a 
> "Downloads" section (with links to the real downloads page) high up on 
> the main page (somewhere around "News" and "Derby Project Charter"). 
> Those headings are among the firsts things I notice when I go to 
> http://db.apache.org/derby/. Just a thought.

That home page is another thing that could use serious redesign, :-) 
something simpler that links to the charter.

Torque has a home page that provides a synopsis and a link to the most 
current release:  http://db.apache.org/torque/ . (Moving that up after 
their "What is Torque?" section would make it instantly visible.) And I 
like the way JDO has the news on the home page (http://db.apache.org/jdo/).

So maybe a revamped Derby home page could have something like:

   What is Derby? (brief description and link to charter)
   Downloads
   News

  -jean



Re: Holistic getting started approach

Posted by John Embretsen <Jo...@Sun.COM>.
Jean T. Anderson wrote:


> (3) It's hard to find the downloads
> 
> I'm surprised by the number of requests I get which are "where are the 
> downloads?" Even though downloads are on the home tab, they clearly 
> aren't visible. So make downloads its own tab?
> 
> The real estate of a web browser can accommodate only so many tabs, so 
> we have to choose carefully. I'm hoping to free up some time soon to 
> look more closely at each of these areas.

That is somewhat surprising, yes. One alternative approach that might 
help (if adding a new "Downloads" tab is too much), is to add a 
"Downloads" section (with links to the real downloads page) high up on 
the main page (somewhere around "News" and "Derby Project Charter"). 
Those headings are among the firsts things I notice when I go to 
http://db.apache.org/derby/. Just a thought.


-- 
John

Re: Holistic getting started approach

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
David W. Van Couvering wrote:
> Hm.  You mention that *anybody* can update the Wiki.  Perhaps that's not 
> such a bad thing.  Postgres and PHP both have user-updatable 
> documentation, and this has become very valuable.

I need to clarify that I didn't mean to include the Derby docs in my 
discussion below, only the main web site pages.

Is that what you're referring to for Postgres and PHP? do they support 
update of web site content separate from the product docs? I thought PHP 
had support for commenting on the product docs, but that isn't what I'm 
talking about here.

Product doc updates could also be considered, but would entail feedback 
to the DITA source for the Derby docs.

> 
> What if we had a controlled "official" version of the docs, and a 
> Wikified version of the docs that can be updated/appended to by anybody?

I would actually prefer a simpler approach. If a page should be 
updateable by anyone, then move it to the Wiki.  :-)

An example of something that cannot be moved is the downloads page at 
http://db.apache.org/derby/derby_downloads.html and all it's associated 
release pages.

  -jean


> Here's a thought as to how to do that:
> 
> - Use Forrest's great MVC approach to generate a Wiki-friendly version 
> of the docs and publish this to the Wiki
> 
> - Allow users to annotate the docs on the Wiki site
> 
> - At next release, merge valuable user comments into the docs, and then 
> generate a new Wiki-friendly set for that version
> 
> The only downside is comments that we don't consider "valuable" would 
> get orphaned in prior version doc sets on the Wiki set.  But maybe 
> that's OK...
> 
> Thoughts?
> 
> David
> 
> Jean T. Anderson wrote:
> 
>> Daniel John Debrunner wrote:
>>
>>> Looking at Stan's WMD, sorry WWD document in DERBY-913 I want to promote
>>>  a holistic approach to making getting started on Derby easier. Thus by
>>> improving various areas such as documentation, web-site, product,
>>> tutorials, FAQ etc. together we can gain a bigger benefit than by
>>> increasing individual items to make up for deficiencies in other areas.
>>
>>
>>
>> The web site needs a huge overhaul. Here are some of the issues I've 
>> been mulling over.
>>
>> (1) Web site content isn't trivial to update
>>
>> Whether the web site is in Forrest, Maven, or Anakia (those seem to be 
>> the big three at Apache), it involves learning the file formats those 
>> products support and the build process, and this learning curve is a 
>> barrier.
>>
>> We've had a much higher rate of contribution to the Derby Wiki.
>>
>> I'd like to move as much of the highly changing information on the web 
>> site to the Wiki as we can. For example, I think that all of 
>> http://db.apache.org/derby/integrate/misc.html can be moved to the 
>> Wiki -- and reorganized. Some is eclipsed by 
>> http://wiki.apache.org/db-derby/UsesOfDerby anyhow, but there are 
>> categories not handled by that Wiki page.
>>
>> We'll have to strike some sort of balance, though. One issue with the 
>> Wiki is *anyone* can update it. Anything that requires controlled 
>> updates by committers must stay on the web site.
>>
>> (2) New users can't easily find what they need
>>
>> Too many responses to posts on derby-user consist of an URL to that 
>> information on the web site (or, lately, even on the Wiki).
>>
>> The good news is we have a lot more content than we did a year and 
>> half ago. The bad news is I've pretty much just shovelled it in and 
>> some of it's pretty tangled now.
>>
>> Perhaps a master "Start Here" page would help that is specifically 
>> tailored for new users. It could be on the web site or the Wiki, with 
>> a prominent tab on the web site that goes directly to that page.
>>
>> (3) It's hard to find the downloads
>>
>> I'm surprised by the number of requests I get which are "where are the 
>> downloads?" Even though downloads are on the home tab, they clearly 
>> aren't visible. So make downloads its own tab?
>>
>> The real estate of a web browser can accommodate only so many tabs, so 
>> we have to choose carefully. I'm hoping to free up some time soon to 
>> look more closely at each of these areas.
>>
>>  -jean


Re: Holistic getting started approach

Posted by "David W. Van Couvering" <Da...@Sun.COM>.
Hm.  You mention that *anybody* can update the Wiki.  Perhaps that's not 
such a bad thing.  Postgres and PHP both have user-updatable 
documentation, and this has become very valuable.

What if we had a controlled "official" version of the docs, and a 
Wikified version of the docs that can be updated/appended to by anybody?

Here's a thought as to how to do that:

- Use Forrest's great MVC approach to generate a Wiki-friendly version 
of the docs and publish this to the Wiki

- Allow users to annotate the docs on the Wiki site

- At next release, merge valuable user comments into the docs, and then 
generate a new Wiki-friendly set for that version

The only downside is comments that we don't consider "valuable" would 
get orphaned in prior version doc sets on the Wiki set.  But maybe 
that's OK...

Thoughts?

David

Jean T. Anderson wrote:
> Daniel John Debrunner wrote:
> 
>> Looking at Stan's WMD, sorry WWD document in DERBY-913 I want to promote
>>  a holistic approach to making getting started on Derby easier. Thus by
>> improving various areas such as documentation, web-site, product,
>> tutorials, FAQ etc. together we can gain a bigger benefit than by
>> increasing individual items to make up for deficiencies in other areas.
> 
> 
> The web site needs a huge overhaul. Here are some of the issues I've 
> been mulling over.
> 
> (1) Web site content isn't trivial to update
> 
> Whether the web site is in Forrest, Maven, or Anakia (those seem to be 
> the big three at Apache), it involves learning the file formats those 
> products support and the build process, and this learning curve is a 
> barrier.
> 
> We've had a much higher rate of contribution to the Derby Wiki.
> 
> I'd like to move as much of the highly changing information on the web 
> site to the Wiki as we can. For example, I think that all of 
> http://db.apache.org/derby/integrate/misc.html can be moved to the Wiki 
> -- and reorganized. Some is eclipsed by 
> http://wiki.apache.org/db-derby/UsesOfDerby anyhow, but there are 
> categories not handled by that Wiki page.
> 
> We'll have to strike some sort of balance, though. One issue with the 
> Wiki is *anyone* can update it. Anything that requires controlled 
> updates by committers must stay on the web site.
> 
> (2) New users can't easily find what they need
> 
> Too many responses to posts on derby-user consist of an URL to that 
> information on the web site (or, lately, even on the Wiki).
> 
> The good news is we have a lot more content than we did a year and half 
> ago. The bad news is I've pretty much just shovelled it in and some of 
> it's pretty tangled now.
> 
> Perhaps a master "Start Here" page would help that is specifically 
> tailored for new users. It could be on the web site or the Wiki, with a 
> prominent tab on the web site that goes directly to that page.
> 
> (3) It's hard to find the downloads
> 
> I'm surprised by the number of requests I get which are "where are the 
> downloads?" Even though downloads are on the home tab, they clearly 
> aren't visible. So make downloads its own tab?
> 
> The real estate of a web browser can accommodate only so many tabs, so 
> we have to choose carefully. I'm hoping to free up some time soon to 
> look more closely at each of these areas.
> 
>  -jean

Re: Holistic getting started approach

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Daniel John Debrunner wrote:
> Looking at Stan's WMD, sorry WWD document in DERBY-913 I want to promote
>  a holistic approach to making getting started on Derby easier. Thus by
> improving various areas such as documentation, web-site, product,
> tutorials, FAQ etc. together we can gain a bigger benefit than by
> increasing individual items to make up for deficiencies in other areas.

The web site needs a huge overhaul. Here are some of the issues I've 
been mulling over.

(1) Web site content isn't trivial to update

Whether the web site is in Forrest, Maven, or Anakia (those seem to be 
the big three at Apache), it involves learning the file formats those 
products support and the build process, and this learning curve is a 
barrier.

We've had a much higher rate of contribution to the Derby Wiki.

I'd like to move as much of the highly changing information on the web 
site to the Wiki as we can. For example, I think that all of 
http://db.apache.org/derby/integrate/misc.html can be moved to the Wiki 
-- and reorganized. Some is eclipsed by 
http://wiki.apache.org/db-derby/UsesOfDerby anyhow, but there are 
categories not handled by that Wiki page.

We'll have to strike some sort of balance, though. One issue with the 
Wiki is *anyone* can update it. Anything that requires controlled 
updates by committers must stay on the web site.

(2) New users can't easily find what they need

Too many responses to posts on derby-user consist of an URL to that 
information on the web site (or, lately, even on the Wiki).

The good news is we have a lot more content than we did a year and half 
ago. The bad news is I've pretty much just shovelled it in and some of 
it's pretty tangled now.

Perhaps a master "Start Here" page would help that is specifically 
tailored for new users. It could be on the web site or the Wiki, with a 
prominent tab on the web site that goes directly to that page.

(3) It's hard to find the downloads

I'm surprised by the number of requests I get which are "where are the 
downloads?" Even though downloads are on the home tab, they clearly 
aren't visible. So make downloads its own tab?

The real estate of a web browser can accommodate only so many tabs, so 
we have to choose carefully. I'm hoping to free up some time soon to 
look more closely at each of these areas.

  -jean

Re: Holistic getting started approach

Posted by Daniel John Debrunner <dj...@apache.org>.
David W. Van Couvering wrote:

> Solving the classpath issue would be a great win.  Not only could we fix
> ij this way, we could provide guidance to users so they can set up an
> executable application jar that includes derby.jar so that Derby
> application users also don't have to deal with classpath.

Right we've made progress in this area already, derbynet.jar
automatically includes derby.jar (from 10.1) and now derby.jar
automatically includes the locale files.

So this does work

> java -jar jars/sane/derbynet.jar start
Server is ready to accept connections on port 1527.

Dan.





Re: Holistic getting started approach

Posted by "David W. Van Couvering" <Da...@Sun.COM>.
Solving the classpath issue would be a great win.  Not only could we fix 
ij this way, we could provide guidance to users so they can set up an 
executable application jar that includes derby.jar so that Derby 
application users also don't have to deal with classpath.

David

Daniel John Debrunner wrote:
> Looking at Stan's WMD, sorry WWD document in DERBY-913 I want to promote
>  a holistic approach to making getting started on Derby easier. Thus by
> improving various areas such as documentation, web-site, product,
> tutorials, FAQ etc. together we can gain a bigger benefit than by
> increasing individual items to make up for deficiencies in other areas.
> This echoes something Bryan (I think) said a couple of days ago, that
> just don't assume fixing the getting started guide is the only or best
> approach.
> 
> Stan's WWD tutorial looks like a great project and I'm sure will benefit
> people getting up to speed on Derby.
> 
> What really jumped out at me was the very first things a user has to do
> is understand and set classpaths. Something that causes the most
> problems and is tricky to get right in a manual way, is the first thing
> we hit users with. To my mind seems like a very good way to lose users
> at the first step, either because they want to issue some SQL right away
> but we make them setup environment variables first, or they get
> frustrated by ClassNotFoundExceptions due to minor typos.
> 
> Now I understand where Stan is coming from, he's once supported this
> product and saw the endless class path issues, so why not explain it up
> front.
> 
> I would take a different approach, start out with something that works
> and get users into executing SQL through ij as soon as possible. As the
> tutorial moves on, explain class paths later, once they have seen all
> the powers of Derby.
> 
> Note that what I'm talking about is maybe 2% of Stan's proposed
> tutorial, but it's the first 2% where one stands the greatest risk to
> lose the most people.
> 
> I see the requirement to set classpath as a weakness in the product,
> which the tutorial is trying to work around. So what could be done
> better in the product that would help this tutorial?
> 
> Having installed Derby there needs to be something simple that gets you
> into ij. Some very easy step that gets you to a successful session like:
> 
> ij version 10.2
> ij> connect 'MYDB;create=true';
> ij> create table t (i int );
> insert into t values 1;
> 0 rows inserted/updated/deleted
> ij> 1 row inserted/updated/deleted
> ij> select * from t;
> I
> -----------
> 1
> 
> 1 row selected
> 
> 
> Note that I intentionally have a connect statement without
> 'jdbc:derby:', I'm trying to make it simple, then as one progresses
> through the tutorial one unwraps the layers to expose the full story.
> E.g. some section that said, what was really going on with the 'connect
> MYDB', then explain it's being mapped in jdbc:derby:MYDB and so on.
> 
> Maybe the simple command to get things going is based upon the current
> ij shell or batch scripts in the frameworks directory. They could be
> improved so that they were more visible and were a single step.  If I
> can't run this scripts right away after an installation they will turn
> people off.
> 
> Maybe we could provide additional jar files the execute the tools, I
> created a simple ij.jar containing only this manifest (no classes etc.):
> 
> Manifest-Version: 1.0
> Ant-Version: Apache Ant 1.6.2
> Created-By: 1.4.2 (IBM Corporation)
> Main-Class: org.apache.derby.tools.ij
> Class-Path: derbytools.jar derby.jar
> 
> 
> Then I can execute
> 
> java -jar jars/sane/ij.jar
> ij version 10.2
> ij>
> 
> To set the default JDBC protocol a simple java class would be needed in
> ij.jar as its main class to set the ij.protocol property and then call ij.
> 
> Can these jars be executed directly, I thought on windows one could
> double-click a jar file and have it run right away, doesn't seem to
> happen on my machine though?
> 
> So that's just one example where hopefully addressing something in the
> product would make the tutorial better and lead to more happy Derby
> users. I would encourage others to think along similar lines when
> looking at the tutorial, manual or anything else that's aimed at making
> Derby easier, namely to see if some other piece would make it even easier.
> 
> Dan.
> 
> 
> 
> 
> 
> 

Re: Holistic getting started approach

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Daniel John Debrunner wrote:
> ... 
> What really jumped out at me was the very first things a user has to do
> is understand and set classpaths. Something that causes the most
> problems and is tricky to get right in a manual way, is the first thing
> we hit users with. To my mind seems like a very good way to lose users
> at the first step, either because they want to issue some SQL right away
> but we make them setup environment variables first, or they get
> frustrated by ClassNotFoundExceptions due to minor typos.
> 
> Now I understand where Stan is coming from, he's once supported this
> product and saw the endless class path issues, so why not explain it up
> front.
> 
> I would take a different approach, start out with something that works
> and get users into executing SQL through ij as soon as possible. As the
> tutorial moves on, explain class paths later, once they have seen all
> the powers of Derby.
> 
> Note that what I'm talking about is maybe 2% of Stan's proposed
> tutorial, but it's the first 2% where one stands the greatest risk to
> lose the most people.
> 
> I see the requirement to set classpath as a weakness in the product,
> which the tutorial is trying to work around. So what could be done
> better in the product that would help this tutorial?
> ... 
<excellent example snipped>
> ...
> So that's just one example where hopefully addressing something in the
> product would make the tutorial better and lead to more happy Derby
> users. I would encourage others to think along similar lines when
> looking at the tutorial, manual or anything else that's aimed at making
> Derby easier, namely to see if some other piece would make it even easier.
> 
> Dan.
> 

For anyone not on derby-user, here's timely feedback wrt classpath 
posted this morning:

http://mail-archives.apache.org/mod_mbox/db-derby-user/200602.mbox/%3cOF11BAA9F3.CC0ACBC0-ON8525710D.005595AF-8525710D.0055E876@steinmart.com%3e

Any way we can enhance Derby to remove the requirement to set classpath 
up front would be great. In the meantime, some short-term boosts in the 
documentation would be helpful.

  -jean


Holistic getting started approach

Posted by Daniel John Debrunner <dj...@apache.org>.
Looking at Stan's WMD, sorry WWD document in DERBY-913 I want to promote
 a holistic approach to making getting started on Derby easier. Thus by
improving various areas such as documentation, web-site, product,
tutorials, FAQ etc. together we can gain a bigger benefit than by
increasing individual items to make up for deficiencies in other areas.
This echoes something Bryan (I think) said a couple of days ago, that
just don't assume fixing the getting started guide is the only or best
approach.

Stan's WWD tutorial looks like a great project and I'm sure will benefit
people getting up to speed on Derby.

What really jumped out at me was the very first things a user has to do
is understand and set classpaths. Something that causes the most
problems and is tricky to get right in a manual way, is the first thing
we hit users with. To my mind seems like a very good way to lose users
at the first step, either because they want to issue some SQL right away
but we make them setup environment variables first, or they get
frustrated by ClassNotFoundExceptions due to minor typos.

Now I understand where Stan is coming from, he's once supported this
product and saw the endless class path issues, so why not explain it up
front.

I would take a different approach, start out with something that works
and get users into executing SQL through ij as soon as possible. As the
tutorial moves on, explain class paths later, once they have seen all
the powers of Derby.

Note that what I'm talking about is maybe 2% of Stan's proposed
tutorial, but it's the first 2% where one stands the greatest risk to
lose the most people.

I see the requirement to set classpath as a weakness in the product,
which the tutorial is trying to work around. So what could be done
better in the product that would help this tutorial?

Having installed Derby there needs to be something simple that gets you
into ij. Some very easy step that gets you to a successful session like:

ij version 10.2
ij> connect 'MYDB;create=true';
ij> create table t (i int );
insert into t values 1;
0 rows inserted/updated/deleted
ij> 1 row inserted/updated/deleted
ij> select * from t;
I
-----------
1

1 row selected


Note that I intentionally have a connect statement without
'jdbc:derby:', I'm trying to make it simple, then as one progresses
through the tutorial one unwraps the layers to expose the full story.
E.g. some section that said, what was really going on with the 'connect
MYDB', then explain it's being mapped in jdbc:derby:MYDB and so on.

Maybe the simple command to get things going is based upon the current
ij shell or batch scripts in the frameworks directory. They could be
improved so that they were more visible and were a single step.  If I
can't run this scripts right away after an installation they will turn
people off.

Maybe we could provide additional jar files the execute the tools, I
created a simple ij.jar containing only this manifest (no classes etc.):

Manifest-Version: 1.0
Ant-Version: Apache Ant 1.6.2
Created-By: 1.4.2 (IBM Corporation)
Main-Class: org.apache.derby.tools.ij
Class-Path: derbytools.jar derby.jar


Then I can execute

java -jar jars/sane/ij.jar
ij version 10.2
ij>

To set the default JDBC protocol a simple java class would be needed in
ij.jar as its main class to set the ij.protocol property and then call ij.

Can these jars be executed directly, I thought on windows one could
double-click a jar file and have it run right away, doesn't seem to
happen on my machine though?

So that's just one example where hopefully addressing something in the
product would make the tutorial better and lead to more happy Derby
users. I would encourage others to think along similar lines when
looking at the tutorial, manual or anything else that's aimed at making
Derby easier, namely to see if some other piece would make it even easier.

Dan.







[jira] Updated: (DERBY-913) [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set

Posted by "Stan Bradbury (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-913?page=all ]

Stan Bradbury updated DERBY-913:
--------------------------------

    Attachment: WorkingWithDerbyV10.html

The initial proposal describing Working With Derby

> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
>          Key: DERBY-913
>          URL: http://issues.apache.org/jira/browse/DERBY-913
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>     Versions: 10.2.0.0
>     Reporter: Stan Bradbury
>     Assignee: Stan Bradbury
>  Attachments: WorkingWithDerbyV10.html
>
> I propose starting a new activity-based tutorial document for Derby.  The proposed name is "Working With Derby" and I'd like to include it with the next release.  The document would target new Derby users.  Information would be presented that supports a series of activities designed to be performed after installation.  These activities will guide beginners through the basics of using Derby.  Attached is a proposal that further describes the initial topics as I see them.  I would very much like feedback on all aspects of this proposal from the Derby communities.  Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.

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