hbase-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Andrew Purtell <apurt...@apache.org>
Subject Re: Incorrect docs in 0.98.3 and 0.98.4
Date Wed, 06 Aug 2014 18:27:53 GMT
For 0.98.5RC0 I updated docs in source prior to generating the source
tarball, so they will be consistent across source and binary artifacts. If
there is some other way you'd like to see this done, please suggest.


On Wed, Aug 6, 2014 at 11:14 AM, Stack <stack@duboce.net> wrote:

> On Wed, Aug 6, 2014 at 10:51 AM, Jonathan Hsieh <jon@cloudera.com> wrote:
>
> > Hm.. so previously we release the trunk docs with the 0.98 releases?
>  this
> > seems strange.  I would think 0.98 docs would be generated from the 0.98
> > release branch's branch.
> >
> >
> We have not done the work to keep up version-specific documentation.  The
> differences have been too minor to matter and if version specific doc at
> all, an effort has been made to call it out explicitly with 'since
> hbase-X.X.X'.
>
> 0.94 though has its own API and doc generated from a (old now) build off
> 0.94 branch.
>
>
>
> > It seems reasonable if in our post-git releases we have the source for
> the
> > docs in the source tarballs but not the build docs.  The built docs
> > however, are in the ready-to-use release tarballs and correspond to the
> > release.  Is this the case now?
> >
> > Doing this becomes more important because the docs will likely change due
> > to deployment changes with potentially different rules of thumb etc for
> > 0.98->1.0 vs what will be 2.0 releases.
> >
>
>
> Agree. When 2.0 doc starts to diverge from 1.0 doc in a significant way,
> lets move to keep up two different docs -- a branch-1 and a branch-2.
>
> I don't see a need for our doing that yet.
>
> St.Ack
>



-- 
Best regards,

   - Andy

Problems worthy of attack prove their worth by hitting back. - Piet Hein
(via Tom White)

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