Bug 586099

Summary: need documentation for how people write custom alert notification plugins
Product: [Other] RHQ Project Reporter: Charles Crouch <ccrouch>
Component: DocumentationAssignee: Deon Ballard <dlackey>
Status: CLOSED CURRENTRELEASE QA Contact: Corey Welton <cwelton>
Severity: low Docs Contact:
Priority: low    
Version: unspecifiedCC: cwelton, dlackey, hbrock
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: 2.4 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2010-08-12 16:50:05 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---
Bug Depends On:    
Bug Blocks: 577217    
Attachments:
Description Flags
alert example docs
none
Added comments none

Description Charles Crouch 2010-04-26 19:42:33 UTC

Comment 1 Deon Ballard 2010-05-17 19:27:28 UTC
I have an example alert notification plug-in broken down here:
http://elladeon.fedorapeople.org/jon-drafts/3.0/plugins/example-alert-sender.html

This is an example of a larger chapter on writing server-side plug-ins. 
http://elladeon.fedorapeople.org/jon-drafts/3.0/plugins/writing-serverside-plugins.html

Comment 2 Deon Ballard 2010-05-17 19:28:24 UTC
Created attachment 414642 [details]
alert example docs

The tech review process is easy:

1. Download the attached OpenOffice doc.

2. Make sure that Edit > Changes > Record is selected. (I should have this set to track changes, but make sure in case I forgot.)

3. Read through the file and mark any changes (correct anything that's wrong, add missing information, delete outdated stuff, etc.).

4. When you're done editing, upload the edited OO doc and re-assign to me (dlackey).   

The HTML links in the previous comment show what the real, official docs look like, if you prefer that version. I can also make a PDF.

Changing status to ON_DEV and assigning to Heiko for review.

Comment 3 Heiko W. Rupp 2010-05-20 09:22:41 UTC
Created attachment 415356 [details]
Added comments

Comment 4 Deon Ballard 2010-06-22 16:26:03 UTC
The updated example alert sender docs, with Heiko's edits, are at http://www.redhat.com/docs/en-US/JBoss_ON/2.4/plugins/html/example-alert-sender.html.

Changing to ON_QA.

Comment 5 Corey Welton 2010-07-19 23:50:40 UTC
QA Verified.

Comment 6 Corey Welton 2010-08-12 16:50:05 UTC
Mass-closure of verified bugs against JON.