Skip to content

Commit f675333

Browse files
committed
update docs
1 parent 85249a2 commit f675333

11 files changed

+34
-10
lines changed

cli/cli/src/main.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,17 @@ use std::process;
1919
#[derive(Parser, Debug)]
2020
#[command(name = "function-stream-cli")]
2121
#[command(about = "Interactive SQL CLI for Function Stream", long_about = None)]
22+
#[command(disable_help_flag = true)]
2223
struct Args {
24+
2325
#[arg(short = 'h', long = "host", default_value = "127.0.0.1")]
2426
host: String,
2527

2628
#[arg(short = 'p', long = "port", default_value = "8080")]
2729
port: u16,
30+
31+
#[arg(long = "help", action = clap::ArgAction::Help)]
32+
help: Option<bool>,
2833
}
2934

3035
#[tokio::main]

docs/function-configuration-zh.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# 任务配置
2+
13
Function Stream 的任务定义采用插件化架构。虽然当前版本重点支持 Kafka 协议,但其配置模型在设计上支持通过 input-type 与 output-type 扩展至任意流媒体系统。
24

35
---
@@ -50,8 +52,8 @@ Function Stream 的任务定义采用插件化架构。虽然当前版本重点
5052

5153
当 output-type: kafka 时,需提供以下参数:
5254

53-
| 参数 | 必填 | 说明 |
54-
|-------------------|----|-------------------------|
55-
| bootstrap_servers || 目标集群地址。 |
56-
| topic || 目标 Topic。 |
57-
| partition || 显式指定写入的分区(由流处理一致性语义要求)|
55+
| 参数 | 必填 | 说明 |
56+
|-------------------|----|------------|
57+
| bootstrap_servers || 目标集群地址。 |
58+
| topic || 目标 Topic。 |
59+
| partition || 显式指定写入的分区。 |

docs/function-configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Function Configuration
2+
13
Function Stream's task definition adopts a plugin-based architecture. Although the current version focuses on supporting the Kafka protocol, its configuration model is designed to support extension to any streaming media system via input-type and output-type.
24

35
---

docs/function-development-zh.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Function 开发指南
2+
13
Function 是 Function Stream 的核心计算单元。本指南以 Go (WASM) 模式为例,详细说明 Function 的全生命周期管理,并对比 Python 模式的操作差异。
24

35
---

docs/function-development.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Function Development Guide
2+
13
Function is the core computational unit of Function Stream. This guide takes Go (WASM) mode as an example to detail the full lifecycle management of a Function and compares the operational differences with Python mode.
24

35
---

docs/python-sdk-guide-zh.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Function Stream 为 Python 开发者提供了一套完整的工具链,涵盖了从流算子开发 (fs_api) 到管理 (fs_client) 的全流程。
1+
# Python SDK 指南
2+
3+
Function Stream 为 Python 开发者提供了一套完整的工具链,涵盖了从 function 开发 (fs_api) 到管理 (fs_client) 的全流程。
24

35
---
46

docs/python-sdk-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Function Stream provides a complete toolchain for Python developers, covering the entire process from stream operator development (fs_api) to management (fs_client).
1+
# Python SDK Guide
2+
3+
Function Stream provides a complete toolchain for Python developers, covering the entire process from function development (fs_api) to management (fs_client).
24

35
---
46

docs/server-configuration-zh.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# 服务端配置
2+
13
Function Stream 是一个云原生流处理平台,支持 WASM (Go/Rust) 与 Python 编写的轻量级计算任务。
24

35
---

docs/server-configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Server Configuration
2+
13
Function Stream is a cloud-native stream processing platform that supports lightweight computational tasks written in WASM (Go/Rust) and Python.
24

35
---

docs/sql-cli-guide-zh.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Function Stream 提供了一套类 SQL 的声明式交互终端(REPL),旨在为运维人员提供低门槛、高效率的集群任务管控能力。
1+
# SQL CLI 使用指南
2+
3+
Function Stream 提供了一套类 SQL 的声明式交互终端(REPL),旨在为运维人员提供低门槛、高效率的任务管控能力。
24

35
---
46

@@ -16,7 +18,6 @@ SQL CLI 通过 gRPC 协议与远程 Server 通信。
1618

1719
**start-cli.sh 选项:**
1820

19-
2021
| 选项 | 说明 |
2122
|-----------------------|--------------------------------------------------------------------------|
2223
| -h, --host \<HOST\> | Server 地址,默认 127.0.0.1。可通过环境变量 FUNCTION_STREAM_HOST 覆盖。 |

0 commit comments

Comments
 (0)