Details

    • Type: Task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.8.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      Currently, the documentation is based on Wiki. After releases, we need to keep some document snapshot available in online. The wiki page is not good for this purpose.

      So, I would like to suggest that user documentation moves to static htmls and keep developer document in the current wiki. In addition, we should keep static htmls for each version in Tajo site.

      This patch contains a markdown document used to generate static user document html for 0.2 and 0.8, and update the site for this change.

      You can see the draft at http://people.apache.org/~hyunsik/tajo/tajo-0.2.0-doc.html.

      1. TAJO-322.patch
        68 kB
        Hyunsik Choi

        Activity

        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Tajo-trunk-postcommit #562 (See https://builds.apache.org/job/Tajo-trunk-postcommit/562/)
        TAJO-322: Documentation by version. (fixed missing licenses) (hyunsik: https://git-wip-us.apache.org/repos/asf?p=incubator-tajo.git&a=commit&h=0c1262aed97bd1d3644a695da71ab18c13ebcff0)

        • tajo-project/src/site/markdown/tajo-0.2.0-doc.md
        • tajo-project/src/site/markdown/tajo-0.8.0-doc.md
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Tajo-trunk-postcommit #562 (See https://builds.apache.org/job/Tajo-trunk-postcommit/562/ ) TAJO-322 : Documentation by version. (fixed missing licenses) (hyunsik: https://git-wip-us.apache.org/repos/asf?p=incubator-tajo.git&a=commit&h=0c1262aed97bd1d3644a695da71ab18c13ebcff0 ) tajo-project/src/site/markdown/tajo-0.2.0-doc.md tajo-project/src/site/markdown/tajo-0.8.0-doc.md
        Hide
        hyunsik Hyunsik Choi added a comment -

        I fixed the problem. Thank you for your comment!

        Show
        hyunsik Hyunsik Choi added a comment - I fixed the problem. Thank you for your comment!
        Hide
        jihoonson Jihoon Son added a comment -

        This patch incurs an unapproved license error.
        It seems that the license is added to tajo-0.2.0-doc.md and tajo-0.8.0-doc.md files or these files are excluded from the license checking.

        Show
        jihoonson Jihoon Son added a comment - This patch incurs an unapproved license error. It seems that the license is added to tajo-0.2.0-doc.md and tajo-0.8.0-doc.md files or these files are excluded from the license checking.
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Tajo-trunk-postcommit #561 (See https://builds.apache.org/job/Tajo-trunk-postcommit/561/)
        TAJO-322: Documentation by version. (hyunsik) (hyunsik: https://git-wip-us.apache.org/repos/asf?p=incubator-tajo.git&a=commit&h=74a786480b0783939ff3453eb0d6a446a93dbc93)

        • tajo-project/src/site/site.xml
        • tajo-project/src/site/markdown/tajo-0.8.0-doc.md
        • tajo-project/pom.xml
        • tajo-project/src/site/markdown/tajo-0.2.0-doc.md
        • CHANGES.txt
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Tajo-trunk-postcommit #561 (See https://builds.apache.org/job/Tajo-trunk-postcommit/561/ ) TAJO-322 : Documentation by version. (hyunsik) (hyunsik: https://git-wip-us.apache.org/repos/asf?p=incubator-tajo.git&a=commit&h=74a786480b0783939ff3453eb0d6a446a93dbc93 ) tajo-project/src/site/site.xml tajo-project/src/site/markdown/tajo-0.8.0-doc.md tajo-project/pom.xml tajo-project/src/site/markdown/tajo-0.2.0-doc.md CHANGES.txt
        Hide
        hyunsik Hyunsik Choi added a comment -

        committed it to master. Thank you for the review.

        Show
        hyunsik Hyunsik Choi added a comment - committed it to master. Thank you for the review.
        Hide
        blrunner Jaehwa Jung added a comment -

        +1
        I also think that we need to manage documents by release version.

        Show
        blrunner Jaehwa Jung added a comment - +1 I also think that we need to manage documents by release version.

          People

          • Assignee:
            hyunsik Hyunsik Choi
            Reporter:
            hyunsik Hyunsik Choi
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development