Help document collation (integration of help and documentation documents)

docs/Makefile

@@ -20,17 +20,21 @@
 #
 
 BUILD_DIR = ${CURDIR}/build
+HELP_DIR = ${BUILD_DIR}/contents
 
 all: zip_help
 .PHONY: all
 
 ${BUILD_DIR}:
 	mkdir -p ${BUILD_DIR}
+${HELP_DIR}:
+	mkdir -p ${HELP_DIR}
 
 # build help zip
 HELP_OUTPUT = ${BUILD_DIR}/help-resource.zip
-${HELP_OUTPUT}: help | ${BUILD_DIR}
-	zip -r $@ $<
+${HELP_OUTPUT}: documentation/cn/sql-reference ${BUILD_DIR} ${HELP_DIR}
+	cp -r $</* ${HELP_DIR}
+	cd ${BUILD_DIR} && zip -r $@ contents && cd -
 .PHONY: zip_help
 zip_help: ${HELP_OUTPUT}
 

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/avg.md

@@ -1,16 +1,15 @@
 # AVG
-
-## Syntax
+## description
+### Syntax
 
 `AVG([DISTINCT] expr)`
 
-## Description
 
 用于返回选中字段的平均值
 
 可选字段DISTINCT参数可以用来返回去重平均值
 
-## Examples
+## example
 
 ```
 mysql> SELECT datetime, AVG(cost_time) FROM log_statis group by datetime;
@@ -28,3 +27,5 @@ mysql> SELECT datetime, AVG(distinct cost_time) FROM log_statis group by datetim
 +---------------------+---------------------------+
 
 ```
+##keyword
+AVG

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/count.md

@@ -1,14 +1,13 @@
 # COUNT
-
-## Syntax
+## description
+### Syntax
 
 `COUNT([DISTINCT] expr)`
 
-## Description
 
 用于返回满足要求的行的数目
 
-## Examples
+## example
 
 ```
 MySQL > select count(*) from log_statis group by datetime;
@@ -32,3 +31,5 @@ MySQL > select count(distinct datetime) from log_statis group by datetime;
 |                       71045   |
 +-------------------------------+
 ```
+##keyword
+COUNT

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/count_distinct.md

@@ -1,14 +1,13 @@
 # COUNT_DISTINCT
-
-## Syntax
+## description
+### Syntax
 
 `COUNT_DISTINCT(expr)`
 
-## Description
 
 用于返回满足要求的行的数目，或者非NULL行的数目
 
-## Examples
+## example
 
 ```
 MySQL > select count_distinct(query_id) from log_statis group by datetime;
@@ -18,3 +17,5 @@ MySQL > select count_distinct(query_id) from log_statis group by datetime;
 |                        577 |
 +----------------------------+
 ```
+##keyword
+COUNT_DISTINCT,COUNT,DISTINCT

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/hll_union_agg.md

@@ -1,10 +1,9 @@
 # HLL_UNION_AGG
-
-## Syntax
+## description
+### Syntax
 
 `HLL_UNION_AGG(hll)`
 
-## Description
 
 HLL是基于HyperLogLog算法的工程实现，用于保存HyperLogLog计算过程的中间结果
 
@@ -14,7 +13,7 @@ HLL是基于HyperLogLog算法的工程实现，用于保存HyperLogLog计算过
 
 导入的时候通过hll_hash函数来指定数据中哪一列用于生成hll列，它常用于替代count distinct，通过结合rollup在业务上用于快速计算uv等
 
-## Examples
+## example
 ```
 MySQL > select HLL_UNION_AGG(uv_set) from test_uv;;
 +-------------------------+
@@ -23,3 +22,5 @@ MySQL > select HLL_UNION_AGG(uv_set) from test_uv;;
 | 17721                   |
 +-------------------------+
 ```
+##keyword
+HLL_UNION_AGG,HLL,UNION,AGG

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/max.md

@@ -1,14 +1,13 @@
 # MAX
-
-## Syntax
+## description
+### Syntax
 
 `MAX(expr)`
 
-## Description
 
 返回expr表达式的最大值
 
-## Examples
+## example
 ```
 MySQL > select max(scan_rows) from log_statis group by datetime;
 +------------------+
@@ -17,3 +16,5 @@ MySQL > select max(scan_rows) from log_statis group by datetime;
 |          4671587 |
 +------------------+
 ```
+##keyword
+MAX

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/min.md

@@ -1,14 +1,13 @@
 # MIN
-
-## Syntax
+## description
+### Syntax
 
 `MIN(expr)`
 
-## Description
 
 返回expr表达式的最小值
 
-## Examples
+## example
 ```
 MySQL > select min(scan_rows) from log_statis group by datetime;
 +------------------+
@@ -17,3 +16,5 @@ MySQL > select min(scan_rows) from log_statis group by datetime;
 |                0 |
 +------------------+
 ```
+##keyword
+MIN

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/ndv.md

@@ -1,16 +1,15 @@
 # NDV
-
-## Syntax
+## description
+### Syntax
 
 `NDV(expr)`
 
-## Description
 
 返回类似于 COUNT(DISTINCT col) 结果的近似值聚合函数。
 
 它比 COUNT 和 DISTINCT 组合的速度更快，并使用固定大小的内存，因此对于高基数的列可以使用更少的内存。
 
-## Examples
+## example
 ```
 MySQL > select ndv(query_id) from log_statis group by datetime;
 +-----------------+
@@ -19,3 +18,5 @@ MySQL > select ndv(query_id) from log_statis group by datetime;
 | 17721           |
 +-----------------+
 ```
+##keyword
+NDV

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/percentile_approx.md

@@ -1,21 +1,21 @@
 # PERCENTILE_APPROX
-
-## Syntax
+## description
+### Syntax
 
 `PERCENTILE_APPROX(expr, DOUBLE p)`
 
-## Description
 
 返回第p个百分位点的近似值，p的值介于0到1之间
 
 该函数使用固定大小的内存，因此对于高基数的列可以使用更少的内存，可用于计算tp99等统计值
 
-## Examples
+## example
 ```
 MySQL > select `table`, percentile_approx(cost_time,0.99) from log_statis group by `table`;
 +---------------------+---------------------------+
 | table    | percentile_approx(`cost_time`, 0.99) |
 +----------+--------------------------------------+
 | test     |                                54.22 |
 +----------+--------------------------------------+
-```
+##keyword
+PERCENTILE_APPROX,PERCENTILE,APPROX

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/stddev.md

@@ -1,14 +1,13 @@
 # STDDEV,STDDEV_POP
-
-## Syntax
+## description
+### Syntax
 
 `STDDEV(expr)`
 
-## Description
 
 返回expr表达式的标准差
 
-## Examples
+## example
 ```
 MySQL > select stddev(scan_rows) from log_statis group by datetime;
 +---------------------+
@@ -24,3 +23,5 @@ MySQL > select stddev_pop(scan_rows) from log_statis group by datetime;
 |      2.3722760595994914 |
 +-------------------------+
 ```
+##keyword
+STDDEV,STDDEV_POP,POP

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/stddev_samp.md

@@ -1,14 +1,13 @@
 # STDDEV_SAMP
-
-## Syntax
+## description
+### Syntax
 
 `STDDEV_SAMP(expr)`
 
-## Description
 
 返回expr表达式的样本标准差
 
-## Examples
+## example
 ```
 MySQL > select stddev_samp(scan_rows) from log_statis group by datetime;
 +--------------------------+
@@ -17,3 +16,5 @@ MySQL > select stddev_samp(scan_rows) from log_statis group by datetime;
 |        2.372044195280762 |
 +--------------------------+
 ```
+##keyword
+STDDEV_SAMP,STDDEV,SAMP

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/sum.md

@@ -1,14 +1,13 @@
 # SUM
-
-## Syntax
+## description
+### Syntax
 
 `SUM(expr)`
 
-## Description
 
 用于返回选中字段所有值的和
 
-## Examples
+## example
 ```
 MySQL > select sum(scan_rows) from log_statis group by datetime;
 +------------------+
@@ -17,3 +16,5 @@ MySQL > select sum(scan_rows) from log_statis group by datetime;
 |       8217360135 |
 +------------------+
 ```
+##keyword
+SUM

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/var_samp.md

@@ -1,19 +1,19 @@
 # VAR_SAMP,VARIANCE_SAMP
-
-## Syntax
+## description
+### Syntax
 
 `VAR_SAMP(expr)`
 
-## Description
 
 返回expr表达式的样本方差
 
-## Examples
+## example
 ```
 MySQL > select var_samp(scan_rows) from log_statis group by datetime;
 +-----------------------+
 | var_samp(`scan_rows`) |
 +-----------------------+
 |    5.6227132145741789 |
 +-----------------------+
-```
+##keyword
+VAR_SAMP,VARIANCE_SAMP,VAR,SAMP,VARIANCE

docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/variance.md

@@ -1,14 +1,13 @@
 # VARIANCE,VAR_POP,VARIANCE_POP
-
-## Syntax
+## description
+### Syntax
 
 `VARIANCE(expr)`
 
-## Description
 
 返回expr表达式的方差
 
-## Examples
+## example
 ```
 MySQL > select variance(scan_rows) from log_statis group by datetime;
 +-----------------------+
@@ -23,4 +22,5 @@ MySQL > select var_pop(scan_rows) from log_statis group by datetime;
 +----------------------+
 |   5.6230744719006163 |
 +----------------------+
-```
+##keyword
+VARIANCE,VAR_POP,VARIANCE_POP,VAR,POP