apache / docs Goto Github PK

Describe This Problem

Current documents of CeresDB [docs.ceresdb.io] are lacking of many details, this issue will track the supplement for the documents.

Proposal

Here is the current outline of the docs.

And some new sections should be provided:

• The deployment for dynamic routing, including the deployment of WAL based on Kafka;
• A new section about the observability about CeresDB cluster;
• The user guide about the usage of the sdk;
• Some new technical documents:
  • The architecture about the clustering; @ShiKaiWi
  • The document about the storage; @jiacai2050
  • The document about the query procedure;
  • The document about the write procedure;
  • The document about the WAL design; @Rachelint
  • The document about the partitioned table; @chunshao90
• Remove Troubleshooting section

Additional Context

No response

I have found a dead link, which is shown below:

Reference: https://learnmongodbthehardway.com/schema/sharding/

We should mention that time precision supported now is ms, not ns, which is different from influxdb.

Something like

• https://docs.influxdata.com/influxdb/v2.7/reference/config-options/
• https://docs.yugabyte.com/preview/reference/configuration/yb-tserver/

Describe This Problem

文档内容太简略，远远落后于功能，提高用户的使用门槛，使许多潜在的用户望而却步。

Proposal

完善文档内容，尤其配置信息和查询部分。良好的文档可以增加使用用户。
查询紧紧列出了一条基本的语法，对于时序数据查询一点没有说明。
比如是否支持降采样，窗口，插值等等及其使用方法。

Additional Context

No response

The documentation link in most places (e.g. the README) is eitehr https://ceresdb.github.io/docs or https://docs.ceresdb.io/, which are unavailable now, perhaps related to recent rename (e.g. #108).
It seems only https://apache.github.io/incubator-horaedb-docs works now. Not sure if you would want to setup a redirect or update existing links.

Currently, the doc content must be provided in English and Chinese both. Maybe some tools can be used to help generate Chinese text if English text is provided.