Skip to content

Commit a4d95bb

Browse files
yinbo3xiaopeng8570Ke-Wng
authored
docs: optimize docs (#264)
* docs: optimize docs --------- Co-authored-by: xiaopeng <[email protected]> Co-authored-by: wangke <[email protected]>
1 parent d060aad commit a4d95bb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1126
-840
lines changed

CONTRIBUTING-CN.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
欢迎您的参与,以帮助改善 Datalayers 文档。当您反馈问题,编辑、新增、翻译文档内容时,可以为 Datalayers 开源社区提供非常有价值的帮助。
44

5-
65
## 目录
76

87
- [文档编写指南](#文档编写指南)
@@ -14,12 +13,10 @@
1413
- [PR 自动检查](#pr-自动检查)
1514
- [如何寻求帮助](#如何寻求帮助)
1615

17-
1816
## 文档编写指南
1917

2018
为了确保文档的一致性,我们要求所有贡献者参考我们的 [文档编写指南](./DOCS-WRITING-GUIDE-CN.md),该指南对文档**目录配置****Markdown 书写规范**进行了详细的说明。
2119

22-
2320
## 如何贡献文档
2421

2522
Datalayers 的文档发布在 [https://docs.datalayers.io/](https://docs.datalayers.io/),您可以通过以下几种方式贡献文档。
@@ -70,7 +67,7 @@ todo截图
7067

7168
2. 将 Fork 的仓库 Clone 到本地,然后进入本地目录,添加上游仓库。
7269

73-
```
70+
```shell
7471
git remote add upstream https://github.com/datalayers-io/docs-datalayers.git
7572
```
7673

@@ -102,12 +99,10 @@ Datalayers 中文文档一般会先于英文文档发布,所以文档翻译大
10299

103100
回到步骤 2 里认领的 PR 里,依次添加 2 条评论:`/unlabel translation/doing``/label translation/done`,表明翻译已完成。
104101

105-
106102
## PR 自动检查
107103

108104
文档项目将会根据 [文档编写指南](./DOCS-WRITING-GUIDE-CN.md) 里的规则进行自动检查,检查通过的 PR 才能被合并。假如你提 PR 时遇到了 markdownlint check 失败,报错信息里会明确提示哪一个文件的哪一行出了什么问题,请根据提示修改后再更新到 PR 里。
109105

110-
111106
## 如何寻求帮助
112107

113108
在进行文档贡献时遇到任何问题,都可以通过以下方式联系我们获取帮助。
@@ -117,4 +112,3 @@ Datalayers 中文文档一般会先于英文文档发布,所以文档翻译大
117112
todo截图
118113

119114
- 直接提交 GitHub Issue:[https://github.com/datalayers-io/docs-datalayers/issues/new](https://github.com/datalayers-io/docs-datalayers/issues/new)
120-

CONTRIBUTING-EN.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,12 @@ Thank you for your contributions to Datalayers open-source project.
1717
- [PR automatic check](#pr-automatic-check)
1818
- [How to get help](#how-to-get-help)
1919

20-
2120
## Documentation Writing Guide
2221

2322
To ensure consistency throughout all Datalayers documentation,
2423
we kindly request all contributors reference our [Documentation Writing Guide](./DOCS-WRITING-GUIDE-EN.md).
2524
This guideline provides detailed instructions on document **directory configuration** and **Markdown writing specifications**.
2625

27-
2826
## How to contribute
2927

3028
Datalayers's documentation is published at [https://docs.datalayers.io/](https://docs.datalayers.io/).
@@ -82,7 +80,8 @@ We recommend first-time contributors to directly use the [Online editing](#onlin
8280
1. Open the document repository [https://github.com/datalayers-io/docs-datalayers](https://github.com/datalayers-io/docs-datalayers) for Fork.
8381

8482
1. Clone the forked repository into your local workspace and then go to the local directory and add the upstream repository.
85-
```
83+
84+
```shell
8685
git remote add upstream https://github.com/datalayers-io/docs-datalayers.git
8786
```
8887

@@ -92,14 +91,14 @@ We recommend first-time contributors to directly use the [Online editing](#onlin
9291
1. Optional: Checkout a work-branch `git checkout -b my-first-pr-branch-for-datalayers-1.0`
9392

9493
1. Edit, commit, and push the branch to your fork
95-
```
94+
95+
```shell
9696
git commit -a -m 'docs(WHICH_DOC): fix xxxx in WHICH_DOC'
9797
git push origin my-first-pr-branch-for-datalayers-1.0
9898
```
9999

100100
1. Create a Pull request from your forked repository to the upstream repository.
101101

102-
103102
## PR automatic check
104103

105104
Document projects will be automatically checked according to the rules in the [Documentation Writing Guide](./DOCS-WRITING-GUIDE-EN.md).
@@ -111,5 +110,4 @@ so please follow the instructions to modify and update the PR.
111110

112111
If you encounter any problems when contributing to the documentation, you can contact us for getting help in the following methods.
113112

114-
115113
- Submit the GitHub Issue directly: [https://github.com/datalayers-io/docs-datalayers/issues/new](https://github.com/datalayers-io/docs-datalayers/issues/new).

dir.yaml

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -63,28 +63,21 @@
6363
- title_en: Arrow Flight SQL
6464
title_cn: Arrow Flight SQL
6565
path: development-guide/arrow-flight-sql
66+
- title_en: PostgreSQL Protocol
67+
title_cn: PostgreSQL 协议
68+
path: development-guide/postgresql/overview
69+
- title_en: Prometheus Protocol
70+
title_cn: Prometheus 协议
71+
path: development-guide/prometheus/overview
6672
- title_en: REST API
6773
title_cn: REST API
68-
collapsed: true
69-
children:
70-
- title_en: Authentication
71-
title_cn: 认证
72-
path: development-guide/auth-with-restapi
73-
- title_en: Insert
74-
title_cn: 数据写入
75-
path: development-guide/insert-with-restapi
76-
- title_en: Query
77-
title_cn: 数据查询
78-
path: development-guide/query-with-restapi
79-
- title_en: ERROR CODE
80-
title_cn: 错误码说明
81-
path: development-guide/errno-with-restapi
82-
- title_en: Multi-language Access Examples
83-
title_cn: 多语言接入示例
84-
path: development-guide/multi-language-examples
74+
path: development-guide/rest-api/overview
8575
- title_en: InfluxDB Line Protocol
8676
title_cn: InfluxDB Line Protocol
8777
path: development-guide/writing-with-influxdb-line-protocol
78+
- title_en: Redis Protocol
79+
title_cn: Redis 协议
80+
path: development-guide/redis
8881
- title_en: Table design best practices
8982
title_cn: 数据表设计
9083
path: development-guide/table-design/overview
@@ -98,7 +91,7 @@
9891
path: development-guide/table-design/timeseries-table-design
9992
- title_en: High-performance writing
10093
title_cn: 高性能写入
101-
path: development-guide/high-performance-writing
94+
path: development-guide/high-performance-ingestion
10295
- title_en: Query Performance Tuning
10396
title_cn: 查询加速
10497
path: development-guide/query-performance-tuning-overview
@@ -126,7 +119,7 @@
126119
path: development-guide/query-optimization/hints/index
127120
- title_en: Downsampling
128121
title_cn: 时间窗口查询
129-
path: development-guide/downsampling
122+
path: development-guide/time-window-aggregation-query
130123
- title_en: Object Storage
131124
title_cn: 对象存储
132125
path: development-guide/object-storage
@@ -352,6 +345,20 @@
352345
title_cn: Redis 兼容性
353346
path: key-value-data-model/redis-compatibility
354347

348+
- title_en: Prometheus
349+
title_cn: Prometheus
350+
collapsed: true
351+
children:
352+
- title_en: Overview
353+
title_cn: 概述
354+
path: prometheus/overview
355+
- title_en: Quick Start
356+
title_cn: 快速开始
357+
path: prometheus/quick-start
358+
- title_en: PromQL Compatibility
359+
title_cn: PromQL 兼容性
360+
path: prometheus/promql-compatibility
361+
355362
- title_en: Operation Guide
356363
title_cn: 运维指南
357364
collapsed: true
@@ -395,9 +402,15 @@
395402
- title_en: Log Configuration
396403
title_cn: 日志配置
397404
path: admin/configuration-fields/log
405+
- title_en: Audit logs
406+
title_cn: 审计日志
407+
path: admin/configuration-fields/audit-logs
398408
- title_en: License Configuration
399409
title_cn: License 配置
400410
path: admin/configuration-fields/license
411+
- title_en: MCP
412+
title_cn: MCP 配置
413+
path: admin/configuration-fields/mcp
401414
- title_en: Command Line Interface
402415
title_cn: 命令行接口
403416
path: admin/datalayers-cli
@@ -444,8 +457,8 @@
444457
title_cn: DBeaver
445458
path: integration/datalayers-with-dbeaver
446459
- title_en: User & Security
447-
title_cn: 用户与安全
448-
collapsed: false
460+
title_cn: 安全与合规
461+
collapsed: true
449462
children:
450463
- title_en: TLS
451464
title_cn: 连接加密(TLS)
@@ -481,6 +494,9 @@
481494
- title_en: Privileges
482495
title_cn: 权限管理
483496
path: user-security/rbac/privilege
497+
- title_en: Audit Logs
498+
title_cn: 审计日志
499+
path: user-security/audit-logs
484500
- title_en: Release Notes
485501
title_cn: 版本发布说明
486502
collapsed: true
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)