You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@oozie.apache.org by "Andras Piros (JIRA)" <ji...@apache.org> on 2018/09/14 14:45:00 UTC

[jira] [Resolved] (OOZIE-2734) [docs] Switch from TWiki to Markdown

     [ https://issues.apache.org/jira/browse/OOZIE-2734?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Andras Piros resolved OOZIE-2734.
---------------------------------
    Resolution: Fixed

> [docs] Switch 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
>             Fix For: 5.1.0
>
>         Attachments: OOZIE-2734-1.patch, OOZIE-2734-10.patch, OOZIE-2734-2.patch, OOZIE-2734-3.patch, OOZIE-2734-4.patch, OOZIE-2734-5.patch, OOZIE-2734-6.patch, OOZIE-2734-7.patch, OOZIE-2734-8.patch, OOZIE-2734-9.patch, OOZIE-2734-amend-11.patch, oozie_generated_html_20180731.zip, oozie_generated_html_markdown_20180802.zip, oozie_generated_html_markdown_20180905.zip, oozie_generated_html_markdown_20180910.zip, oozie_generated_html_markdown_20180912.zip, oozie_generated_html_markdown_20180913.zip, twiki2md_20180730.zip
>
>
> 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)