morningman commented on a change in pull request #919: Add readme for new documentation framework URL: https://github.com/apache/incubator-doris/pull/919#discussion_r275194732
########## File path: docs/readme.md ########## @@ -0,0 +1,52 @@ +## Philosophy + +**write once, use everywhere** + +Documentations will be written once, and will be converted to other format according to different application scenarios. + +## Implementation + +``` + +---------------+ + | Documentation | + +-------+-------+ + | + +-------+-------+ + | Doc Builder | + +-------+-------+ + | + +--------------------------------+ + | | | ++---+---+ +---+----+ +-----+----+ +| PDF | | HTML | .... | Help Doc | ++-------+ +--------+ +----------+ + +``` + +> Documentation：Text contents which is written by human. And this is the only place for documentation. +> Doc Builder: Tools that convert documentations to other format, such as PDF, HTML. There could be many tools, and we can use different tools to convert documentation to different formats. + +## Organize Review comment: ```suggestion ## Organization ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
