search

Tencent / TubeMQ

TubeMQ has been donated to the Apache Software Foundation and renamed to InLong, please visit the new Apache repository: https://github.com/apache/incubator-inlong
https://inlong.apache.org/
2.02k stars 391 forks source link

[PROPOSAL] TubeMQ Document Site #117

Closed tisonkun closed 3 years ago

tisonkun commented 4 years ago

Motivation

Currently TubeMQ project hosts its documentation under docs/ folder, which contains previously internal materials. This issue is towards adding a minimum viable prototype of the document site that hosts TubeMQ document and a formal structure to manipulate TubeMQ documents.

Design

Here is the design document.

Basically we propose using sphinx-doc as our document site build tool and sphinx-intl as our i18n tool. The process of translation, i.e., i18n support follows gettext working flow. Besides, we use GitHub Pages to server the site.

(optional) Example snippet

https://tencent.github.io/TubeMQ/en/html/user-guide.html

image

https://tencent.github.io/TubeMQ/zh/html/user-guide.html

image

ghost commented 4 years ago

Sphinx require python toolset, I suggest one more lightweight document tools:

https://docsify.js.org/#/

It only render markdown as document, No need npm, no need install tools. You can write a html page, then include a small javascript file, all things done. You can write markdown, the javascript will render it as document.