Uploaded image for project: 'Derby'
  1. Derby
  2. DERBY-1920

DOCS - Improve topic titles for vague and duplicate topics

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 10.2.1.6
    • Fix Version/s: 10.2.2.1, 10.3.1.4
    • Component/s: Documentation
    • Labels:
      None

      Description

      1) Many of the topic titles are vague.
      Examples -
      a) Almost all of the titles for the built-in function topics do not indicate that the topic is about a "function".
      The word "function" should be added to all of the reference topics (In the Reference Manual) that discuss the built in functions
      b) Almost all of the titles for the data type topics do not indicate that the topic is about a data type.
      The words "data type" should be added to all of the reference topics (In the Reference Manual) that discuss the data types
      c) Some of the SQL statement topic titles do not include the word "statement" in the title and they should.

      2)Some of the topics use the same title, but discuss very different things. Each topic title in the Derby documentation should be
      unique.
      Examples -
      LOCK TABLE statement in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefsqlj40506.html)
      and in the Tuning Guide (http://db.apache.org/derby/docs/dev/tuning/ctunoptimz11775.html)

      This is just one of several examples.

        Attachments

        1. DERBY-1920-tuning.zip
          2 kB
          Kim Haase
        2. DERBY-1920-tuning.diff
          1 kB
          Kim Haase
        3. DERBY-1920-tools-2.zip
          116 kB
          Kim Haase
        4. DERBY-1920-tools-2.diff
          44 kB
          Kim Haase
        5. DERBY-1920-tools.zip
          116 kB
          Kim Haase
        6. DERBY-1920-tools.diff
          44 kB
          Kim Haase
        7. DERBY-1920-ref9.zip
          18 kB
          Kim Haase
        8. DERBY-1920-ref9.diff
          22 kB
          Kim Haase
        9. DERBY-1920-ref8.zip
          9 kB
          Kim Haase
        10. DERBY-1920-ref8.diff
          46 kB
          Kim Haase
        11. DERBY-1920-ref7.zip
          32 kB
          Kim Haase
        12. DERBY-1920-ref7.diff
          30 kB
          Kim Haase
        13. DERBY-1920-ref6.zip
          84 kB
          Kim Haase
        14. DERBY-1920-ref6.diff
          29 kB
          Kim Haase
        15. DERBY-1920-ref5.zip
          79 kB
          Kim Haase
        16. DERBY-1920-ref5.diff
          30 kB
          Kim Haase
        17. DERBY-1920-ref4.zip
          42 kB
          Kim Haase
        18. DERBY-1920-ref4.diff
          12 kB
          Kim Haase
        19. DERBY-1920-ref3.zip
          45 kB
          Kim Haase
        20. DERBY-1920-ref3.diff
          10 kB
          Kim Haase
        21. DERBY-1920-ref2.zip
          46 kB
          Kim Haase
        22. DERBY-1920-ref2.diff
          10 kB
          Kim Haase
        23. DERBY-1920-ref1.zip
          17 kB
          Kim Haase
        24. DERBY-1920-ref1.diff
          5 kB
          Kim Haase
        25. DERBY-1920-devguide.zip
          15 kB
          Kim Haase
        26. DERBY-1920-devguide.diff
          11 kB
          Kim Haase
        27. DERBY-1920-adminguide.zip
          23 kB
          Kim Haase
        28. DERBY-1920-adminguide.diff
          11 kB
          Kim Haase
        29. DERBY-1920.list-3.txt
          20 kB
          Kim Haase
        30. DERBY-1920.list-2.txt
          15 kB
          Kim Haase
        31. DERBY-1920.list
          14 kB
          Kim Haase
        32. DERBY-1920_list_ls.htm
          16 kB
          Laura Stewart

          Activity

            People

            • Assignee:
              chaase3 Kim Haase
              Reporter:
              scotsmatrix Laura Stewart
            • Votes:
              1 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: