Skip to content

Commit 26e700e

Browse files
committed
update docs
1 parent ee6abe7 commit 26e700e

File tree

5 files changed

+21
-19
lines changed

5 files changed

+21
-19
lines changed

README-zh.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525

2626
## 核心特性
2727

28-
* **事件驱动的 WASM 运行时**:以接近原生的性能和沙箱隔离的方式执行多语言函数(Go、Python、Rust)。
29-
* **持久化状态管理**:内置支持基于 RocksDB 的状态存储,用于有状态流处理。
30-
* **SQL 驱动的 CLI**:使用类 SQL 命令进行作业管理和流检测的交互式 REPL。
28+
- **事件驱动的 WASM 运行时**:以接近原生的性能和沙箱隔离的方式执行多语言函数(Go、Python、Rust)。
29+
- **持久化状态管理**:内置支持基于 RocksDB 的状态存储,用于有状态流处理。
30+
- **SQL 驱动的 CLI**:使用类 SQL 命令进行作业管理和流检测的交互式 REPL。
3131

3232
## 仓库结构
3333

@@ -47,10 +47,10 @@ function-stream/
4747

4848
## 前置条件
4949

50-
* **Rust 工具链**:Stable >= 1.77 (通过 rustup 安装)。
51-
* **Python 3.9+**:构建 Python WASM 运行时所需。
52-
* **Protoc**:Protocol Buffers 编译器(用于生成 gRPC 绑定)。
53-
* **构建工具**:cmake, pkg-config, OpenSSL headers (用于 rdkafka)。
50+
- **Rust 工具链**:Stable >= 1.77 (通过 rustup 安装)。
51+
- **Python 3.9+**:构建 Python WASM 运行时所需。
52+
- **Protoc**:Protocol Buffers 编译器(用于生成 gRPC 绑定)。
53+
- **构建工具**:cmake, pkg-config, OpenSSL headers (用于 rdkafka)。
5454

5555
## 快速开始 (本地开发)
5656

@@ -99,8 +99,9 @@ make dist
9999
```
100100

101101
**输出:**
102-
* `dist/function-stream-<version>.tar.gz`
103-
* `dist/function-stream-<version>.zip`
102+
103+
- `dist/function-stream-<version>.tar.gz`
104+
- `dist/function-stream-<version>.zip`
104105

105106
对于不包含 Python WASM 运行时的轻量级分发:
106107

@@ -109,8 +110,9 @@ make dist-lite
109110
```
110111

111112
**输出:**
112-
* `dist/function-stream-<version>-lite.tar.gz`
113-
* `dist/function-stream-<version>-lite.zip`
113+
114+
- `dist/function-stream-<version>-lite.tar.gz`
115+
- `dist/function-stream-<version>-lite.zip`
114116

115117
### 运行分发包
116118

@@ -149,19 +151,19 @@ function-stream-<version>/
149151

150152
**示例:**
151153

152-
1. **前台模式 (Docker / 调试)** — 在当前 Shell 中运行服务器。适用于容器化环境 (Kubernetes/Docker) 或调试。
154+
1. **前台模式 (Docker / 调试)** — 在当前 Shell 中运行服务器。适用于容器化环境 (Kubernetes/Docker) 或调试。
153155

154156
```bash
155157
./bin/start-server.sh
156158
```
157159

158-
2. **守护进程模式 (生产)** — 在后台运行服务器,将 stdout/stderr 重定向到 `logs/`
160+
2. **守护进程模式 (生产)** — 在后台运行服务器,将 stdout/stderr 重定向到 `logs/`
159161

160162
```bash
161163
./bin/start-server.sh -d
162164
```
163165

164-
3. **自定义配置** — 使用特定配置文件启动。
166+
3. **自定义配置** — 使用特定配置文件启动。
165167

166168
```bash
167169
./bin/start-server.sh -d -c config/config.yml

docs/function-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ When output-type: kafka, the following parameters must be provided:
5656
|-------------------|----------|-----------------------------------------------------------------------------------------------------|
5757
| bootstrap_servers | Yes | Target cluster address. |
5858
| topic | Yes | Target Topic. |
59-
| partition | Yes | Explicitly specify the partition to write to (required by stream processing consistency semantics). |
59+
| partition | Yes | Explicitly specify the partition to write to (required by stream processing consistency semantics). |

docs/function-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,4 @@ The table below summarizes all standardized operations for daily maintenance of
107107
| List | SHOW FUNCTIONS | show_functions() | View all tasks and their running status. |
108108
| Start | START FUNCTION &lt;name&gt; | start_function(name) | Allocate executors and start consuming data. |
109109
| Stop | STOP FUNCTION &lt;name&gt; | stop_function(name) | Pause task execution. |
110-
| Drop | DROP FUNCTION &lt;name&gt; | drop_function(name) | Physically delete task metadata and code. |
110+
| Drop | DROP FUNCTION &lt;name&gt; | drop_function(name) | Physically delete task metadata and code. |

docs/python-sdk-guide-zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Function Stream 为 Python 开发者提供了一套完整的工具链,涵盖
66

77
## 一、SDK 核心组件定义
88

9-
zZZ| 包名 | 定位 | 核心功能 |
9+
| 包名 | 定位 | 核心功能 |
1010
|------|------|----------|
1111
| fs_api | 算子开发接口 | 定义 Processor 逻辑,提供 KV 状态存取及数据发射 (Emit) 能力。 |
1212
| fs_client | 集群控制客户端 | 基于 gRPC,实现函数的远程注册、状态控制及拓扑配置。 |
@@ -126,4 +126,4 @@ with FsClient(host="10.0.0.1", port=8080) as client:
126126
| ConflictError (409) | 尝试注册已存在的函数名 | 先调用 drop_function 或修改任务名称。 |
127127
| BadRequestError (400) | YAML 配置不满足规范或 Kafka 参数错误 | 检查 WasmTaskBuilder 中的配置项。 |
128128
| ServerError (500) | Server 侧运行时环境(如 RocksDB)异常 | 检查服务端 conf/config.yaml 存储路径权限。 |
129-
| NotFoundError (404) | 操作了不存在的函数或无效的 Checkpoint | 确认函数名是否输入正确。 |
129+
| NotFoundError (404) | 操作了不存在的函数或无效的 Checkpoint | 确认函数名是否输入正确。 |

docs/python-sdk-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,4 @@ with FsClient(host="10.0.0.1", port=8080) as client:
126126
| ConflictError (409) | Attempting to register an existing function name | Call drop_function first or modify the task name. |
127127
| BadRequestError (400) | YAML configuration does not meet specifications or Kafka parameters are incorrect | Check configuration items in WasmTaskBuilder. |
128128
| ServerError (500) | Server-side runtime environment (e.g., RocksDB) exception | Check permissions of storage path in server conf/config.yaml. |
129-
| NotFoundError (404) | Operating on a non-existent function or invalid Checkpoint | Confirm if the function name is correct. |
129+
| NotFoundError (404) | Operating on a non-existent function or invalid Checkpoint | Confirm if the function name is correct. |

0 commit comments

Comments
 (0)