mirror of
				https://github.com/ansible-collections/community.general.git
				synced 2025-10-25 05:23:58 -07:00 
			
		
		
		
	[PR #9455/d887930e backport][stable-9] normalize docs in callback plugins (#9466)
normalize docs in callback plugins (#9455)
* normalize docs in callback plugins
Normalize doc blocks for plugins
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit d887930e49)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
	
	
This commit is contained in:
		
					parent
					
						
							
								015496fa9e
							
						
					
				
			
			
				commit
				
					
						6f3cfd3385
					
				
			
		
					 26 changed files with 1478 additions and 1489 deletions
				
			
		|  | @ -6,7 +6,7 @@ | |||
| from __future__ import (absolute_import, division, print_function) | ||||
| __metaclass__ = type | ||||
| 
 | ||||
| DOCUMENTATION = r''' | ||||
| DOCUMENTATION = r""" | ||||
| name: sumologic | ||||
| type: notification | ||||
| short_description: Sends task result events to Sumologic | ||||
|  | @ -15,8 +15,8 @@ description: | |||
|   - This callback plugin will send task results as JSON formatted events to a Sumologic HTTP collector source. | ||||
| requirements: | ||||
|   - Whitelisting this callback plugin | ||||
|   - 'Create a HTTP collector source in Sumologic and specify a custom timestamp format of V(yyyy-MM-dd HH:mm:ss ZZZZ) and a custom timestamp locator | ||||
|     of V("timestamp": "(.*\)")' | ||||
|   - 'Create a HTTP collector source in Sumologic and specify a custom timestamp format of V(yyyy-MM-dd HH:mm:ss ZZZZ) and | ||||
|     a custom timestamp locator of V("timestamp": "(.*\)")' | ||||
| options: | ||||
|   url: | ||||
|     description: URL to the Sumologic HTTP collector source. | ||||
|  | @ -26,10 +26,10 @@ options: | |||
|     ini: | ||||
|       - section: callback_sumologic | ||||
|         key: url | ||||
| ''' | ||||
| """ | ||||
| 
 | ||||
| EXAMPLES = ''' | ||||
| examples: | | ||||
| EXAMPLES = r""" | ||||
| examples: |- | ||||
|   To enable, add this to your ansible.cfg file in the defaults block | ||||
|     [defaults] | ||||
|     callback_whitelist = community.general.sumologic | ||||
|  | @ -40,7 +40,7 @@ examples: | | |||
|   Set the ansible.cfg variable in the callback_sumologic block | ||||
|     [callback_sumologic] | ||||
|     url = https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/R8moSv1d8EW9LAUFZJ6dbxCFxwLH6kfCdcBfddlfxCbLuL-BN5twcTpMk__pYy_cDmp== | ||||
| ''' | ||||
| """ | ||||
| 
 | ||||
| import json | ||||
| import uuid | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue