glassfish
  1. glassfish
  2. GLASSFISH-17966

Update the Documentation links on the Common Tasks page to specify 3.1.2 documents

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 3.1.2
    • Fix Version/s: 3.1.2_dev
    • Component/s: admin_gui
    • Labels:
      None

      Description

      The URLs in the links to documents from the Common Tasks Page must be updated to specify the documents for 3.1.2 as in the following table.

      Document URL
      Quick Start Guide http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSQSG
      Administration Guide http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSADG
      Application Development Guide http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSDVG
      Application Deployment Guide http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSDPG

        Activity

        Hide
        Paul Davies added a comment -

        Changed type from task to bug to ensure that this issue is not missed.

        Show
        Paul Davies added a comment - Changed type from task to bug to ensure that this issue is not missed.
        Hide
        Anissa Lam added a comment -

        Actually, I think the doc team should own this bug.
        This is in the Strings.properties file, which doc team always edit for inline help.
        The link itself is also provided by the doc team.
        It may be better for doc team to take care of this, to ensure the doc link is correct, and i am not introducing any error.

        But i will do this again like previous release.

        Show
        Anissa Lam added a comment - Actually, I think the doc team should own this bug. This is in the Strings.properties file, which doc team always edit for inline help. The link itself is also provided by the doc team. It may be better for doc team to take care of this, to ensure the doc link is correct, and i am not introducing any error. But i will do this again like previous release.
        Hide
        Anissa Lam added a comment -
        • What is the impact on the customer of the bug?
          The link allows user to bring up the unbundle doc from console. Without the change, they will be looking at the previous version release.
        • What is the cost/risk of fixing the bug?
          20 min. fix is ready, just change the Strings.properties file.
        • Is there an impact on documentation or message strings?
          no.
        • Which tests should QA (re)run to verify the fix did not destabilize GlassFish?
          Just ensure the common task page (the landing page) comes up ok like before. There is no way to test if the link really works, since those doc will not be available online till the product ships. This link is provided by the doc team, so hopefully it is correct.

        Which is the targeted build of 3.1.2 for this fix?
        3_1_2_b16

        Here is the diff:

        Index: src/main/resources/org/glassfish/admingui/core/Strings.properties
        ===================================================================
        — src/main/resources/org/glassfish/admingui/core/Strings.properties (revision 51681)
        +++ src/main/resources/org/glassfish/admingui/core/Strings.properties (working copy)
        @@ -427,10 +427,10 @@
        commonTasks.task.adminPassword.toolTip=Change Administrator Password

        1. change the doc link to the localized copy if there is any
          -commonTasks.doc.qstart=http://www.oracle.com/pls/topic/lookup?ctx=821-2432&id=sjsaseeqsg
          -commonTasks.doc.adminGuide=http://www.oracle.com/pls/topic/lookup?ctx=821-2416&id=sjsaseeag
          -commonTasks.doc.devGuide=http://www.oracle.com/pls/topic/lookup?ctx=821-2418&id=sjsaseedg
          -commonTasks.doc.deployGuide=http://www.oracle.com/pls/topic/lookup?ctx=821-2417&id=sjsaseeadg
          +commonTasks.doc.qstart=http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSQSG
          +commonTasks.doc.adminGuide=http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSADG
          +commonTasks.doc.devGuide=http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSDVG
          +commonTasks.doc.deployGuide=http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSDPG
        1. end Common Tasks keys
        Show
        Anissa Lam added a comment - What is the impact on the customer of the bug? The link allows user to bring up the unbundle doc from console. Without the change, they will be looking at the previous version release. What is the cost/risk of fixing the bug? 20 min. fix is ready, just change the Strings.properties file. Is there an impact on documentation or message strings? no. Which tests should QA (re)run to verify the fix did not destabilize GlassFish? Just ensure the common task page (the landing page) comes up ok like before. There is no way to test if the link really works, since those doc will not be available online till the product ships. This link is provided by the doc team, so hopefully it is correct. Which is the targeted build of 3.1.2 for this fix? 3_1_2_b16 Here is the diff: Index: src/main/resources/org/glassfish/admingui/core/Strings.properties =================================================================== — src/main/resources/org/glassfish/admingui/core/Strings.properties (revision 51681) +++ src/main/resources/org/glassfish/admingui/core/Strings.properties (working copy) @@ -427,10 +427,10 @@ commonTasks.task.adminPassword.toolTip=Change Administrator Password change the doc link to the localized copy if there is any -commonTasks.doc.qstart= http://www.oracle.com/pls/topic/lookup?ctx=821-2432&id=sjsaseeqsg -commonTasks.doc.adminGuide= http://www.oracle.com/pls/topic/lookup?ctx=821-2416&id=sjsaseeag -commonTasks.doc.devGuide= http://www.oracle.com/pls/topic/lookup?ctx=821-2418&id=sjsaseedg -commonTasks.doc.deployGuide= http://www.oracle.com/pls/topic/lookup?ctx=821-2417&id=sjsaseeadg +commonTasks.doc.qstart= http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSQSG +commonTasks.doc.adminGuide= http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSADG +commonTasks.doc.devGuide= http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSDVG +commonTasks.doc.deployGuide= http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSDPG end Common Tasks keys
        Hide
        Anissa Lam added a comment -

        Changes checked in. This only applies to 3.1.2, not to trunk. I will leave the trunk link the same.

        Show
        Anissa Lam added a comment - Changes checked in. This only applies to 3.1.2, not to trunk. I will leave the trunk link the same.

          People

          • Assignee:
            Anissa Lam
            Reporter:
            Paul Davies
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: