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

[docs] Switch from TWiki to Markdown

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • trunk
    • 5.1.0
    • docs
    • 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

          blocks

          Bug - A problem which impairs or prevents the functions of the product. OOZIE-3308 Update oozie-setup.sh usage description in documentation

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. OOZIE-3339 Enhance proxy job submission documentation

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. OOZIE-3337 Improve the documentation of Web Services API / Standard Job Submission

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. OOZIE-3341 [docs] Fix difference between command line help and documentation

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. OOZIE-3338 [build] Remove SVN references

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed
          depends upon

          Task - A task that needs to be done. OOZIE-3164 upgrade maven-site-plugin to 3.x (2.x does not render reports with Maven 3)

          • Major - Major loss of function.
          • Closed
          duplicates

          Bug - A problem which impairs or prevents the functions of the product. OOZIE-1282 Typo in html Quick Start guide when creating Oozie DB

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          is related to

          Task - A task that needs to be done. OOZIE-3164 upgrade maven-site-plugin to 3.x (2.x does not render reports with Maven 3)

          • Major - Major loss of function.
          • Closed
          links to

          Web Link Review Board

          Activity

            People

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

              Dates

                Created:
                Updated:
                Resolved: