[ 
https://issues.apache.org/jira/browse/ZOOKEEPER-2364?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15139972#comment-15139972
 ] 

Chris Nauroth commented on ZOOKEEPER-2364:
------------------------------------------

After further discussion on the dev list, I found out that the removal of 
src/docs/src/documentation/content/xdocs/releasenotes.xml is an intentional 
choice to eliminate a dual-maintenace problem in managing the release notes.  
Unfortunately, Forrest/Cocoon seems quite insistent that there be a 
releasenotes.xml file to pass validation.  The only option I could find was a 
"disable all validation" property, which I don't think is what we want.

I'm proposing that we keep an empty placeholder releasenotes.xml file in place 
just to satisfy the build.  When committing rendered docs, committers will have 
to avoid committing changes in the generated releasenotes.html and 
releasenotes.pdf files.  I have attached v002 patches for both trunk and 
branch-3.5 to implement this approach.

Feedback welcome, especially from those of you who have more long-term history 
on how the docs build and release process is supposed to work.

> "ant docs" fails on branch-3.5 due to missing releasenotes.xml.
> ---------------------------------------------------------------
>
>                 Key: ZOOKEEPER-2364
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-2364
>             Project: ZooKeeper
>          Issue Type: Bug
>          Components: build, documentation
>            Reporter: Chris Nauroth
>            Assignee: Chris Nauroth
>            Priority: Blocker
>             Fix For: 3.5.2
>
>         Attachments: ZOOKEEPER-2364-branch-3.5.001.patch, 
> ZOOKEEPER-2364-branch-3.5.002.patch, ZOOKEEPER-2364.002.patch
>
>
> "ant docs" is failing on branch-3.5.  (Both trunk and branch-3.4 are fine.)  
> The root cause appears
> to be a missing file on branch-3.5: 
> src/docs/src/documentation/content/xdocs/releasenotes.xml.
>  This causes Forrest to report a failure due to broken hyperlinks targeting 
> releasenotes.html.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to