Bug 699993 - Bugzilla link on Docbook output pages
Summary: Bugzilla link on Docbook output pages
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: PressGang CCMS
Classification: Community
Component: Web-UI
Version: 1.x
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Matthew Casperson
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks: 699936
TreeView+ depends on / blocked
 
Reported: 2011-04-27 07:58 UTC by Joshua Wulf
Modified: 2014-10-19 22:58 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2011-05-18 08:18:19 UTC


Attachments (Terms of Use)

Description Joshua Wulf 2011-04-27 07:58:54 UTC
We need to also put a bugzilla link on all Docbook output pages.

This will enable the public to report defects against our published documentation using bugzilla.

The Bugzilla product and component should be configurable per build (and saveable for future builds). 

Here is one that prepopulates the Summary and Description:
https://bugzilla.redhat.com/enter_bug.cgi?product=Topic%20Tool;component=web-Topic_Index;short_desc=TopicID%20+%20Build.Date;comment=Here%20is%20some%20information

We should be sure to populate the bug report with sufficient information for
Skynet to identify the topic and the particular build that the bug was reported
against.

Comment 1 Matthew Casperson 2011-05-10 00:16:07 UTC
Done

Comment 2 Joshua Wulf 2011-05-13 11:55:15 UTC
Current the Bugzilla link says:
"Built with Skynet version 20110513-0753"

ref: http://jboss-eap.bne.redhat.com/EAP6/wireframe/130511/PlaceholderXRef802.html

Please change it to say:

Report a Bug: <a href="bugzilla_page">[topicid]</a>

and put it just above the "Built with Skynet" remark.

The "Report a Bug: <topicid>" has two audiences:
1. ECS authors who are troubleshooting a build. They will use the topic ID to find the source to fix a problem in the topic content, and to change the topic metadata to fix a problem in navigation location.
2. End-users, who will use this link to log a bug against the content of the topic.

Being able to see the topicid at a glance is important for the first audience, ECS authors. For the second audience, end-users, being able to log a bug against a specific topic at a click is important. It is also important that the topic ID be inserted into the bug.

The "Report a Bug" message is used during development and in production.

The "Built with Skynet version XXXX" is used during development, and is turned off in production. 

So the two messages need to be implemented as distinct and independent lines of output.

Comment 3 Joshua Wulf 2011-05-13 12:01:11 UTC
IN addition to the comment above, the Bugzilla link in Skynet 20110513-0753 is only being output on pages where there is no existing topic xml, such as:
http://jboss-eap.bne.redhat.com/EAP6/wireframe/130511/PlaceholderXRef802.html

On pages where there is topic xml to render, the Bugzilla link does not appear:
http://jboss-eap.bne.redhat.com/EAP6/wireframe/130511/Tasks_Middleware_AS_Install_JBoss_AS.html

Comment 4 Matthew Casperson 2011-05-16 02:55:02 UTC
Fixed in 20110516-1246

Comment 5 Joshua Wulf 2011-05-18 01:18:09 UTC
Still not output on a page with topic content: http://jboss-eap.bne.redhat.com/wireframes/EAP6/110518/Tasks_Middleware_AS_Add_System_Properties.html

Built with Skynet version 20110518-0722
ref: http://jboss-eap.bne.redhat.com/wireframes/EAP6/110518/PlaceholderXRef1221.html

Comment 6 Matthew Casperson 2011-05-18 01:32:11 UTC
Fixed in 20110518-1131

I assume this bug means that the Built with "Skynet version 20110518-0722" link is a para rather than a remark.

Comment 7 Joshua Wulf 2011-05-18 01:53:34 UTC
Built with Skynet needs to formatted like this:

<remark>
  <para>
    <ulink url="link to query">Built with Skynet version 20110518-0722</ulink>  
  </para>
</remark>

Comment 8 Matthew Casperson 2011-05-18 03:17:32 UTC
Fixed in 20110518-1131

Comment 9 Joshua Wulf 2011-05-18 08:18:19 UTC
Merged this bug with the one for the Builder ID into:  

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


Note You need to log in before you can comment on or make changes to this bug.