[Gluster-devel] Documentation expectations for 3.5 release

[Justin Clift]

On 15/04/2014, at 11:28 AM, Lalatendu Mohanty wrote:
> On 04/15/2014 01:24 PM, Niels de Vos wrote:
>> On Tue, Apr 15, 2014 at 12:12:22AM -0700, Vijay Bellur wrote:
>>> Thank you all for your efforts in arriving at better user documentation.
>>> 
>>> Since we did not do a thorough job of blocking patches that did not
>>> have adequate updates to the admin guide in the run upto 3.5.0, it
>>> certainly seems difficult to get all admin-guide content ready in
>>> short
>>> order. Hence I think it might be prudent to treat the documentation
>>> bugs as blockers for 3.5.1. There is documentation for most features
>>> mentioned in the bugs in some form (git commit messages, feature
>>> pages, blog posts) etc.It might be a good idea to consolidate all
>>> such links in one place.
>>> 
>>> My preference would be to release 3.5.0 and ensure that our admin
>>> guide is ready in terms of content by 3.5.1.
>> From my understanding, the demand for documentation was that it gets
>> included in the sources, not necessarily in the Admin Guide. But anyway,
>> it seems that getting the documentation isn't that quick for all new
>> features.
>> 
>> The blocker for 3.5.1 already has some needed fixes listed:
>> - https://bugzilla.redhat.com/show_bug.cgi?id=glusterfs-3.5.1
>> - https://bugzilla.redhat.com/showdependencytree.cgi?hide_resolved=1&id=glusterfs-3.5.1
>> 
>> Getting a 3.5.0 out now and release a doc+bugfix update relatively
>> quickly (target in 2 months?) would have my preference.
>> 
>> Thanks,
>> Niels
> 
> We can release 3.5 and move the doc blockers to 3.5.1 as an exception for 3.5 as we had not decided about doc blockers in the beginning of the 3.5 planning.  IMO for future releases , docs should be treated as blockers with all seriousness.


I'm completely against releasing 3.5.0 until the documentation is in the
repo.

Punting it to 3.5.1 isn't going to help people.  We need to fix our
most immediate documentation problem right here, right now, before
moving forward.

+ Justin

--
Open Source and Standards @ Red Hat

twitter.com/realjustinclift