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

Allen Wittenauer commented on HADOOP-12298:
-------------------------------------------

bq. do we actually need to support embeddeding HTML in release notes? 

The problem is with markdown, actually.  If we blankly convert all of the >/<, 
then issues like HADOOP-8545 fall apart since the xml section is already 
escaped.  It's (clearly) a big win to be able to do fancy things like that.  
This would be less of an issue if the maven site conversion from markdown to 
html was a bit more forgiving.

So I think to keep the capability for those that know about it and to keep 
letting the "unwashed masses" do their normal text editing, it's not too bad to 
put a special markdown header at the top of the release note in JIRA.  We can 
even cheat and use <!--- ---> notation so that it turns into a comment.  This 
would allow us to just search for it rather than remove it from the text when 
we build the release note md file.

> releasedocmaker isn't translating greater than/less than signs in releasenotes
> ------------------------------------------------------------------------------
>
>                 Key: HADOOP-12298
>                 URL: https://issues.apache.org/jira/browse/HADOOP-12298
>             Project: Hadoop Common
>          Issue Type: Sub-task
>          Components: yetus
>            Reporter: Allen Wittenauer
>            Priority: Blocker
>
> Somewhere along the way, releasedocmaker stopped translating greater than and 
> less than signs in release notes.  mvn site blows up when it comes across a 
> broken one.  github drops the word entirely when rendering.



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

Reply via email to