hive-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "kulkarni.swarnim@gmail.com" <kulkarni.swar...@gmail.com>
Subject Re: Documentation Policy
Date Tue, 10 Jun 2014 22:56:09 GMT
> Writing documentation sooner rather than later is likely to increases the
chances of things getting documented.

Big +1 on this. I think documentation contributes towards one of the major
technical debts(I personally have quite a bit for the patches I
contributed). IMHO committers may choose to reject patches that don't have
usage documentation if they include significant work which practically
cannot be consumed without proper documentation.

Slightly tangential but how we do choose on adding this to some of the
already resolved JIRAs that are missing documentation? I can volunteer to
dig through our JIRA queue and find some of these out but probably would
need some help from the contributors on these to be sure that they are
doc'ed properly. :)


On Tue, Jun 10, 2014 at 5:33 PM, Thejas Nair <thejas@hortonworks.com> wrote:

> > Also, I don't think we need to wait for end of the release cycle to start
> >> documenting features for the next release.
> >
> >
> > Agreed, but I think we should wait until the next release is less than
> two
> > months away.  What do other people think?
>
> We have been releasing almost every 3-4 months. So that is the longest
> un-released version documentation would be in the docs.
> Writing documentation sooner rather than later is likely to increases
> the chances of things getting documented. It is easier to get details
> from developers while the details are still fresh in their minds. It
> would also even the load on documentation volunteers over the time.
>
> --
> CONFIDENTIALITY NOTICE
> NOTICE: This message is intended for the use of the individual or entity to
> which it is addressed and may contain information that is confidential,
> privileged and exempt from disclosure under applicable law. If the reader
> of this message is not the intended recipient, you are hereby notified that
> any printing, copying, dissemination, distribution, disclosure or
> forwarding of this communication is strictly prohibited. If you have
> received this communication in error, please contact the sender immediately
> and delete it from your system. Thank You.
>



-- 
Swarnim

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message