[jira] Commented: (DERBY-3118) Simple demo is out of date

["John H. Embretsen (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/DERBY-3118?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12533384 ] 

John H. Embretsen commented on DERBY-3118:
------------------------------------------

Suggestions to refurbish the simple demo, based on an evaluation of the demo in 10.3.1.4:

    * demo/programs/simple/example.html:
          o Use "DERBY_HOME" environment variable instead of "DERBY_INSTALL" (align with scripts and docs)
          o Describe how to set DERBY_HOME on Win, Unix, Mac?
          o Provide command line examples in both Unix and Windows variants, or at least make it consistent
          o Don't start paths with the file separator (e.g. \), makes them look absolute when they are not
          o Display commands and console output in a different font style than surrounding text (use embedded CSS?)
          o Bottom text says "Apache Derby Version 10.1". Change to "Last updated to work with Derby 10.x"?
          o Fix libraries tables (current layout is confusing)
          o Overview: Rephrase "J2SE" and "J2ME" Java Virtual Machines (since 1.6 called Java SE and Java ME)
          o Overview: (embedded) "Only one application can access a database at a time." Cause of misunderstandings? Rephrase to avoid giving the impression that only one client application can connect at one time.
          o What's Included?: Change "derby.LOG" to "derby.log"
          o What's Included?: Include cleanup instructions (remove derby.log and derbyDB/ directory)
          o How to run... (embedded): Change reference to scripts from frameworks/ to bin/ (Fix included in patch for DERBY-3026)
          o How to run... (embedded): Update sysinfo description (completely outdated)
          o How to run... (server): Strip down server classpath to include derbynet.jar only (OK since 10.1.2.1)
          o How to run... (server): Change reference to scripts from frameworks/ to bin/ (Fix included in patch for DERBY-3026)
          o How to run... (server): sysinfo reports user-specified class (SimpleApp) as NOT FOUND when following instructions verbatim (i.e. when derby.jar is not in the classpath)
          o How to run... (server): Network Server console output is out of date
          o How to run... (server): Running as described does not work: "Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/derby/jdbc/EmbeddedSimpleDataSource" 
    * demo/programs/simple/SimpleApp.java:
          o is J2ME spec check reliable? (lines 72-78)
          o stronger separation between embedded / java me / client code is needed
          o demo should use PreparedStatements for repeated executions


Also, some general observations include:
    * demo/ dir should contain a readme file. Contains currently the directories databases/, programs/ and templates/ only, which may confuse users.
    * demo/programs/readme.html states "This directory contains example programs." Should specify which dir "this" is, since the html page can be reached via links from several places.


> Simple demo is out of date
> --------------------------
>
>                 Key: DERBY-3118
>                 URL: https://issues.apache.org/jira/browse/DERBY-3118
>             Project: Derby
>          Issue Type: Improvement
>          Components: Demos/Scripts
>    Affects Versions: 10.3.1.4
>            Reporter: John H. Embretsen
>            Assignee: John H. Embretsen
>
> The simple demo and the related instructions in the demo/programs/simple/ directory of Derby -bin installations need to be refurbished. Having a working, informative and simple demo is highly valuable to new or prospective users, but the current state of the simple demo (and our demo offerings in general) is not something to be proud of. This issue describes both bugs and other improvement suggestions related to the simple demo.

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