Derby
  1. Derby
  2. DERBY-3225

Some demo programs in -bin distributions are not mentioned in demo/programs/readme.html

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 10.3.1.4
    • Fix Version/s: 10.6.1.0
    • Component/s: Demos/Scripts
    • Labels:
      None
    • Environment:
      Derby -bin distributions

      Description

      Currently in trunk, there are 8 demo (sub)directories in the demo/programs directory scheduled to be included in -bin distributions, each containing one or more demo or sample applications:

      localcal/
      nserverdemo/
      scores/
      simple/
      simplemobile/
      toursdb/
      vtis/
      workingwithderby/

      With a -bin distribution of Derby, a user should be able to get an overview of the included demo program offering by opening demo/programs/readme.html in a web browser (there is a link to this from the top-level index.html file). In trunk, we are currently missing short descriptions of and links to:

      Each of these demos have a README file in their respective subdirectories, that could easily be linked to.*

      The remaining 5 demos are accessible from and described by the readme.html file (readme.html is a frameset; the actual references and descriptions are in navbar.html and demo.html. These files are placed in the java/demo directory in the source tree).

      *)
      Also, one should make sure that the README files and other instructions are suitable for -bin distributions, not only -src distributions or SVN working copies. Otherwise, these particular demos should not be included in -bin distributions. For example both localcal/README, scores/README and vtis/README currently refer to build scripts that are not scheduled for inclusion in -bin distros.

      1. derby-3225.diff
        3 kB
        Bryan Pendleton

        Activity

        Hide
        John H. Embretsen added a comment -

        Thanks Bryan, the final changes look good to me. Closing.

        Show
        John H. Embretsen added a comment - Thanks Bryan, the final changes look good to me. Closing.
        Hide
        Bryan Pendleton added a comment -

        Thanks John! The instructions for building a private release worked well; I was
        able to build and test the changes to release/build.xml.

        I fixed the typos that you noticed, and committed the changes to the
        trunk as revision 883571.

        Show
        Bryan Pendleton added a comment - Thanks John! The instructions for building a private release worked well; I was able to build and test the changes to release/build.xml. I fixed the typos that you noticed, and committed the changes to the trunk as revision 883571.
        Hide
        John H. Embretsen added a comment -

        Thanks for working on this as well, Bryan I had a look at your patch and have a couple of comments and suggestions:

        • <zipfileset> changes for bin.zip artifacts look fine. However, you need to do the same for <target name="bin.tgz" depends="init"> as well.
        • demo.html, LocalCalendar: Add period after sentence ending with "when you come back online".
        • localcal/README: This ends saying "ARCHITECTURE <Coming Soon>", which I guess is wrong (it has been there for quite some time). Although not actually part of this Jira issue, you may consider removing that paragraph while you are at it... your choice.
        • demo.html, VTIs: Enclose paragraph following bullet-point list ("In addition...") in a <p class="BodyRelative"> tag, to add space between last bullet point and the following text (without it it looks a bit cluttered in my browser).

        The fact that README files are simple text files seems to work good enough in my browsers. I did not actually test that the build scripts worked. And yes, it seems that the VTI build has been changed since this bug report was created, so I guess that part is taken care of.

        Thanks again

        Show
        John H. Embretsen added a comment - Thanks for working on this as well, Bryan I had a look at your patch and have a couple of comments and suggestions: <zipfileset> changes for bin.zip artifacts look fine. However, you need to do the same for <target name="bin.tgz" depends="init"> as well. you can do a quick build of release artifacts relatively easily (if you have all required resources), see http://wiki.apache.org/db-derby/DerbySnapshotOrRelease#Making_a_.28private.29_Quick_Build_of_Release_Artifacts demo.html, LocalCalendar: Add period after sentence ending with "when you come back online". localcal/README: This ends saying "ARCHITECTURE <Coming Soon>", which I guess is wrong (it has been there for quite some time). Although not actually part of this Jira issue, you may consider removing that paragraph while you are at it... your choice. demo.html, VTIs: Enclose paragraph following bullet-point list ("In addition...") in a <p class="BodyRelative"> tag, to add space between last bullet point and the following text (without it it looks a bit cluttered in my browser). The fact that README files are simple text files seems to work good enough in my browsers. I did not actually test that the build scripts worked. And yes, it seems that the VTI build has been changed since this bug report was created, so I guess that part is taken care of. Thanks again
        Hide
        Bryan Pendleton added a comment -

        As I understand it, there are two changes needed:

        1) Ensure that localcal/build.xml and scores/build.xml make it into the binary release distribution.
        (VTIs does not seem to have a separate build script)
        2) Ensure that localcal, scores, and vtis are mentioned, at least briefly, in the top-level
        readme.html, to give some overview to the user about what is to be found there.

        Attached is a simple patch proposal to perform these two changes.

        I didn't build an entire release (don't know how), but I did test the <zipfileset> changes
        in a separate standalone Ant test, and they seemed to work fine.

        The README files in localcal, scores, and vtis are not HTML, but just simple text, so
        they don't display very well in browsers, but at least they are better than nothing,
        and the motivated user can do more work themselves.

        Please let me know what you think.

        Show
        Bryan Pendleton added a comment - As I understand it, there are two changes needed: 1) Ensure that localcal/build.xml and scores/build.xml make it into the binary release distribution. (VTIs does not seem to have a separate build script) 2) Ensure that localcal, scores, and vtis are mentioned, at least briefly, in the top-level readme.html, to give some overview to the user about what is to be found there. Attached is a simple patch proposal to perform these two changes. I didn't build an entire release (don't know how), but I did test the <zipfileset> changes in a separate standalone Ant test, and they seemed to work fine. The README files in localcal, scores, and vtis are not HTML, but just simple text, so they don't display very well in browsers, but at least they are better than nothing, and the motivated user can do more work themselves. Please let me know what you think.

          People

          • Assignee:
            Bryan Pendleton
            Reporter:
            John H. Embretsen
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development