You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@zookeeper.apache.org by Patrick Hunt <ph...@apache.org> on 2016/02/09 02:38:10 UTC
Reminder for committers making doc changes...
Hi folks, just a reminder for committers, if you're committing doc
changes to a branch you need to re-generate the toplevel docs for that
branch and commit them to svn along with the patch.
Patrick
Re: Reminder for committers making doc changes...
Posted by Chris Nauroth <cn...@hortonworks.com>.
Patrick, thank you for the cwiki karma. I have made the edits, now shown
in step 5 of the "Committing Changes" page. Please let me know if it
needs more work.
I also have attached updated patches to ZOOKEEPER-2364. I can't find a
simple way to tell Forrest that the release notes are managed externally.
It seems insistent that we have a proper working releasenotes.xml file.
My current proposal is to put a mostly empty placeholder file in source
control just to satisfy Forrest. I'm not a Forrest expert, so if someone
else has a more graceful solution in mind, please join the conversation on
ZOOKEEPER-2364.
--Chris Nauroth
On 2/9/16, 11:02 AM, "Patrick Hunt" <ph...@apache.org> wrote:
>At some point we dropped generating the release notes, mainly because
>it was very difficult to take the generated HTML from jira and convert
>it into docbook, just so that we could generate the html. As a result
>we just dropped the generation of release notes via docbook and pull
>the html directly into the generated docs, see
>
>Updating the release branch - item 4 here:
>https://cwiki.apache.org/confluence/display/ZOOKEEPER/HowToRelease
>
>Chris I added you to cwiki permissions, have at it. Good catch on
>"committing changes", I looked around but missed that. Thanks.
>
>Patrick
>
>On Tue, Feb 9, 2016 at 10:49 AM, Chris Nauroth <cn...@hortonworks.com>
>wrote:
>> Patrick, thank you for this clarification.
>>
>> Specifically related to the ZOOKEEPER-2364 bug that I filed, is there
>> something unique going on with the release notes? I found that
>> src/docs/src/documentation/content/xdocs/releasenotes.xml was deleted
>>from
>> branch-3.5 in preparation for the 3.5.0 release, and modifications for
>> subsequent releases appear to have been applied directly to
>> docs/releasenotes.html. Should we be trying to restore an accurate
>> releasenotes.xml file, or was abandoning it intentional and instead we
>> need to look at fixing "ant docs" so that it doesn't fail due to the
>>lack
>> of that file?
>>
>> Once all of this settles, I'd be happy to update the "Committing
>>Changes"
>> wiki page if someone wants to grant edit rights to my account.
>>
>> https://cwiki.apache.org/confluence/display/ZOOKEEPER/Committing+changes
>>
>>
>> https://cwiki.apache.org/confluence/display/~cnauroth
>>
>>
>> --Chris Nauroth
>>
>>
>>
>>
>> On 2/8/16, 5:38 PM, "Patrick Hunt" <ph...@apache.org> wrote:
>>
>>>Hi folks, just a reminder for committers, if you're committing doc
>>>changes to a branch you need to re-generate the toplevel docs for that
>>>branch and commit them to svn along with the patch.
>>>
>>>Patrick
>>>
>>
>
Re: Reminder for committers making doc changes...
Posted by Patrick Hunt <ph...@apache.org>.
At some point we dropped generating the release notes, mainly because
it was very difficult to take the generated HTML from jira and convert
it into docbook, just so that we could generate the html. As a result
we just dropped the generation of release notes via docbook and pull
the html directly into the generated docs, see
Updating the release branch - item 4 here:
https://cwiki.apache.org/confluence/display/ZOOKEEPER/HowToRelease
Chris I added you to cwiki permissions, have at it. Good catch on
"committing changes", I looked around but missed that. Thanks.
Patrick
On Tue, Feb 9, 2016 at 10:49 AM, Chris Nauroth <cn...@hortonworks.com> wrote:
> Patrick, thank you for this clarification.
>
> Specifically related to the ZOOKEEPER-2364 bug that I filed, is there
> something unique going on with the release notes? I found that
> src/docs/src/documentation/content/xdocs/releasenotes.xml was deleted from
> branch-3.5 in preparation for the 3.5.0 release, and modifications for
> subsequent releases appear to have been applied directly to
> docs/releasenotes.html. Should we be trying to restore an accurate
> releasenotes.xml file, or was abandoning it intentional and instead we
> need to look at fixing "ant docs" so that it doesn't fail due to the lack
> of that file?
>
> Once all of this settles, I'd be happy to update the "Committing Changes"
> wiki page if someone wants to grant edit rights to my account.
>
> https://cwiki.apache.org/confluence/display/ZOOKEEPER/Committing+changes
>
>
> https://cwiki.apache.org/confluence/display/~cnauroth
>
>
> --Chris Nauroth
>
>
>
>
> On 2/8/16, 5:38 PM, "Patrick Hunt" <ph...@apache.org> wrote:
>
>>Hi folks, just a reminder for committers, if you're committing doc
>>changes to a branch you need to re-generate the toplevel docs for that
>>branch and commit them to svn along with the patch.
>>
>>Patrick
>>
>
Re: Reminder for committers making doc changes...
Posted by Chris Nauroth <cn...@hortonworks.com>.
Patrick, thank you for this clarification.
Specifically related to the ZOOKEEPER-2364 bug that I filed, is there
something unique going on with the release notes? I found that
src/docs/src/documentation/content/xdocs/releasenotes.xml was deleted from
branch-3.5 in preparation for the 3.5.0 release, and modifications for
subsequent releases appear to have been applied directly to
docs/releasenotes.html. Should we be trying to restore an accurate
releasenotes.xml file, or was abandoning it intentional and instead we
need to look at fixing "ant docs" so that it doesn't fail due to the lack
of that file?
Once all of this settles, I'd be happy to update the "Committing Changes"
wiki page if someone wants to grant edit rights to my account.
https://cwiki.apache.org/confluence/display/ZOOKEEPER/Committing+changes
https://cwiki.apache.org/confluence/display/~cnauroth
--Chris Nauroth
On 2/8/16, 5:38 PM, "Patrick Hunt" <ph...@apache.org> wrote:
>Hi folks, just a reminder for committers, if you're committing doc
>changes to a branch you need to re-generate the toplevel docs for that
>branch and commit them to svn along with the patch.
>
>Patrick
>