Uploaded image for project: 'Tajo'
  1. Tajo
  2. TAJO-642

Change tajo documentation tool to sphinx

    Details

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

      Description

      As we discussed at http://markmail.org/message/h6a3kdiyaitc5h5w, we decided to change tajo documentation tool from markdown to Sphinx.

      This patch adds tajo-docs module to the source tree, and it also includes the translated documentation.

      You can see the candidate page at below link.
      http://people.apache.org/~hyunsik/new_docs/

      The build way is as follows:

      cd tajo-docs
      mvn clean package
      ls -l target/html
      
      1. TAJO-642_140228_143005.patch
        77 kB
        Hyunsik Choi
      2. TAJO-642_140305_141943.patch
        82 kB
        Hyunsik Choi
      3. TAJO-642_140305_150448.patch
        86 kB
        Hyunsik Choi
      4. TAJO-642_140305_153407.patch
        84 kB
        Hyunsik Choi
      5. TAJO-642.patch
        98 kB
        Hyunsik Choi

        Activity

        Hide
        hyunsik Hyunsik Choi added a comment -

        Created a review request against branch master in reviewboard
        https://reviews.apache.org/r/18609/

        Show
        hyunsik Hyunsik Choi added a comment - Created a review request against branch master in reviewboard https://reviews.apache.org/r/18609/
        Hide
        hyunsik Hyunsik Choi added a comment -

        resubmitted the latest patch

        Updated the review request against branch master in reviewboard
        https://reviews.apache.org/r/18609/

        Show
        hyunsik Hyunsik Choi added a comment - resubmitted the latest patch Updated the review request against branch master in reviewboard https://reviews.apache.org/r/18609/
        Hide
        hyunsik Hyunsik Choi added a comment -

        I've uploaded the another theme.
        http://people.apache.org/~hyunsik/rtd/

        Show
        hyunsik Hyunsik Choi added a comment - I've uploaded the another theme. http://people.apache.org/~hyunsik/rtd/
        Hide
        hyunsik Hyunsik Choi added a comment -

        updated the documentation.

        Updated the review request against branch master in reviewboard
        https://reviews.apache.org/r/18609/

        Show
        hyunsik Hyunsik Choi added a comment - updated the documentation. Updated the review request against branch master in reviewboard https://reviews.apache.org/r/18609/
        Hide
        hyunsik Hyunsik Choi added a comment -

        I've updated the documentation layout. It will be the final version in this issue. Actually, I added many todo lists on documentations. They need to be solved in other jira issues.

        I chose two look good themes for documentations as follows:

        1. http://people.apache.org/~hyunsik/new_docs/
        2. http://people.apache.org/~hyunsik/rtd/

        Which one is better? I would like to ask the review of this patch and call a vote for the theme.

        Show
        hyunsik Hyunsik Choi added a comment - I've updated the documentation layout. It will be the final version in this issue. Actually, I added many todo lists on documentations. They need to be solved in other jira issues. I chose two look good themes for documentations as follows: 1. http://people.apache.org/~hyunsik/new_docs/ 2. http://people.apache.org/~hyunsik/rtd/ Which one is better? I would like to ask the review of this patch and call a vote for the theme.
        Hide
        jhkim Jinho Kim added a comment -

        Great!!
        +1 for theme 2

        Show
        jhkim Jinho Kim added a comment - Great!! +1 for theme 2
        Hide
        blrunner Jaehwa Jung added a comment -

        Thanks Hyunsik Choi.

        +1 for number 2.

        Show
        blrunner Jaehwa Jung added a comment - Thanks Hyunsik Choi . +1 for number 2.
        Hide
        hjkim Hyoungjun Kim added a comment -

        +1 theme 2

        Show
        hjkim Hyoungjun Kim added a comment - +1 theme 2
        Hide
        hyunsik Hyunsik Choi added a comment -

        added jdbc driver and client section.

        Updated the review request against branch master in reviewboard
        https://reviews.apache.org/r/18609/

        Show
        hyunsik Hyunsik Choi added a comment - added jdbc driver and client section. Updated the review request against branch master in reviewboard https://reviews.apache.org/r/18609/
        Hide
        hyunsik Hyunsik Choi added a comment -

        changed trademark in site.

        Updated the review request against branch master in reviewboard
        https://reviews.apache.org/r/18609/

        Show
        hyunsik Hyunsik Choi added a comment - changed trademark in site. Updated the review request against branch master in reviewboard https://reviews.apache.org/r/18609/
        Hide
        hyunsik Hyunsik Choi added a comment -

        http://people.apache.org/~hyunsik/rtd/

        The latest patch may be the final update. If one committer gives +1, I'll commit it.

        Show
        hyunsik Hyunsik Choi added a comment - http://people.apache.org/~hyunsik/rtd/ The latest patch may be the final update. If one committer gives +1, I'll commit it.
        Hide
        hyunsik Hyunsik Choi added a comment -

        Thank you for expressing your preference. I'll commit the documentation with the second theme into branch-0.8.0 and master.

        Show
        hyunsik Hyunsik Choi added a comment - Thank you for expressing your preference. I'll commit the documentation with the second theme into branch-0.8.0 and master.
        Hide
        hyunsik Hyunsik Choi added a comment -

        This issue got +1 on RB. I've committed it to master and 0.8 branch. Thanks all.

        Show
        hyunsik Hyunsik Choi added a comment - This issue got +1 on RB. I've committed it to master and 0.8 branch. Thanks all.
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Tajo-master-build #102 (See https://builds.apache.org/job/Tajo-master-build/102/)
        TAJO-642: Change tajo documentation tool to sphinx. (hyunsik: https://git-wip-us.apache.org/repos/asf/?p=incubator-tajo.git&a=commit&h=c9fadb76b9b761dd6229ab513b9963b247c3be40)

        • tajo-docs/src/main/sphinx/configuration/configuration_defaults.rst
        • tajo-docs/src/main/sphinx/getting_started/downloading_source.rst
        • tajo-docs/src/main/sphinx/sql_language/predicates.rst
        • tajo-docs/src/main/sphinx/hcatalog_integration.rst
        • tajo-docs/src/main/sphinx/backup_and_restore/catalog.rst
        • tajo-docs/src/main/sphinx/getting_started/local_setup.rst
        • tajo-docs/Makefile
        • tajo-docs/src/main/sphinx/partitioning/column_partitioning.rst
        • pom.xml
        • tajo-docs/src/main/sphinx/tajo_client_api.rst
        • tajo-docs/src/main/sphinx/sql_language.rst
        • tajo-docs/src/main/sphinx/configuration/preliminary.rst
        • tajo-docs/src/main/sphinx/functions.rst
        • tajo-docs/src/main/sphinx/table_partitioning.rst
        • tajo-project/src/site/apt/index.apt
        • tajo-docs/src/main/sphinx/table_management.rst
        • tajo-docs/src/main/sphinx/getting_started.rst
        • tajo-docs/src/main/sphinx/partitioning/intro_to_partitioning.rst
        • tajo-docs/BUILDING.txt
        • tajo-docs/src/main/sphinx/getting_started/building.rst
        • tajo-docs/src/main/sphinx/getting_started/first_query.rst
        • tajo-docs/src/main/sphinx/cli.rst
        • tajo-docs/src/main/sphinx/partitioning/range_partitioning.rst
        • tajo-docs/src/main/sphinx/jdbc_driver.rst
        • tajo-docs/src/main/sphinx/functions/datetime_func_and_operators.rst
        • tajo-project/src/site/site.xml
        • tajo-docs/src/main/sphinx/configuration.rst
        • tajo-docs/src/main/sphinx/functions/string_func_and_operators.rst
        • tajo-docs/src/main/sphinx/sql_language/insert.rst
        • tajo-docs/src/main/sphinx/conf.py
        • tajo-docs/src/main/sphinx/functions/math_func_and_operators.rst
        • tajo-docs/src/main/sphinx/table_management/file_formats.rst
        • CHANGES.txt
        • tajo-docs/src/main/sphinx/faq.rst
        • tajo-docs/src/main/sphinx/getting_started/prerequisites.rst
        • tajo-docs/src/main/sphinx/configuration/tajo_master_configuration.rst
        • tajo-docs/src/main/sphinx/configuration/worker_configuration.rst
        • tajo-docs/src/main/sphinx/sql_language/data_model.rst
        • tajo-docs/src/main/sphinx/configuration/catalog_configuration.rst
        • tajo-docs/src/main/sphinx/configuration/cluster_setup.rst
        • tajo-docs/src/main/sphinx/partitioning/hash_partitioning.rst
        • tajo-docs/src/main/sphinx/table_management/compression.rst
        • tajo-docs/src/main/sphinx/backup_and_restore.rst
        • tajo-docs/src/main/sphinx/introduction.rst
        • tajo-docs/src/main/sphinx/index.rst
        • tajo-docs/src/main/sphinx/sql_language/queries.rst
        • tajo-docs/src/main/sphinx/sql_language/ddl.rst
        • tajo-docs/pom.xml
        • tajo-docs/src/main/sphinx/sql_language/sql_expression.rst
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Tajo-master-build #102 (See https://builds.apache.org/job/Tajo-master-build/102/ ) TAJO-642 : Change tajo documentation tool to sphinx. (hyunsik: https://git-wip-us.apache.org/repos/asf/?p=incubator-tajo.git&a=commit&h=c9fadb76b9b761dd6229ab513b9963b247c3be40 ) tajo-docs/src/main/sphinx/configuration/configuration_defaults.rst tajo-docs/src/main/sphinx/getting_started/downloading_source.rst tajo-docs/src/main/sphinx/sql_language/predicates.rst tajo-docs/src/main/sphinx/hcatalog_integration.rst tajo-docs/src/main/sphinx/backup_and_restore/catalog.rst tajo-docs/src/main/sphinx/getting_started/local_setup.rst tajo-docs/Makefile tajo-docs/src/main/sphinx/partitioning/column_partitioning.rst pom.xml tajo-docs/src/main/sphinx/tajo_client_api.rst tajo-docs/src/main/sphinx/sql_language.rst tajo-docs/src/main/sphinx/configuration/preliminary.rst tajo-docs/src/main/sphinx/functions.rst tajo-docs/src/main/sphinx/table_partitioning.rst tajo-project/src/site/apt/index.apt tajo-docs/src/main/sphinx/table_management.rst tajo-docs/src/main/sphinx/getting_started.rst tajo-docs/src/main/sphinx/partitioning/intro_to_partitioning.rst tajo-docs/BUILDING.txt tajo-docs/src/main/sphinx/getting_started/building.rst tajo-docs/src/main/sphinx/getting_started/first_query.rst tajo-docs/src/main/sphinx/cli.rst tajo-docs/src/main/sphinx/partitioning/range_partitioning.rst tajo-docs/src/main/sphinx/jdbc_driver.rst tajo-docs/src/main/sphinx/functions/datetime_func_and_operators.rst tajo-project/src/site/site.xml tajo-docs/src/main/sphinx/configuration.rst tajo-docs/src/main/sphinx/functions/string_func_and_operators.rst tajo-docs/src/main/sphinx/sql_language/insert.rst tajo-docs/src/main/sphinx/conf.py tajo-docs/src/main/sphinx/functions/math_func_and_operators.rst tajo-docs/src/main/sphinx/table_management/file_formats.rst CHANGES.txt tajo-docs/src/main/sphinx/faq.rst tajo-docs/src/main/sphinx/getting_started/prerequisites.rst tajo-docs/src/main/sphinx/configuration/tajo_master_configuration.rst tajo-docs/src/main/sphinx/configuration/worker_configuration.rst tajo-docs/src/main/sphinx/sql_language/data_model.rst tajo-docs/src/main/sphinx/configuration/catalog_configuration.rst tajo-docs/src/main/sphinx/configuration/cluster_setup.rst tajo-docs/src/main/sphinx/partitioning/hash_partitioning.rst tajo-docs/src/main/sphinx/table_management/compression.rst tajo-docs/src/main/sphinx/backup_and_restore.rst tajo-docs/src/main/sphinx/introduction.rst tajo-docs/src/main/sphinx/index.rst tajo-docs/src/main/sphinx/sql_language/queries.rst tajo-docs/src/main/sphinx/sql_language/ddl.rst tajo-docs/pom.xml tajo-docs/src/main/sphinx/sql_language/sql_expression.rst
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Tajo-0.8.0-build #10 (See https://builds.apache.org/job/Tajo-0.8.0-build/10/)
        TAJO-642: Change tajo documentation tool to sphinx. (hyunsik: https://git-wip-us.apache.org/repos/asf/?p=incubator-tajo.git&a=commit&h=0d3b39ca6c79d64ba26efb069389a6c3b0a37293)

        • tajo-docs/BUILDING.txt
        • tajo-docs/src/main/sphinx/configuration/preliminary.rst
        • tajo-project/src/site/apt/index.apt
        • pom.xml
        • tajo-project/src/site/site.xml
        • tajo-docs/src/main/sphinx/sql_language/insert.rst
        • tajo-docs/src/main/sphinx/functions/string_func_and_operators.rst
        • tajo-docs/src/main/sphinx/sql_language/sql_expression.rst
        • tajo-docs/pom.xml
        • tajo-docs/src/main/sphinx/getting_started/first_query.rst
        • tajo-docs/src/main/sphinx/getting_started/downloading_source.rst
        • tajo-docs/src/main/sphinx/configuration/catalog_configuration.rst
        • tajo-docs/src/main/sphinx/sql_language.rst
        • tajo-docs/src/main/sphinx/getting_started/local_setup.rst
        • tajo-docs/src/main/sphinx/partitioning/range_partitioning.rst
        • tajo-docs/src/main/sphinx/conf.py
        • tajo-docs/src/main/sphinx/configuration/tajo_master_configuration.rst
        • tajo-docs/src/main/sphinx/table_management/file_formats.rst
        • tajo-docs/src/main/sphinx/table_management.rst
        • tajo-docs/Makefile
        • tajo-docs/src/main/sphinx/getting_started.rst
        • tajo-docs/src/main/sphinx/partitioning/hash_partitioning.rst
        • tajo-docs/src/main/sphinx/functions/datetime_func_and_operators.rst
        • tajo-docs/src/main/sphinx/backup_and_restore.rst
        • tajo-docs/src/main/sphinx/sql_language/queries.rst
        • tajo-docs/src/main/sphinx/configuration.rst
        • tajo-docs/src/main/sphinx/partitioning/column_partitioning.rst
        • tajo-docs/src/main/sphinx/functions/math_func_and_operators.rst
        • tajo-docs/src/main/sphinx/index.rst
        • tajo-docs/src/main/sphinx/getting_started/building.rst
        • tajo-docs/src/main/sphinx/configuration/configuration_defaults.rst
        • tajo-docs/src/main/sphinx/faq.rst
        • tajo-docs/src/main/sphinx/cli.rst
        • tajo-docs/src/main/sphinx/getting_started/prerequisites.rst
        • tajo-docs/src/main/sphinx/jdbc_driver.rst
        • tajo-docs/src/main/sphinx/introduction.rst
        • tajo-docs/src/main/sphinx/sql_language/ddl.rst
        • tajo-docs/src/main/sphinx/table_partitioning.rst
        • tajo-docs/src/main/sphinx/tajo_client_api.rst
        • CHANGES.txt
        • tajo-docs/src/main/sphinx/hcatalog_integration.rst
        • tajo-docs/src/main/sphinx/configuration/cluster_setup.rst
        • tajo-docs/src/main/sphinx/table_management/compression.rst
        • tajo-docs/src/main/sphinx/backup_and_restore/catalog.rst
        • tajo-docs/src/main/sphinx/sql_language/data_model.rst
        • tajo-docs/src/main/sphinx/sql_language/predicates.rst
        • tajo-docs/src/main/sphinx/partitioning/intro_to_partitioning.rst
        • tajo-docs/src/main/sphinx/functions.rst
        • tajo-docs/src/main/sphinx/configuration/worker_configuration.rst
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Tajo-0.8.0-build #10 (See https://builds.apache.org/job/Tajo-0.8.0-build/10/ ) TAJO-642 : Change tajo documentation tool to sphinx. (hyunsik: https://git-wip-us.apache.org/repos/asf/?p=incubator-tajo.git&a=commit&h=0d3b39ca6c79d64ba26efb069389a6c3b0a37293 ) tajo-docs/BUILDING.txt tajo-docs/src/main/sphinx/configuration/preliminary.rst tajo-project/src/site/apt/index.apt pom.xml tajo-project/src/site/site.xml tajo-docs/src/main/sphinx/sql_language/insert.rst tajo-docs/src/main/sphinx/functions/string_func_and_operators.rst tajo-docs/src/main/sphinx/sql_language/sql_expression.rst tajo-docs/pom.xml tajo-docs/src/main/sphinx/getting_started/first_query.rst tajo-docs/src/main/sphinx/getting_started/downloading_source.rst tajo-docs/src/main/sphinx/configuration/catalog_configuration.rst tajo-docs/src/main/sphinx/sql_language.rst tajo-docs/src/main/sphinx/getting_started/local_setup.rst tajo-docs/src/main/sphinx/partitioning/range_partitioning.rst tajo-docs/src/main/sphinx/conf.py tajo-docs/src/main/sphinx/configuration/tajo_master_configuration.rst tajo-docs/src/main/sphinx/table_management/file_formats.rst tajo-docs/src/main/sphinx/table_management.rst tajo-docs/Makefile tajo-docs/src/main/sphinx/getting_started.rst tajo-docs/src/main/sphinx/partitioning/hash_partitioning.rst tajo-docs/src/main/sphinx/functions/datetime_func_and_operators.rst tajo-docs/src/main/sphinx/backup_and_restore.rst tajo-docs/src/main/sphinx/sql_language/queries.rst tajo-docs/src/main/sphinx/configuration.rst tajo-docs/src/main/sphinx/partitioning/column_partitioning.rst tajo-docs/src/main/sphinx/functions/math_func_and_operators.rst tajo-docs/src/main/sphinx/index.rst tajo-docs/src/main/sphinx/getting_started/building.rst tajo-docs/src/main/sphinx/configuration/configuration_defaults.rst tajo-docs/src/main/sphinx/faq.rst tajo-docs/src/main/sphinx/cli.rst tajo-docs/src/main/sphinx/getting_started/prerequisites.rst tajo-docs/src/main/sphinx/jdbc_driver.rst tajo-docs/src/main/sphinx/introduction.rst tajo-docs/src/main/sphinx/sql_language/ddl.rst tajo-docs/src/main/sphinx/table_partitioning.rst tajo-docs/src/main/sphinx/tajo_client_api.rst CHANGES.txt tajo-docs/src/main/sphinx/hcatalog_integration.rst tajo-docs/src/main/sphinx/configuration/cluster_setup.rst tajo-docs/src/main/sphinx/table_management/compression.rst tajo-docs/src/main/sphinx/backup_and_restore/catalog.rst tajo-docs/src/main/sphinx/sql_language/data_model.rst tajo-docs/src/main/sphinx/sql_language/predicates.rst tajo-docs/src/main/sphinx/partitioning/intro_to_partitioning.rst tajo-docs/src/main/sphinx/functions.rst tajo-docs/src/main/sphinx/configuration/worker_configuration.rst
        Hide
        jihoonson Jihoon Son added a comment -

        Sorry for late.
        I also +1 for rtd!

        Show
        jihoonson Jihoon Son added a comment - Sorry for late. I also +1 for rtd!
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Tajo-0.8.0-build #11 (See https://builds.apache.org/job/Tajo-0.8.0-build/11/)
        TAJO-642: Change tajo documentation tool to sphinx. (added userdocs profile) (hyunsik: https://git-wip-us.apache.org/repos/asf/?p=incubator-tajo.git&a=commit&h=6479cefb943ef510c8f7dff1073b241ca2da0364)

        • pom.xml
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Tajo-0.8.0-build #11 (See https://builds.apache.org/job/Tajo-0.8.0-build/11/ ) TAJO-642 : Change tajo documentation tool to sphinx. (added userdocs profile) (hyunsik: https://git-wip-us.apache.org/repos/asf/?p=incubator-tajo.git&a=commit&h=6479cefb943ef510c8f7dff1073b241ca2da0364 ) pom.xml
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Tajo-master-build #103 (See https://builds.apache.org/job/Tajo-master-build/103/)
        TAJO-642: Change tajo documentation tool to sphinx. (added userdocs profile) (hyunsik: https://git-wip-us.apache.org/repos/asf/?p=incubator-tajo.git&a=commit&h=39bd61aea150ebe92f56bfe334e53360890cd9a3)

        • pom.xml
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Tajo-master-build #103 (See https://builds.apache.org/job/Tajo-master-build/103/ ) TAJO-642 : Change tajo documentation tool to sphinx. (added userdocs profile) (hyunsik: https://git-wip-us.apache.org/repos/asf/?p=incubator-tajo.git&a=commit&h=39bd61aea150ebe92f56bfe334e53360890cd9a3 ) pom.xml

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development