Bug 764766 (GLUSTER-3034)

Summary:	Release notes is cryptic
Product:	[Community] Gluster-Documentation	Reporter:	Vikas Gorur <vikas>
Component:	Release Notes	Assignee:	Divya <divya>
Status:	CLOSED CURRENTRELEASE	QA Contact:
Severity:	medium	Docs Contact:
Priority:	medium
Version:	unspecified	CC:	fharshav, gluster-bugs, renee
Target Milestone:	---
Target Release:	---
Hardware:	x86_64
OS:	Linux
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:		Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description Vikas Gorur 2011-06-15 22:04:10 UTC

The following statements under the "Known Issues" section of the release notes are unintelligible even to an experienced user:

"With striped volumes, Quota feature has some issues with quota limit."

What are these "some issues"?

"RPC - Duplicate Reply Cache"

User has no clue what this is.

"Distributed Volumes - Directory spread (per directory layout control)"
"AFR - Fine grained locking in self-heal"
"IO-Cache - Write buffer cache"
"Stat-Prefetch - Directory caching"

Not enough detail. These statements will only confuse the users.

It may also be noted that the section could use some proofreading. There are multiple capitalization and grammatical errors.

Comment 1 Harshavardhana 2011-06-15 23:56:31 UTC

"glusterfs volume file is all automatically generated by the volume file" 

volume file generates a volume file?

"cd'd" is not a word, we should frame a much better sentence. 

"When cd'd in a directory, stat of deleted file recreates it (directory self-heal not triggered)" - this sounds like a haiku. 

"If the file is open and one of the replica copy goes down and comes back up before the 'fd' is closed, then it gets healed first before continuing with the operations. During this self-heal time, all the operations on the mount-point will be blocked. " on the whole mount-point? Please clarify. 

"The limitation is that the application depending on mandatory locking for their working will not work on GlusterFS." - This a mangled sentence and will not make a meaning for example "for their working will not work" 

Please consider these suggestions in good light and fix it before Support L1/L2 has to answer questions to customers regarding the releases.

Comment 2 Divya 2011-07-18 08:54:53 UTC

I have fixed the errors and uploaded the latest Release Notes at http://download.gluster.com/pub/gluster/glusterfs/3.2/3.2.0/.