Skip to content

Commit c3aafce

Browse files
docs: change udf and faq level, add sql guide (#3534)
* docs: change udf and faq level, add sql guide * Update beginner_must_read.md --------- Co-authored-by: LU MIAN <[email protected]>
1 parent 23d7c50 commit c3aafce

File tree

28 files changed

+1162
-1061
lines changed

28 files changed

+1162
-1061
lines changed

.github/workflows/udf-doc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ jobs:
5454
if: github.event_name != 'pull_request'
5555
with:
5656
add-paths: |
57-
docs/en/reference/sql/functions_and_operators/Files/udfs_8h.md
58-
docs/zh/openmldb_sql/functions_and_operators/Files/udfs_8h.md
57+
docs/en/reference/sql/udfs_8h.md
58+
docs/zh/openmldb_sql/udfs_8h.md
5959
labels: |
6060
udf
6161
branch: docs-udf-patch

docs/en/developer/built_in_function_develop_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -792,7 +792,7 @@ select date(timestamp(1590115420000)) as dt;
792792

793793
## 5. Document Management
794794

795-
Documents for all built-in functions can be found in [Built-in Functions](http://4paradigm.github.io/OpenMLDB/zh/main/reference/sql/functions_and_operators/Files/udfs_8h.html). It is a markdown file automatically generated from source, so please do not edit it directly.
795+
Documents for all built-in functions can be found in [Built-in Functions](http://4paradigm.github.io/OpenMLDB/zh/main/reference/sql/udfs_8h.html). It is a markdown file automatically generated from source, so please do not edit it directly.
796796

797797
- If you are adding a document for a new function, please refer to [2.2.4 Documenting Function](#224-documenting-function).
798798
- If you are trying to revise a document of an existing function, you can find source code in the files of `hybridse/src/udf/default_udf_library.cc` or `hybridse/src/udf/default_defs/*_def.cc` .

docs/en/developer/udf_develop_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ SQL functions can be categorised into scalar functions and aggregate functions.
99
#### 2.1.1 Naming Specification of C++ Built-in Function
1010
- The naming of C++ built-in function should follow the [snake_case](https://en.wikipedia.org/wiki/Snake_case) style.
1111
- The name should clearly express the function's purpose.
12-
- The name of a function should not be the same as the name of a built-in function or other custom functions. The list of all built-in functions can be seen [here](../reference/sql/functions_and_operators/Files/udfs_8h.md).
12+
- The name of a function should not be the same as the name of a built-in function or other custom functions. The list of all built-in functions can be seen [here](../reference/sql/udfs_8h.md).
1313

1414
#### 2.1.2
1515
The types of the built-in C++ functions' parameters should be BOOL, NUMBER, TIMESTAMP, DATE, or STRING.

docs/en/reference/sql/dql/WINDOW_CLAUSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,5 +320,5 @@ WINDOW w1 AS (PARTITION BY col1 ORDER BY col5 ROWS_RANGE BETWEEN 10s PRECEDING A
320320
```
321321

322322
```{seealso}
323-
Please refer to [Built-in Functions](../functions_and_operators/Files/udfs_8h.md) for aggregate functions that can be used in window computation.
323+
Please refer to [Built-in Functions](../udfs_8h.md) for aggregate functions that can be used in window computation.
324324
````

docs/en/reference/sql/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ SQL
99
language_structure/index
1010
data_types/index
1111
functions_and_operators/index
12+
udfs_8h
1213
dql/index
1314
dml/index
1415
ddl/index
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
=============================
2-
Expressions, Functions, and Operations
2+
Expressions and Operations
33
=============================
44

55

66
.. toctree::
77
:maxdepth: 1
88

99
operators
10-
Files/udfs_8h
File renamed without changes.
Lines changed: 442 additions & 442 deletions
Large diffs are not rendered by default.

docs/zh/deploy/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,5 @@
88
install_deploy
99
conf
1010
compile
11-
integrate_hadoop
1211
offline_integrate_kubernetes
1312
[Alpha]在线引擎基于 Kubernetes 部署 <https://github.com/4paradigm/openmldb-k8s>

docs/zh/developer/built_in_function_develop_guide.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1034,10 +1034,9 @@ RegisterUdafTemplate<DistinctCountDef>("distinct_count")
10341034

10351035
## 6. 文档管理
10361036

1037-
内置函数文档可在 [Built-in Functions](https://openmldb.ai/docs/zh/main/openmldb_sql/functions_and_operators/Files/udfs_8h.html) 查看,它是一个代码生成的 markdown 文件,注意请不要进行直接编辑。
1037+
内置函数文档可在 [Built-in Functions](../openmldb_sql/udfs_8h.md) 查看,它是一个代码生成的 markdown 文件,注意请不要进行直接编辑。
10381038

1039-
- 如果需要对新增加的函数添加文档,请参照 2.2.4 配置函数文档 章节,说明了内置函数的文档是在 CPP 源代码中管理的。后续会通过一系列步骤生成如上网页中更加可读的文档, 即`docs/*/openmldb_sql/functions_and_operators/`目录下的内容。
1039+
- 如果需要对新增加的函数添加文档,请参照 2.2.4 配置函数文档 章节,说明了内置函数的文档是在 CPP 源代码中管理的。后续会通过一系列步骤生成如上网页中更加可读的文档, 即`docs/*/openmldb_sql/`目录下的内容。
10401040
- 如果需要修改一个已存在函数的文档,可以在文件 `hybridse/src/udf/default_udf_library.cc` 或者 `hybridse/src/udf/default_defs/*_def.cc` 下查找到对应函数的文档说明,进行修改。
10411041

10421042
OpenMLDB 项目中创建了一个定期天级别的 GitHub Workflow 任务来定期更新这里的相关文档。因此内置函数文档相关的改动只需按照上面的步骤修改对应源代码位置的内容即可,`docs` 目录和网站的内容会随之定期更新。具体的文档生成流程可以查看源代码路径下的 [udf_doxygen](https://github.com/4paradigm/OpenMLDB/tree/main/hybridse/tools/documentation/udf_doxygen)
1043-

0 commit comments

Comments
 (0)