[publican-list] [Bug 706302] New: RFE: Improvements to publican-jboss brand for better docs bug BZ integration.

[bugzilla at redhat.com]

Please do not reply directly to this email. All additional
comments should be made in the comments box of this bug.

Summary: RFE: Improvements to publican-jboss brand for better docs bug BZ integration.

https://bugzilla.redhat.com/show_bug.cgi?id=706302

           Summary: RFE: Improvements to publican-jboss brand for better
                    docs bug BZ integration.
           Product: Publican
           Version: 2.5
          Platform: i386
        OS/Version: Linux
            Status: NEW
          Severity: medium
          Priority: unspecified
         Component: publican
        AssignedTo: jfearn at redhat.com
        ReportedBy: jmorgan at redhat.com
         QAContact: rlandman at redhat.com
                CC: mmcallis at redhat.com, publican-list at redhat.com
    Classification: Other
      Story Points: ---


Created attachment 499974
  --> https://bugzilla.redhat.com/attachment.cgi?id=499974
Feedback.xml file used in the JBoss Messaging User Guide

Enhancement Overview:

Update the publican-jboss brand 
with new entities and a revised Feedback.xml file to make raising a
documentation bugs as easy as possible for customers.

Background:

To ensure consistency in Middleware documentation, the Feedback.xml file should
be used across all JBoss books. However, Projects are currently overriding the
brand's Feedback.xml file to add functionality not currently supported. This
has been noted as adding unnecessary translation overhead.

By tweaking the BZ URL, you can pre-fill a BZ bug report with the correct
Product, Component, and a default summary title with the name of the user guide
populated. This makes it much easier for a customer to create a documentation
bug for a user guide.

An example of this is demonstrated in the JBoss Messaging User Guide [1]. Click
the bugzilla.redhat.com link in the guide to see the functionality.

Proposed Enhancement:

1. Update the Feedback.xml file to match the one used in the Messaging User
Guide [1] (Feedback.xml file attached to this issue)
2. Include entities used in the attached Feedback.xml file in the
publican-jboss brand so they are automatically added to the .ent file when a
new book is created. (Messaging_User_Guide.ent file attached to this issue)

Links:

[1] -
http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/5/html-single/JBoss_Messaging_User_Guide/index.html#jboss-feedback

-- 
Configure bugmail: https://bugzilla.redhat.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.