Bug 993399

Summary:	Developer Guide: Grouping API section should describe a use case
Product:	[JBoss] JBoss Data Grid 6	Reporter:	Divya Mehra <dmehra>
Component:	Documentation	Assignee:	Misha H. Ali <mhusnain>
Status:	CLOSED CURRENTRELEASE	QA Contact:
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	6.1.0	CC:	dmehra, jdg-bugs, mmarkus, ttarrant
Target Milestone:	ER3
Target Release:	6.2.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2013-11-07 22:50:46 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Divya Mehra 2013-08-05 20:36:13 UTC

Document URL: 
https://access.redhat.com/site/documentation/en-US/JBoss_Data_Grid/6.1/html-single/Developer_Guide/index.html#chap-The_Grouping_API

It is not clear to the reader what the Grouping API can help and application developer achieve. 

"When using the Grouping API, JBoss Data Grid creates and uses the hash of the group instead of the hash of the key to determine which node will house the entry." <-- but what does it help accomplish?

Section Number and Name: 

Describe the issue: 
There is no concrete example which brings out the value of the Grouping API to the reader.

Suggestions for improvement: 
Include a simple example, which outlines a typical problem which an application developer would face. The show how the Grouping API solves this problem (with code).

Additional information:

Comment 2 Misha H. Ali 2013-08-05 22:50:11 UTC

Rakesh is working on generic use cases, but assuming the information is provided, we can accommodate specific use cases within the next week or so.

Adding Tristan so that he can point us to the appropriate SME for this.

Comment 4 Misha H. Ali 2013-08-07 01:31:14 UTC

No response yet, adding Mircea as a need info to this bug to track issue.

Comment 5 Misha H. Ali 2013-08-13 00:26:17 UTC

Received feedback from Mircea. Updated Grouping API chapter to reflect information and requested Mircea's review again.

Comment 6 Misha H. Ali 2013-08-21 02:49:46 UTC

No response for the draft review request yet. Setting to modified unless review indicates further work to be done for this bug.

Comment 7 Misha H. Ali 2013-09-06 05:12:35 UTC

One of the SMEs has commented on the pad, checking with Tristan and Mircea to identify the SME and request further information.

Comment 8 Misha H. Ali 2013-10-01 03:33:27 UTC

Reminded Tristan to review use case, along with other grouping API content.

Comment 10 Misha H. Ali 2013-11-07 22:50:46 UTC

This bug is approved and available at:

https://access.redhat.com/site/documentation/Red_Hat_JBoss_Data_Grid/