Bug 573816 - New Feature: extend alert operation docs to include operations on remote resource
Summary: New Feature: extend alert operation docs to include operations on remote reso...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: RHQ Project
Classification: Other
Component: Documentation
Version: 3.0.0
Hardware: All
OS: Linux
high
medium
Target Milestone: ---
: ---
Assignee: Deon Ballard
QA Contact: Corey Welton
URL:
Whiteboard:
Depends On:
Blocks: 573729 jon24-alert-scripts
TreeView+ depends on / blocked
 
Reported: 2010-03-15 20:44 UTC by Deon Ballard
Modified: 2010-08-12 16:59 UTC (History)
1 user (show)

Fixed In Version: 2.4
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2010-08-12 16:59:11 UTC
Embargoed:


Attachments (Terms of Use)
alert operations on a remote resource (15.97 KB, application/vnd.oasis.opendocument.text)
2010-05-17 20:38 UTC, Deon Ballard
no flags Details
Commented version (64.32 KB, application/vnd.oasis.opendocument.text)
2010-06-14 10:00 UTC, Heiko W. Rupp
no flags Details
Commented version as pdf (79.98 KB, application/pdf)
2010-06-14 10:00 UTC, Heiko W. Rupp
no flags Details

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.


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