Bug 809968

Summary:	Docs: Create narrative output
Product:	[JBoss] JBoss Data Grid 6	Reporter:	mark yarborough <myarboro>
Component:	Documentation	Assignee:	Misha H. Ali <mhusnain>
Status:	CLOSED CURRENTRELEASE	QA Contact:	prabhat jha <pjha>
Severity:	high	Docs Contact:
Priority:	high
Version:	6.0.0	CC:	asantos, jdg-bugs, myarboro, pmuir
Target Milestone:	---
Target Release:	6.0.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2012-04-19 02:14:15 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 mark yarborough 2012-04-04 18:47:14 UTC

As of JDG6 Beta1 in April 2012, QE indicated that the topic-based 
navigation was very confusing. This is an important problem to fix
before GA, and it may take several tries due to the fragmented nature
of the topic-based approach and the subjective perception of "Good
navigation." Asking Misha to incorporate pre-Bz input from Pete Muir,
Alan Santos, Prabhat Jha and others into this bug as needed. Not sure
how to best review the result, but we should do it earlier than 6.0.0.CR1
and should probably involve the field as well (SA's and such). Please ping
PM or PGM as needed for help on setting up field reviews. How are other 
products (eg. EAP) reviewing the topic navigation? Thanks.

Comment 1 Misha H. Ali 2012-04-04 19:53:11 UTC

Discussion and resulting plans have determined that the current topic based format will not be used for GA. Instead, the same (and additional) content is to be mapped into multiple narrative books, namely:

1. Getting Started Guide
2. Administration and Configuration Guide
3. Developers Guide

The topic based content will only be used for the JDG beta release.

Comment 2 Misha H. Ali 2012-04-04 21:52:14 UTC

Additional decision, a post beta documentation release will occur (timeline undetermined currently but safe to say 1-2 weeks after beta release) where all topics included in beta documentation will be factored into a narrative document. Said narrative document will be released as an addition to the beta documentation suite.

Comment 5 prabhat jha 2012-04-16 01:13:49 UTC

Misha, I definitely like this better. I did not go through contents in details since I am assuming these are same from topic based approached that we went through in details.

Comment 6 prabhat jha 2012-04-16 01:23:46 UTC

It's good for beta. For GA, we would need more contents.

Comment 7 Misha H. Ali 2012-04-19 02:14:15 UTC

Done: http://docs.redhat.com/docs/en-US/JBoss_Data_Grid/6/html/Beta_User_Guide/index.html