Uploaded image for project: 'Oozie'
  1. Oozie
  2. OOZIE-2734

[docs] Switch from TWiki to Markdown

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: trunk
    • Fix Version/s: 5.1.0
    • Component/s: docs
    • Labels:
      None

      Description

      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:

      1. http://pandoc.org/
      2. https://github.com/jcodagnone/twiki2markdown

      The former supports a lot of different formats, and according to this blog post 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.

        Attachments

        1. twiki2md_20180730.zip
          3 kB
          Andras Salamon
        2. OOZIE-2734-amend-11.patch
          1.87 MB
          Andras Salamon
        3. OOZIE-2734-9.patch
          944 kB
          Andras Salamon
        4. OOZIE-2734-8.patch
          941 kB
          Andras Salamon
        5. OOZIE-2734-7.patch
          897 kB
          Andras Salamon
        6. OOZIE-2734-6.patch
          891 kB
          Andras Salamon
        7. OOZIE-2734-5.patch
          891 kB
          Andras Salamon
        8. OOZIE-2734-4.patch
          890 kB
          G├ęzapeti
        9. OOZIE-2734-3.patch
          890 kB
          Andras Salamon
        10. OOZIE-2734-2.patch
          891 kB
          Andras Salamon
        11. OOZIE-2734-10.patch
          943 kB
          Andras Salamon
        12. OOZIE-2734-1.patch
          890 kB
          Andras Salamon
        13. OOZIE-2734.amend.002.patch
          1 kB
          Andras Piros
        14. oozie_generated_html_markdown_20180913.zip
          622 kB
          Andras Salamon
        15. oozie_generated_html_markdown_20180912.zip
          622 kB
          Andras Salamon
        16. oozie_generated_html_markdown_20180910.zip
          622 kB
          Andras Salamon
        17. oozie_generated_html_markdown_20180905.zip
          622 kB
          Andras Salamon
        18. oozie_generated_html_markdown_20180802.zip
          621 kB
          Andras Salamon
        19. oozie_generated_html_20180731.zip
          1.22 MB
          Andras Salamon

          Issue Links

            Activity

              People

              • Assignee:
                andras.piros Andras Piros
                Reporter:
                rkanter Robert Kanter
              • Votes:
                0 Vote for this issue
                Watchers:
                9 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: