I just updated the HowToRelease wiki and added this as step 3 under “Updating 
the release branch”.

--Chris Nauroth

On 8/16/16, 11:11 AM, "Patrick Hunt" <[email protected]> wrote:

    I'm for it, couldn't hurt to have it as an explicit release mechanic.
    
    Patrick
    
    On Tue, Aug 16, 2016 at 10:58 AM, Chris Nauroth <[email protected]>
    wrote:
    
    > Arshad and Flavio, thank you for taking care of this.
    >
    > Currently, we have doc generation list in step 5 of the commit
    > instructions [1], but it’s not part of the release process [2].  Shall we
    > update the HowToRelease wiki to include a “final pass” doc re-generation,
    > so that we catch anything that might have been missed on an earlier 
commit?
    >
    > [1] https://cwiki.apache.org/confluence/display/ZOOKEEPER/Commit
    > ting+changes
    > [2] https://cwiki.apache.org/confluence/display/ZOOKEEPER/HowToRelease
    >
    > --Chris Nauroth
    >
    > On 8/12/16, 10:04 AM, "Arshad Mohammad" <[email protected]>
    > wrote:
    >
    >     Thanks Flavio. I visited the site http://zookeeper.apache.org/
    >     doc/r3.5.2-alpha/ just now. It is showing the latest document.
    >
    >     -Arshad
    >
    >     On Fri, Aug 12, 2016 at 10:21 PM, Flavio Junqueira <[email protected]>
    > wrote:
    >
    >     > I've fixed this. Let me know if there is anything else I missed,
    > please.
    >     >
    >     > -Flavio
    >     >
    >     > > On 10 Aug 2016, at 15:24, Flavio Junqueira <[email protected]> 
wrote:
    >     > >
    >     > > I thought we were generating the new documentation upon releasing.
    > I
    >     > just checked the how to release and we are just copying. I'll take
    > care of
    >     > it.
    >     > >
    >     > > -Flavio
    >     > >
    >     > >> On 10 Aug 2016, at 07:52, Mohammad arshad <
    > [email protected]>
    >     > wrote:
    >     > >>
    >     > >> 1. I think it is ok to update the document, in the release tar,
    > in the
    >     > next release
    >     > >> 2. Can we generate and update the documentation site
    >     > http://zookeeper.apache.org/doc/r3.5.2-alpha/, because mostly people
    >     > refer this website for document reference.
    >     > >>
    >     > >> -Arshad
    >     > >>
    >     > >> -----Original Message-----
    >     > >> From: Patrick Hunt [mailto:[email protected]]
    >     > >> Sent: 10 August 2016 00:06
    >     > >> To: DevZooKeeper; Flavio
    >     > >> Subject: Re: http://zookeeper.apache.org/doc/r3.5.2-alpha/
    > showing old
    >     > document
    >     > >>
    >     > >> Thanks for catching this Mohammad, it looks like this commit
    > changed
    >     > the source on 3.5 branch but the generated docs were not
    > re-generated:
    >     > >>
    >     > >> +  ZOOKEEPER-2402: Document client side properties (Arshad
    > Mohammad via
    >     > >> + fpj)
    >     > >>
    >     > >> svn commit: r1745280 - in /zookeeper/branches/branch-3.5:
    > CHANGES.txt
    >     > src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml
    >     > >> src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml
    >     > >>
    >     > >> As a result the published documentation is out of date with the
    > source.
    >     > >>
    >     > >> We have a few options, including but not limited to: 1) fix it
    > during
    >     > the next release (i.e. ignore it for now), 2) someone could
    > regenerate the
    >     > documentation for that release and update the published docs
    > manually.
    >     > >> others?
    >     > >>
    >     > >> Patrick
    >     > >>
    >     > >>
    >     > >> On Mon, Aug 8, 2016 at 8:24 AM, Mohammad arshad <
    >     > [email protected]>
    >     > >> wrote:
    >     > >>
    >     > >>> http://zookeeper.apache.org/doc/r3.5.2-alpha/ is not showing the
    >     > >>> documentation which is released with zookeeper-3.5.2-alpha
    > Released
    >     > >>> tar ball has up to date documentation source but the generated
    >     > >>> document is still old.
    >     > >>>
    >     > >>> For example:
    >     > >>> 
src\docs\src\documentation\content\xdocs\zookeeperProgrammers.xml
    > has
    >     > >>> bellow content <varlistentry>
    >     > >>>              <term>zookeeper.sasl.client</term>
    >     > >>>              <listitem>
    >     > >>>                             <para>Set the value to <emphasis
    >     > >>> role="bold">false</emphasis> to disable
    >     > >>>                             SASL authentication. Default is
    >     > >>> <emphasis role="bold">true</emphasis>.</para>
    >     > >>>              </listitem>
    >     > >>> </varlistentry>
    >     > >>> But  generated document file docs/zookeeperProgrammers.html does
    > not
    >     > >>> have above content.
    >     > >>>
    >     > >>> -Arshad
    >     > >>>
    >     > >>>
    >     > >
    >     >
    >     >
    >
    >
    >
    

Reply via email to