Thank you guys for the comments. I'll go ahead :) On Feb 26, 2014, at 5:06 PM, Jinho Kim <[email protected]> wrote:
> +1 for documentation tool > > -Jinho > > > 2014-02-26 15:45 GMT+09:00 JaeHwa Jung <[email protected]>: > >> Hi, Hyunsik. >> >> +1. >> >> We need to divide this work between us. >> Could you create an umbrella task for this issue? >> >> Cheers. >> Jaehwa. >> >> >> >> 2014-02-26 15:39 GMT+09:00 Jihoon Son <[email protected]>: >> >>> Sorry for late response. >>> >>> I just take a quick look at the quick start and the tutorial, >>> but this tool seems to address all the problems which Hyunsik pointed >> out. >>> >>> Thus, +1 and I agree with replacing our documentation tool with Sphinx. >>> >>> Thanks, >>> Jihoon >>> >>> >>> 2014-02-25 14:23 GMT+09:00 Hyunsik Choi <[email protected]>: >>> >>>> Hi folks, >>>> >>>> I would like to discuss the choice of documentation tool. Currently, we >>>> have used markdown and generated single page HTML document from the >>>> markdown via maven-site-plugin. >>>> >>>> I think that this approach has several problems as follows: >>>> * a single page is very inconvenience to edit documents. I should >> have >>>> frequently scrolled a long page. >>>> * The generated html from markdown page does not support table of >>>> contents. The table of contents in the current doc has been manually >>>> written by hand. >>>> * It is hard to output multiple doc formats from single source. >>>> >>>> According to the characteristics of our project, we should maintain >> lots >>> of >>>> documentations. I think that it is very important to choose the proper >>>> documentation tool before too late. >>>> >>>> I've found open source documentation tools for Tajo. I would like to >>>> propose using sphinx (http://sphinx-doc.org) for our documentation >> tool. >>>> It >>>> seems to meet our needs. >>>> >>>> If you know other nice doc tools, feel free to suggest. >>>> >>>> Best regards, >>>> Hyunsik Choi >>>> >>> >>> >>> >>> -- >>> Jihoon Son >>> >>> Database & Information Systems Group, >>> Prof. Yon Dohn Chung Lab. >>> Dept. of Computer Science & Engineering, >>> Korea University >>> 1, 5-ga, Anam-dong, Seongbuk-gu, >>> Seoul, 136-713, Republic of Korea >>> >>> Tel : +82-2-3290-3580 >>> E-mail : [email protected] >>> >> >> >> >> -- >> Thanks, >> Jaehwa Jung >> Bigdata Platform Team >> Gruter >>
signature.asc
Description: Message signed with OpenPGP using GPGMail
