[
https://issues.apache.org/jira/browse/OOZIE-2734?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16561715#comment-16561715
]
Andras Salamon commented on OOZIE-2734:
---------------------------------------
I've tried the listed tools without much success. It might be a limitation of
the tools, but the fact that the oozie twiki documentation contains errors is
also a problem for the tools.
Unfortunately sometimes it means that information is missing from the HTML
version of the documentation, so using the HTML files as a source of the
conversation is probably not the best idea.
I created my own tool to convert the twiki documentations to markdown and
handle the errors and special cases. The script uses sed (in retrospect it was
not the best idea). I upload the current version of the script, but check it
only at your own risk.
> Switch docs from twiki to markdown
> ----------------------------------
>
> Key: OOZIE-2734
> URL: https://issues.apache.org/jira/browse/OOZIE-2734
> Project: Oozie
> Issue Type: Improvement
> Components: docs
> Affects Versions: trunk
> Reporter: Robert Kanter
> Assignee: Andras Salamon
> Priority: Major
>
> This won't be a fun JIRA, but it would be great if we could switch to
> something easier to work with and better supported like markdown, and get rid
> of the super old twiki we're using for docs.
> I found two tools that I haven't tried out that claim to be able to convert
> this for us:
> # http://pandoc.org/
> # https://github.com/jcodagnone/twiki2markdown
> The former supports a lot of different formats, and according to [this blog
> post|http://goer.org/Journal/2013/02/converting_twiki_foswiki_to_markdown_restructuredtext.html]
> it's better to convert from the rendered html instead of the twiki. But who
> knows which is better, or if the second tool is better than either.
> I think once we switch to a better format, it will be easier to keep the docs
> in better shape, as they could really use some reorganizing. Though we can
> keep that for a separate task.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
