Bug 573816

Summary: New Feature: extend alert operation docs to include operations on remote resource
Product: [Other] RHQ Project Reporter: Deon Ballard <dlackey>
Component: DocumentationAssignee: Deon Ballard <dlackey>
Status: CLOSED CURRENTRELEASE QA Contact: Corey Welton <cwelton>
Severity: medium Docs Contact:
Priority: high    
Version: 3.0.0CC: cwelton
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:59:11 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 573729, 577256    
Attachments:
Description Flags
alert operations on a remote resource
none
Commented version
none
Commented version as pdf none

Comment 1 Deon Ballard 2010-03-15 21:15:10 UTC
Blocking admin guide tracking bug.

Comment 2 Deon Ballard 2010-05-05 22:41:52 UTC
There are two major concepts that need to be covered here:

* Executing operations (generally)
http://elladeon.fedorapeople.org/jon-drafts/3.0/admin/assigning-alert-operations.html

* Executing scripts (a specific type of operation)
http://elladeon.fedorapeople.org/jon-drafts/3.0/admin/assigning-alert-scripts.html

Comment 3 Deon Ballard 2010-05-17 20:38:32 UTC
Created attachment 414658 [details]
alert operations on a remote resource

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 Charles for review. 

Note:
I don't spell-check anything till the end. So there are probably a lot of typos. Also, I haven't done any screenshots yet, but they will be coming.

Comment 4 Heiko W. Rupp 2010-06-14 10:00:26 UTC
Created attachment 423777 [details]
Commented version

Comment 5 Heiko W. Rupp 2010-06-14 10:00:55 UTC
Created attachment 423778 [details]
Commented version as pdf

Comment 6 Deon Ballard 2010-06-22 00:21:44 UTC
I updated the overview section here with edits based on Heiko's comments in comment #4 and 5:
http://www.redhat.com/docs/en-US/JBoss_ON/2.4/admin/html/alerts.html#about-alert-operations

And then I added a new section on the operations tokens here:
http://www.redhat.com/docs/en-US/JBoss_ON/2.4/admin/html/assigning-alert-operations.html

I think the place to go is to change the status to ON_QA for Corey to verify. But I can kick it to Heiko if it needs more review.

For now, changing status to ON_QA.

Comment 7 Corey Welton 2010-06-22 14:52:58 UTC
QA Verified.  I think these docs look good.

Comment 8 Corey Welton 2010-08-12 16:59:11 UTC
Mass-closure of verified bugs against JON.