• Documentation (Ref Guide, User Guide, etc.)
    • Low
    • Not Required
    • ON_QA

      Hi Laura,
      we have found several issues in HornetQ documentation.

      Correction for the documentation of EAP 5.1 - HornetQ User Guide

      • all mistakes were search in the pdf version
      • tables are correct in HTML, HTML-SINGLE and EPUB version but all the other mistakes in the text are the same

      Section 2.2 Application Code
      correct Table 2.1 - "text overflow"

      Section 2.5 Migrating JMS-administered Objects and Bridges
      correct Table 2.4 - "text overflow"
      correct Table 2.5 - "text overflow"
      correct Table 2.7 - "text overflow"

      Section 3.2.2
      Change "JEE" to "Java EE" - Check the whole documentation for this

      Section 3.2.2.1
      Change "Procedure XXX and Procedure XXX describe..." to "Procedure 3.1 and Procedure 3.2 describe..."

      Chapter 10. The Client Classpath
      in the warning: change "...can be found in the lib directory of the HornetQ distribution .." to "...can be found in the $JBOSS_HOME/client directory of the EAP distribution... "

      Section 11.3
      change "ant deploy" to "./build.sh deploy"
      change "ant run" to "./build.sh run"

      Chapter 16.
      there is a text "It defines and defines its..." - must be corrected

      Section 16.2
      there is a missing space in the text "...element in the hornetq-jms.xmlfile on the server..."

      Section 23.3.1
      correct Table 23.1 - "text overflow"

      Section 23.3.2
      there is a "W" letter in the second row

      Section 25.2
      there is "setting" at the beginning of a sentence

      Section 28.2
      the last example of configuration in this section- bad align of the first line - "<connection-factory name="ConnectionFactory">" - must be on the left

      Section30.7.1
      there is a missing "n" in "... and so o."

      Section 32.1.1

      • the paragraph: " The TransactionManagement annotation tells the container to manage the
        transaction. The TransactionAttribute annotation tells the container that a JTA
        transaction is required for this MDB. Note that the only other valid value for this is
        TransactionAttributeType.NOT_SUPPORTED which tells the container that this MDB does not
        support JTA transactions and one should not be created. " – it seems that it has a bad aligning

      Section 32.2
      correct "JEE" in the title to "Java EE"

      Section 32.4
      correct "EE components" to "Java EE components" (Check the whole document for this)

      Section 32.4.1
      Table 32.1 - "text overflow" and the table behind it doesn't hava a description + also "text overflow"

      Section 32.4.2
      "</connection-definition>" in the configuration example is a bad aligning - move to right

      Section 32.6.1.1
      in the last configuration example is a bad aligning

      Section 33.3

      • "Different implementations can be provided with the
        org.hornetq.jms.bridge.DestinationFactory interface. " - seems to have a bad aligning

      Section 34.3
      in the configuration example is a bad aligning

      Section 38.2.4.1 and 38.2.4.2
      in the configuration example is a bad aligning

      Section 38.5.2
      in the Note change "HornetQ 2.0.0" to "HornetQ 2.1.x"

      Section 39.1.1.1.1
      in the both configuration examples is a bad aligning "</factory-class>"

      Section 39.1.1.2.1
      in the both configuration examples is a bad aligning - move to left

      Section 39.2.1.2
      3rd paragraph seems to have a bad aligning

      Section 47.1.1
      table after a table 47.1 has no description and "text overflow"
      Section 47.1.2

      • table 47.2 "text overflow"

      Thank you

              rrajasek@redhat.com Rajesh Rajasekaran
              pslavice@redhat.com Pavel Slavicek
              Jared Morgan Jared Morgan (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved:

                  Estimated:
                  Original Estimate - 30 minutes
                  30m
                  Remaining:
                  Remaining Estimate - 30 minutes
                  30m
                  Logged:
                  Time Spent - Not Specified
                  Not Specified