Derby
  1. Derby
  2. DERBY-4826

Documentation tasks for new minor release of Derby

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 10.7.1.1
    • Component/s: Documentation
    • Labels:
      None

      Description

      For 10.7 we need to do the following:

      • update the documentation map files with the new release number
      • rerun the tasks in Getting Started and show the new output
      • show the new release number and output in other locations in the manuals (Tools, Dev Guide, possibly others)
      1. DERBY-4826-2.diff
        19 kB
        Kim Haase
      2. DERBY-4826-2.stat
        0.3 kB
        Kim Haase
      3. DERBY-4826-2.zip
        22 kB
        Kim Haase

        Issue Links

          Activity

          Hide
          Kim Haase added a comment -

          Closing, since fixes have appeared in Latest Alpha Manuals.

          Show
          Kim Haase added a comment - Closing, since fixes have appeared in Latest Alpha Manuals.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-4826-2.diff to documentation trunk at revision 1031703.

          Show
          Kim Haase added a comment - Committed patch DERBY-4826 -2.diff to documentation trunk at revision 1031703.
          Hide
          Kim Haase added a comment -

          Thanks, Rick. I'll commit the patch then.

          Show
          Kim Haase added a comment - Thanks, Rick. I'll commit the patch then.
          Hide
          Rick Hillegas added a comment -

          Hi Kim,

          I didn't change the release id in the checked-in version of the release notes yet. The first release candidate will be 10.7.1.0 as you suppose. Thanks.

          Show
          Rick Hillegas added a comment - Hi Kim, I didn't change the release id in the checked-in version of the release notes yet. The first release candidate will be 10.7.1.0 as you suppose. Thanks.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-4826-2.diff, DERBY-4826-2.stat, and DERBY-4826-2.zip, with changes to the following files:

          M src/tools/rtoolssysinfo1002629.dita
          M src/devguide/cdevdvlp27715.dita
          M src/devguide/tdevdvlp20349.dita
          M src/getstart/twwdactivity1.dita
          M src/getstart/twwdactivity3_Setup.dita
          M src/getstart/twwdactivity2.dita
          M src/getstart/twwdactivity4.dita

          The changes show updated startup and shutdown messages as well as some time-stamped output.

          One question: I was assuming a release number of 10.7.1.0, but I see the latest release notes commit for DERBY-4864 shows it as 10.7.0.0. Should I be equally optimistic? It's easy to change.

          Show
          Kim Haase added a comment - Attaching DERBY-4826 -2.diff, DERBY-4826 -2.stat, and DERBY-4826 -2.zip, with changes to the following files: M src/tools/rtoolssysinfo1002629.dita M src/devguide/cdevdvlp27715.dita M src/devguide/tdevdvlp20349.dita M src/getstart/twwdactivity1.dita M src/getstart/twwdactivity3_Setup.dita M src/getstart/twwdactivity2.dita M src/getstart/twwdactivity4.dita The changes show updated startup and shutdown messages as well as some time-stamped output. One question: I was assuming a release number of 10.7.1.0, but I see the latest release notes commit for DERBY-4864 shows it as 10.7.0.0. Should I be equally optimistic? It's easy to change.
          Hide
          Rick Hillegas added a comment -

          Hi Kim,

          I have backed out the changes which parameterized the timestamps and version ids in the examples. If you are still concerned about updating timestamps and version ids, then you may want to revive part of your patch. Thanks.

          Show
          Rick Hillegas added a comment - Hi Kim, I have backed out the changes which parameterized the timestamps and version ids in the examples. If you are still concerned about updating timestamps and version ids, then you may want to revive part of your patch. Thanks.
          Hide
          Rick Hillegas added a comment -

          Hi Kim,

          I believe that I have parameterized all of the material you listed above, with the exception of updating the VM version in src/getstart/tgssetupverify.dita. That one didn't seem too stale to me. We might want to revisit the VM version numbers when we provide support for JDBC 4.1 (Java 7). Thanks.

          Show
          Rick Hillegas added a comment - Hi Kim, I believe that I have parameterized all of the material you listed above, with the exception of updating the VM version in src/getstart/tgssetupverify.dita. That one didn't seem too stale to me. We might want to revisit the VM version numbers when we provide support for JDBC 4.1 (Java 7). Thanks.
          Hide
          Kim Haase added a comment -

          DERBY-4851 makes the current proposed patch for this issue obsolete. I'll delete it.

          Show
          Kim Haase added a comment - DERBY-4851 makes the current proposed patch for this issue obsolete. I'll delete it.
          Hide
          Rick Hillegas added a comment -

          Hi Kim,

          At this point, the work being done on DERBY-4851 has superceded some of the work done in your latest patch. In particular, copyright year and short version id have now been parameterized by variables in docs.properties. I will continue to work on parameterizing the user guides as described in that related issue. Thanks.

          Show
          Rick Hillegas added a comment - Hi Kim, At this point, the work being done on DERBY-4851 has superceded some of the work done in your latest patch. In particular, copyright year and short version id have now been parameterized by variables in docs.properties. I will continue to work on parameterizing the user guides as described in that related issue. Thanks.
          Hide
          Kim Haase added a comment -

          I'm afraid you can't insert the conrefs file value into the map – it's a syntax error if you try doing this –

          <vrmlist><vrm version="<ph conref="../conrefs.dita#vers/shortversionnumber"></ph>"/></vrmlist>

          instead of this:

          <vrmlist><vrm version="10.7"/></vrmlist>

          Good catch about the copyright date, though. If the new release is in a new year, additional tasks are required:

          Updating the second year in this line of the *.map files:

          <copyryear year="2004, 2010"/>

          Updating the second year in this paragraph of the *copyright.dita files:

          <p>Copyright 2004-2010 The Apache Software Foundation</p>

          Not needed for 10.7, but will be for the next release after that, no doubt.

          Show
          Kim Haase added a comment - I'm afraid you can't insert the conrefs file value into the map – it's a syntax error if you try doing this – <vrmlist><vrm version="<ph conref="../conrefs.dita#vers/shortversionnumber"></ph>"/></vrmlist> instead of this: <vrmlist><vrm version="10.7"/></vrmlist> Good catch about the copyright date, though. If the new release is in a new year, additional tasks are required: Updating the second year in this line of the *.map files: <copyryear year="2004, 2010"/> Updating the second year in this paragraph of the *copyright.dita files: <p>Copyright 2004-2010 The Apache Software Foundation</p> Not needed for 10.7, but will be for the next release after that, no doubt.
          Hide
          Rick Hillegas added a comment -

          Thanks for this first increment, Kim. I see that these files have both version ids and copyright notices. Is there any way to update the version ids from what's in conrefs.dita?

          M src/tools/derbytools.ditamap
          M src/tuning/tuningderby.ditamap
          M src/adminguide/derbyadmin.ditamap
          M src/devguide/derbydev.ditamap
          M src/ref/refderby.ditamap
          M src/getstart/getstartderby.ditamap

          Show
          Rick Hillegas added a comment - Thanks for this first increment, Kim. I see that these files have both version ids and copyright notices. Is there any way to update the version ids from what's in conrefs.dita? M src/tools/derbytools.ditamap M src/tuning/tuningderby.ditamap M src/adminguide/derbyadmin.ditamap M src/devguide/derbydev.ditamap M src/ref/refderby.ditamap M src/getstart/getstartderby.ditamap
          Hide
          Kim Haase added a comment -

          Attaching a preliminary patch that makes only the map and conrefs changes. I'd like to wait to rerun the others until the build no longer says "alpha" and possibly the line break between the startup and shutdown messages is restored (DERBY-4755).

          The zip file contains a sample one-page HTML file that shows the results of both changes. The version numbers at the beginning of the file reflect the map change, and the ij output topics reflect the conrefs changes.

          If this seems okay, I can commit it and save the other changes for later.

          Show
          Kim Haase added a comment - Attaching a preliminary patch that makes only the map and conrefs changes. I'd like to wait to rerun the others until the build no longer says "alpha" and possibly the line break between the startup and shutdown messages is restored ( DERBY-4755 ). The zip file contains a sample one-page HTML file that shows the results of both changes. The version numbers at the beginning of the file reflect the map change, and the ij output topics reflect the conrefs changes. If this seems okay, I can commit it and save the other changes for later.
          Hide
          Kim Haase added a comment -

          This is as complete a list of tasks as I can come up with.

          src/conrefs.dita: Need to bump the release in these lines:

          <p><ph id="fullversionnumber">Version 10.7</ph></p>
          <p><ph id="shortversionnumber">10.7</ph></p>

          This will affect the output of 29 files, I believe.

          Every .map file needs to bump the release in this line:

          <vrmlist><vrm version="10.7"/></vrmlist>

          Rerun output for the following topics:

          src/devguide/cdevdvlp27715.dita
          src/devguide/tdevdvlp20349.dita
          src/tools/rtoolssysinfo1002629.dita
          src/getstart/tgssetupverify.dita (show an up-to-date JDK)
          src/getstart/twwdactivity1.dita
          src/getstart/twwdactivity2.dita
          src/getstart/twwdactivity3_Setup.dita (timestamps only)
          src/getstart/twwdactivity4.dita

          Show
          Kim Haase added a comment - This is as complete a list of tasks as I can come up with. src/conrefs.dita: Need to bump the release in these lines: <p><ph id="fullversionnumber">Version 10.7</ph></p> <p><ph id="shortversionnumber">10.7</ph></p> This will affect the output of 29 files, I believe. Every .map file needs to bump the release in this line: <vrmlist><vrm version="10.7"/></vrmlist> Rerun output for the following topics: src/devguide/cdevdvlp27715.dita src/devguide/tdevdvlp20349.dita src/tools/rtoolssysinfo1002629.dita src/getstart/tgssetupverify.dita (show an up-to-date JDK) src/getstart/twwdactivity1.dita src/getstart/twwdactivity2.dita src/getstart/twwdactivity3_Setup.dita (timestamps only) src/getstart/twwdactivity4.dita
          Hide
          Kim Haase added a comment -

          That's a good idea, thanks, Rick.

          The first task (all I've got to so far) is that every .map file needs to bump the release in this line:

          <vrmlist><vrm version="10.7"/></vrmlist>

          Show
          Kim Haase added a comment - That's a good idea, thanks, Rick. The first task (all I've got to so far) is that every .map file needs to bump the release in this line: <vrmlist><vrm version="10.7"/></vrmlist>
          Hide
          Rick Hillegas added a comment -

          Hi Kim,

          As you work through this issue, could you keep track of what files you have to touch and how you have to change them? It seems to me that much of this work could be automated and become part of the master target for building release distributions.

          Thanks,
          -Rick

          Show
          Rick Hillegas added a comment - Hi Kim, As you work through this issue, could you keep track of what files you have to touch and how you have to change them? It seems to me that much of this work could be automated and become part of the master target for building release distributions. Thanks, -Rick

            People

            • Assignee:
              Kim Haase
              Reporter:
              Kim Haase
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development