Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.2Update1
    • Fix Version/s: B37
    • Component/s: doc
    • Labels:
      None
    • Environment:

      Operating System: All
      Platform: All

    • Issuezilla Id:
      1,607

      Description

      The toolkit zip file downloaded from:

      http://wikis.sun.com/display/IpsBestPractices/Downloads

      does not contain a top level README. We should consider whether it would be
      beneficial to provide a README that:

      1) Points to the online docs (Release Notes)
      2) Covers initial steps for new users (or points to that info on the wiki)
      3) Indicates where feedback can be sent.

        Activity

        Hide
        Mike Fitch added a comment -

        Tom,
        I created readme.html in updatetool/src/help/C, and the bundling scripts now
        need to be changed such that it gets copied to the top level directory in the
        bundle.

        Show
        Mike Fitch added a comment - Tom, I created readme.html in updatetool/src/help/C, and the bundling scripts now need to be changed such that it gets copied to the top level directory in the bundle.
        Hide
        Tom Mueller added a comment -

        A couple of comments about this:

        1. I was expecting a text file rather than an HTML file. Typical use of this
        file is going either be a user unzipping the file and then typing it out on a
        terminal via cat or more (Unix) or browsing the ZIP file with explorer and
        double clicking on the file (Windows). The HTML file works ok for the latter,
        but not really for the former. Can we make this a README.txt file that would
        work for both?

        2. Can we put the file into the top-level docs directory rather than under
        updatetool/help since this is related to the entire toolkit and not just
        updatetool? Also, AFAIK, there is no intent to translate this file so it
        doesn't belong under a "C" directory.

        3. We have the URL for the release notes in the build.xml file. If you put in a
        keyword such as RELEASE_NOTES instead of the actual URL, I can do token
        substitution on it so that this file doesn't have to be edited for every release.

        4. The installation instructions are correct for the platform-specific images,
        but they aren't quite right for the platform-independent image. Should we have
        a 2nd file with different instructions for that image? Or maybe account for
        both types of images in the same file?

        5. Should we be referencing both wikis? The 2nd one is really for developers of
        the UC2 toolkit itself.

        Changing this to B37 so that we can address these issues.

        Show
        Tom Mueller added a comment - A couple of comments about this: 1. I was expecting a text file rather than an HTML file. Typical use of this file is going either be a user unzipping the file and then typing it out on a terminal via cat or more (Unix) or browsing the ZIP file with explorer and double clicking on the file (Windows). The HTML file works ok for the latter, but not really for the former. Can we make this a README.txt file that would work for both? 2. Can we put the file into the top-level docs directory rather than under updatetool/help since this is related to the entire toolkit and not just updatetool? Also, AFAIK, there is no intent to translate this file so it doesn't belong under a "C" directory. 3. We have the URL for the release notes in the build.xml file. If you put in a keyword such as RELEASE_NOTES instead of the actual URL, I can do token substitution on it so that this file doesn't have to be edited for every release. 4. The installation instructions are correct for the platform-specific images, but they aren't quite right for the platform-independent image. Should we have a 2nd file with different instructions for that image? Or maybe account for both types of images in the same file? 5. Should we be referencing both wikis? The 2nd one is really for developers of the UC2 toolkit itself. Changing this to B37 so that we can address these issues.
        Hide
        Mike Fitch added a comment -

        Fixed README as per Tom's comments:

        1. Converted the file to text instead of html.

        2. Committed the text file to docs/README.txt and deleted .../help/C/readme.html.

        3. Used the keyword RELEASE_NOTES_URL instead of the actual url for the release
        notes.

        4. Edited the instructions to apply to both platform-specific and universal
        image downloads.

        5. Removed references to the developer wiki.

        Show
        Mike Fitch added a comment - Fixed README as per Tom's comments: 1. Converted the file to text instead of html. 2. Committed the text file to docs/README.txt and deleted .../help/C/readme.html. 3. Used the keyword RELEASE_NOTES_URL instead of the actual url for the release notes. 4. Edited the instructions to apply to both platform-specific and universal image downloads. 5. Removed references to the developer wiki.
        Show
        scm_issue_link added a comment - Code changed in updatecenter2 User: : tmueller Path: trunk/project/build.xml https://updatecenter2.dev.java.net/source/browse/updatecenter2/trunk/project/build.xml?view=diff&rev=2424&p1=trunk/project/build.xml&p2=trunk/project/build.xml&r1=2423&r2=2424 trunk/project/docs/README.txt https://updatecenter2.dev.java.net/source/browse/updatecenter2/trunk/project/docs/README.txt?view=diff&rev=2424&p1=trunk/project/docs/README.txt&p2=trunk/project/docs/README.txt&r1=2423&r2=2424 Log: UPDATECENTER2-1607 Add README file to toolkit distributions
        Hide
        Tom Mueller added a comment -

        build.xml modifications integrated in revision 2424.

        Show
        Tom Mueller added a comment - build.xml modifications integrated in revision 2424.
        Hide
        lalithasaroja added a comment -

        Verified in B38. Now after unzipping the platform specific pkg-toolkit and
        Universal zip file, the pkg-toolkit directory contains README file which has the
        instructions for the user how to install pkg,updatetool, the URL for release
        notes etc.

        Setting this as Verified

        Show
        lalithasaroja added a comment - Verified in B38. Now after unzipping the platform specific pkg-toolkit and Universal zip file, the pkg-toolkit directory contains README file which has the instructions for the user how to install pkg,updatetool, the URL for release notes etc. Setting this as Verified

          People

          • Assignee:
            Tom Mueller
            Reporter:
            Chris Kasso
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: