Bug 571833 - QA doc review for rhq alerts
Summary: QA doc review for rhq alerts
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: RHQ Project
Classification: Other
Component: Documentation
Version: 3.0.0
Hardware: All
OS: Linux
low
medium
Target Milestone: ---
: ---
Assignee: Deon Ballard
QA Contact: Corey Welton
URL:
Whiteboard:
Depends On:
Blocks: rhq_triage 573729
TreeView+ depends on / blocked
 
Reported: 2010-03-09 16:49 UTC by wes hayutin
Modified: 2010-05-17 22:25 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2010-05-17 22:25:51 UTC
Embargoed:


Attachments (Terms of Use)

Description wes hayutin 2010-03-09 16:49:56 UTC
Description of problem:

March 09 2010 Test Day - Alerts - Documentation review

??? is there anyway to turn on line numbers for the rhq wiki ??? 
??? is it still appropriate to link to JOPR doc ???

 * Alert creation documentation already exists here(which is ok if you intended to rewrite it.):
   * https://www.redhat.com/docs/en-US/JBoss_ON/2.3/html/Feature_Guide/chap-Feature_Guide-Alerts.html (includes conditions, dampening, etc)  (
   * Your documentation seems to be more complete then the documentation listed in these links, however there is duplication.
   * https://www.redhat.com/docs/en-US/JBoss_ON/2.3/html/Feature_Guide/sect-Feature_Guide-Events-Defining_Alerts_on_Events.html
   * https://www.redhat.com/docs/en-US/JBoss_ON/2.3/html/Feature_Guide/sect-Feature_Guide-Monitoring_Defaults-Alert_Templates.html
 * Sections 1.3.2 and 1.3.3  - should be reversed; knowing how to create alerts themselves should preface creating alert templates.  Especially evident given "Brief Introduction to Alerts and Notifications" subsection in 1.3.3.  
 * Include additional alert sender methods:  && update Default Alert Senders two
   * RHQ has several different methods of sending a notification:
     * Email
     * IRC (chat)
     * Microblogging (such as Twitter and Laconica)
     * Mobicents (voice mail)
     * SNMP traps
     * Operations
     * Roles
     * ScriptLang
 * Section 1.3.4 - enumerated list should be expanded onto multiple lines
 * Section 1.3.7 - "Wild cards (*) and other expressions are allowed." seems awkward/incomplete. (found in "Viewing Alert Definitions" and "Viewing Alerts" subsections)
 * Section 1.3.9 - fix  "&VER;" references
 * Section 1.3.9 - "Migrating alerts from older versions of Jopr is not (officially) supported"  -- strike "(officially)" or find a better way to phrase this.
 * Section 1.3.9 (and presumably elsewhere) - is there some convention for writing out filenames, i.e., dumpAlertDefinitions.js, alertDefinitions.csv?
 * Notifications section - It is also possible to write custom alert methods, which are implemented as server-side plug-ins. For more information on writing plug-ins, see XREF - fix XREF
 * Somehow rephrase  Automatic Responses (Operations)  
   * maybe.... Automatic Response - using operations to perform actions in response to alerts... 
 * Strike "In RHQ, alert notifications allow that kind of clustering." in tooltip
 * Change "It is also possible to acknowledge a single alert through the alert detail's page." to "It is also possible to acknowledge a single alert through the alert details page."
 * Section 1.3.6.2: "Four results elements are important for organizing the definitions:"...  I think that 'attributes' might be a better descriptor for 'results elements'...  also, why are these important and how do they organize definitions?
 * Comma splices:
   * "When an alert is acknowledged, the name of the user who acknowledged the alert is recorded, so the action can be audited later if necessary." - between recorded and so
   * "Select the Resources menu in the top navigation bar, and select the Servers menu item." - bet
 * 
 * "Despite the name, the operations performed in response to an alert are not the same as the operations which can be scheduled to run on a resource." - we don't know what this means.  as far as we know, they ARE the same.
 * 
 * 
 * Change "To create a template alert definition:" to "Creating an Alert Definition Template" in bold to match its counterpart heading "Creating an Alert Sender Template"
 * 
 * You listed a question..  Alert Notification templates  can be found http://server:7080/rhq/resource/alert/notif/notificationTemplates.xhtml

 * 
 * 
 *  change XREF in  Click the Edit Alert Templates button to create a global alert definition. Set up the alert exactly the same way as setting an alert for a single resource (as in XREF).
 * Please change 
   * Brief Introduction to Alerts and Notifications
   * An alert is a configuration that lets an administrator know that something is happened ===> to something has happened
 * SSHD => sshd, there is no need to put in caps


----
Server Side Plugins:
 * "GUI plug-ins for customizing workflows within the server interface or for getting additional functionality in the GUI" - I'm not sure this is still true, are these plugins still going to be part of RHQ?

Comment 1 Deon Ballard 2010-03-15 17:07:06 UTC
Blocking admin guide tracker.

Comment 2 Deon Ballard 2010-04-10 01:27:53 UTC
I made all the changes in the description, with the exception of this one...

is there some convention for writing out filenames, i.e., dumpAlertDefinitions.js, alertDefinitions.csv?


What does this mean? What needs done?

Comment 3 Deon Ballard 2010-04-10 01:35:10 UTC
Oh, for the server-side plug-ins comment:

I believe that the perspectives plug-ins (what I called the GUI plug-ins) are still going to be included with JON. So I left that part alone for now.

Comment 4 Deon Ballard 2010-05-17 22:25:51 UTC
Closing the bug. The edits are in place as indicated, and future changes are going to be handled in these bugs:

* bug 586099
* bug 573815
* bug 573816


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