Skip to content

Commit 892ae8c

Browse files
authored
fix: fix docs (#4056)
1 parent 2ee066e commit 892ae8c

Some content is hidden

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

48 files changed

+109
-109
lines changed

docs/en/app_ecosystem/feat_insight/install/source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ Deploy OpenMLDB cluster and generate configuration file, start the service with
3535

3636
## IDE
3737

38-
If you are developing with IDE, you can modify `application.yml` configuration file, and directly start `HtttpServer.java`.
38+
If you are developing with IDE, you can modify `application.yml` configuration file, and directly start `HttpServer.java`.
3939

4040
![](../images/ide_develop_featuer_platform.png)

docs/en/deploy/offline_integrate_kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ You can specify Kubernetes configurations in the TaskManager configuration file.
3434

3535
| Config | Type | Note |
3636
| ------ | ---- | ---- |
37-
| spark.master | String | Supports "kuberenetes" or "k8s" |
37+
| spark.master | String | Supports "kubernetes" or "k8s" |
3838
| offline.data.prefix | String | Recommended to use HDFS path |
3939
| k8s.hadoop.configmap | String | Default setting as "hadoop-config" |
4040
| k8s.mount.local.path | String | Default setting as "/tmp" |

docs/en/developer/built_in_function_develop_guide.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ C++ built-in functions can use limited data types, including BOOL, Numeric, Stri
129129
- Operator `new` operator or method `malloc` are forbidden in C++ built-in function implementation.
130130
- In C++ built-in aggregate functions, it is permissible to use the `new` or `malloc` functions to allocate memory during initialization. However, it is crucial to ensure that the allocated space is released when the `output` generates the final result.
131131
- Developers must call provided memory management APIs in order to archive space allocation for UDF output parameters:
132-
- `hybridse::udf::v1::AllocManagedStringBuf(size)` to allocate space. OpenMLDB `ByteMemoryPool` will assign continous space to the function and will release it when safe.
132+
- `hybridse::udf::v1::AllocManagedStringBuf(size)` to allocate space. OpenMLDB `ByteMemoryPool` will assign continuous space to the function and will release it when safe.
133133
- If allocated size < 0, allocation will fail. `AllocManagedStringBuf` return null pointer.
134134
- If allocated size exceed the MAX_ALLOC_SIZE which is 2048, the allocation will fail. `AllocManagedStringBuf` return null pointer.
135135
- `hybridse::udf::v1::AllocManagedArray(ArrayRef<T>*, uint64_t)`: allocate space for array types
@@ -346,9 +346,9 @@ RegisterExternal("substring")
346346
@endcode
347347
348348
@param str
349-
@param pos: define the begining of the substring.
349+
@param pos: define the beginning of the substring.
350350
351-
- If `pos` is positive, the begining of the substring is `pos` charactors from the start of string.
351+
- If `pos` is positive, the beginning of the substring is `pos` characters from the start of string.
352352
- If `pos` is negative, the beginning of the substring is `pos` characters from the end of the string, rather than the beginning.
353353
354354
@param len length of substring. If len is less than 1, the result is the empty string.
@@ -440,7 +440,7 @@ namespace hybridse {
440440
}
441441
```
442442

443-
Configure and register function into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
443+
Configure and register function into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
444444

445445
```c++
446446
# hybridse/src/udf/default_udf_library.cc
@@ -483,7 +483,7 @@ namespace hybridse {
483483
}
484484
```
485485
486-
Configure and register the function into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc). Note that if the function needs to return through parameter, `return_by_arg(true)` needs to be configured.
486+
Configure and register the function into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc). Note that if the function needs to return through parameter, `return_by_arg(true)` needs to be configured.
487487
488488
```c++
489489
# hybridse/src/udf/default_udf_library.cc
@@ -531,7 +531,7 @@ namespace hybridse {
531531
}
532532
```
533533

534-
Configure and register the function into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
534+
Configure and register the function into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
535535

536536
```c++
537537
# hybridse/src/udf/default_udf_library.cc
@@ -584,12 +584,12 @@ namespace hybridse {
584584
}
585585
```
586586
587-
Configure and register the function into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
587+
Configure and register the function into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
588588
589589
```c++
590590
# hybridse/src/udf/default_udf_library.cc
591591
RegisterExternal("my_func")
592-
.args<Arg1, Nulable<Arg2>, ...>(static_cast<R (*)(Arg1, Arg2, bool, ...)>(v1::func))()
592+
.args<Arg1, Nullable<Arg2>, ...>(static_cast<R (*)(Arg1, Arg2, bool, ...)>(v1::func))()
593593
.doc(R"(
594594
documenting my_func
595595
)");
@@ -614,7 +614,7 @@ namespace hybridse {
614614
int32_t month(codec::Timestamp *ts);
615615
} // namespace v1
616616
} // namespace udf
617-
} // namepsace hybridse
617+
} // namespace hybridse
618618
```
619619
620620
Implement `month()` function in [hybridse/src/udf/udf.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/udf.cc):
@@ -633,12 +633,12 @@ namespace hybridse {
633633
int32_t month(codec::Timestamp *ts) { return month(ts->ts_); }
634634
} // namespace v1
635635
} // namespace udf
636-
} // namepsace hybridse
636+
} // namespace hybridse
637637
```
638638

639639
#### Step 2: Register C++ Function to Default Library
640640

641-
Configure and register `month()` into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
641+
Configure and register `month()` into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
642642

643643
```c++
644644
namespace hybridse {
@@ -659,7 +659,7 @@ namespace udf {
659659
)");
660660
}
661661
} // namespace udf
662-
} // namepsace hybridse
662+
} // namespace hybridse
663663
```
664664
665665
#### Step3: Function Unit Test
@@ -703,7 +703,7 @@ namespace hybridse {
703703
void bool_to_string(bool v, hybridse::codec::StringRef *output);
704704
} // namespace v1
705705
} // namespace udf
706-
} // namepsace hybridse
706+
} // namespace hybridse
707707
```
708708
709709
Implement the `bool_to_string()` function in [hybridse/src/udf/udf.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/udf.cc):
@@ -728,7 +728,7 @@ namespace hybridse {
728728
}
729729
} // namespace v1
730730
} // namespace udf
731-
} // namepsace hybridse
731+
} // namespace hybridse
732732
```
733733

734734
Notice that we used `AllocManagedStringBuf` to allocate memory from OpenMLDB Memory pool instead of using the `new` operator or the `malloc` api.
@@ -761,7 +761,7 @@ namespace hybridse {
761761
@since 0.1.0)");
762762
}
763763
} // namespace udf
764-
} // namepsace hybridse
764+
} // namespace hybridse
765765
```
766766
767767
#### Step3: Function Unit Test

docs/en/developer/code_structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ hybridse/
1818
│   ├── passes // sql optimizer
1919
│   ├── plan // logic execution plan generation
2020
│   ├── planv2 // the transformation from zetasql syntax tree to nodes
21-
│   ├── proto // the difinition of protobuf
21+
│   ├── proto // the definition of protobuf
2222
│   ├── sdk
2323
│   ├── testing
2424
│   ├── udf // the registration and generation of udf and udaf
@@ -32,7 +32,7 @@ src/
3232
├── apiserver
3333
├── base // basic libraries catalogue
3434
├── catalog
35-
├── client // the difinition and implementation of ns/tablet/taskmanager client interfaces
35+
├── client // the definition and implementation of ns/tablet/taskmanager client interfaces
3636
├── cmd // CLI and OpenMLDB binary generation
3737
├── codec // decode and encode
3838
├── datacollector // online -> offline sync tool

docs/en/integration/offline_data_sources/iceberg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ When you import data from Iceberg, you can check the task log to confirm whether
7373
24/01/30 09:01:06 INFO ObjectStore: ObjectStore, initialize called
7474
24/01/30 09:01:06 INFO Persistence: Property hive.metastore.integral.jdo.pushdown unknown - will be ignored
7575
24/01/30 09:01:06 INFO Persistence: Property datanucleus.cache.level2 unknown - will be ignored
76-
24/01/30 09:01:07 INFO ObjectStore: Setting MetaStore object pin classes with hive.metastore.cache.pinobjtypes="Table,StorageDescriptor,SerDeInfo,Partition,Database,Type,FieldSchema,Order"
76+
24/01/30 09:01:07 INFO ObjectStore: Setting MetaStore object pin classes with hive.metastore.cache.pinobjtypes="Table,StorageDescriptor,SetDeInfo,Partition,Database,Type,FieldSchema,Order"
7777
24/01/30 09:01:07 INFO MetaStoreDirectSql: Using direct SQL, underlying DB is POSTGRES
7878
24/01/30 09:01:07 INFO ObjectStore: Initialized ObjectStore
7979
24/01/30 09:01:08 INFO HiveMetaStore: Added admin role in metastore

docs/en/integration/online_datasources/pulsar_connector_demo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ We can check the sink status in Pulsar:
264264
```{note}
265265
"numReadFromPulsar": Pulsar sent 2 messages to the sink example.
266266
267-
"numWritenToSink": The sink example wrote 2 messages to OpenMLDB.
267+
"numWrittenToSink": The sink example wrote 2 messages to OpenMLDB.
268268
```
269269

270270
#### Check in OpenMLDB

docs/en/integration/online_datasources/rocketmq_connector.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ echo "create database rocketmq_test;" | /work/openmldb/bin/openmldb --zk_cluster
6666

6767
```bash
6868
Build RocketMQ and Start RocketMQ
69-
1. Downlaod RocketMQ
69+
1. Download RocketMQ
7070
$ wget https://dlcdn.apache.org/rocketmq/4.9.3/rocketmq-all-4.9.3-source-release.zip
7171

7272

@@ -75,7 +75,7 @@ If it has already been compiled, please directly execute Part 3 to start RocketM
7575

7676
$ unzip rocketmq-all-4.9.3-source-release.zip
7777
$ cd rocketmq-all-4.9.3/
78-
$ mvn -Prelease-all -DskipTests clean install -U
78+
$ mvn -Prerelease-all -DskipTests clean install -U
7979
$ cd distribution/target/rocketmq-4.9.3/rocketmq-4.9.3
8080

8181

@@ -108,7 +108,7 @@ Build the project
108108
109109
```bash
110110
$ cd rocketmq-connect
111-
$ mvn -Prelease-connect -DskipTests clean install -U
111+
$ mvn -Prerelease-connect -DskipTests clean install -U
112112
```
113113
114114
Edit the configuration `connect-standalone.conf` , and the key configurations are as follows:
@@ -203,7 +203,7 @@ COMMIT;
203203
SET FOREIGN_KEY_CHECKS = 1;
204204
```
205205
206-
Create and start RocketMQ conect mysql source connector, the examples is as follows:
206+
Create and start RocketMQ connect mysql source connector, the examples is as follows:
207207
208208
```bash
209209
curl -X POST -H "Content-Type: application/json" http://127.0.0.1:8082/connectors/jdbc-mysql-source-test

docs/en/maintain/diagnose.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ openmldb_tool # note the underscore
1313
```
1414
The following subcommands can be used:
1515
```bash
16-
usage: openmldb_tool [-h] [--helpfull] {status,inspect,rpc,test,static-check} ...
16+
usage: openmldb_tool [-h] [--helpful] {status,inspect,rpc,test,static-check} ...
1717
```
1818
Note, for `-c/--cluster`, the format is`<zk_cluster>/<zk_root_path>`, by default is `127.0.0.1:2181/openmldb`. If a different OpenMLDB cluster is used, please specify this parameter. Other settings are different as respect to each sub-command, you can use `-h` to check the detailed documentation.
1919

@@ -57,7 +57,7 @@ Server:
5757
5858
Table:
5959
{all healthy | unhealthy tables desc}
60-
[]Fatal/Warn table, {read/write may fail or still work}, {repair immediatly or not}
60+
[]Fatal/Warn table, {read/write may fail or still work}, {repair immediately or not}
6161
{partition detail: if leader healthy, if has unhealthy replicas, if offset too large, related ops}
6262
6363
Make sure all servers online, and no ops for the table is running.
@@ -84,11 +84,11 @@ The `status` command is used to view the status of the OpenMLDB cluster, includi
8484

8585
```
8686
openmldb_tool status -h
87-
usage: openmldb_tool status [-h] [--helpfull] [--diff]
87+
usage: openmldb_tool status [-h] [--helpful] [--diff]
8888
8989
optional arguments:
9090
-h, --help show this help message and exit
91-
--helpfull show full help message and exit
91+
--helpful show full help message and exit
9292
--diff check if all endpoints in conf are in cluster. If set, need to set `-f,--conf_file`
9393
--conn check network connection of all servers
9494
```
@@ -125,7 +125,7 @@ If you want to check the cluster status, it is recommended to use the one-click
125125

126126
```
127127
openmldb_tool inspect -h
128-
usage: openmldb_tool inspect [-h] [--helpfull] {online,offline,job} ...
128+
usage: openmldb_tool inspect [-h] [--helpful] {online,offline,job} ...
129129
130130
positional arguments:
131131
{online,offline,job}
@@ -185,11 +185,11 @@ The `static-check` command performs a static check based on the cluster deployme
185185

186186
```bash
187187
openmldb_tool static-check -h
188-
usage: openmldb_tool static-check [-h] [--helpfull] [--version] [--conf] [--log]
188+
usage: openmldb_tool static-check [-h] [--helpful] [--version] [--conf] [--log]
189189

190190
optional arguments:
191191
-h, --help show this help message and exit
192-
--helpfull show full help message and exit
192+
--helpful show full help message and exit
193193
--version, -V check version
194194
--conf, -C check conf
195195
--log, -L check log
@@ -291,4 +291,4 @@ You should input json like this, ignore round brackets in the key and double quo
291291

292292
## Additional Information
293293

294-
You can use `openmldb_tool --helpfull` to view all configuration options. For example, `--sdk_log` can print SDK logs (zk, glog) for debugging purposes.
294+
You can use `openmldb_tool --helpful` to view all configuration options. For example, `--sdk_log` can print SDK logs (zk, glog) for debugging purposes.

docs/en/maintain/monitoring.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ scrape_configs:
3333
```
3434
For complete configuration, refer to [openmldb_mixin/prometheus_example.yml](https://github.com/4paradigm/openmldb-exporter/blob/main/openmldb_mixin/prometheus_example.yml).
3535
36-
Command reference: `docker run -d -v <config_file>:/etc/prometheus/prometheus.yml -p 9090:9090 -name promethues prom/prometheus`
36+
Command reference: `docker run -d -v <config_file>:/etc/prometheus/prometheus.yml -p 9090:9090 -name prometheus prom/prometheus`
3737

3838
4. Start Grafana and use the OpenMLDB Dashboard template
3939

@@ -59,7 +59,7 @@ The OpenMLDB exporter is a Prometheus exporter implemented in Python. The core c
5959

6060
### Compatibility
6161

62-
| [OpenMLDB Exporter version](https://pypi.org/project/openmldb-exporter/) | [OpenMLDB supported version](https://github.com/4paradigm/OpenMLDB/releases) | [Grafana Dashboard revision](https://grafana.com/grafana/dashboards/17843-openmldb-dashboard/?tab=revisions) | Explaination |
62+
| [OpenMLDB Exporter version](https://pypi.org/project/openmldb-exporter/) | [OpenMLDB supported version](https://github.com/4paradigm/OpenMLDB/releases) | [Grafana Dashboard revision](https://grafana.com/grafana/dashboards/17843-openmldb-dashboard/?tab=revisions) | Explanation |
6363
| ---- | ---- | ---- | ------- |
6464
| >= 0.9.0 | >= 0.8.4 | >=4 | OpenMLDB removed deploy response time in database since 0.8.4 |
6565
| < 0.9.0 | >= 0.5.0, < 0.8.4 | 3 | |
@@ -116,15 +116,15 @@ curl http://<IP>:8000/metrics
116116
<details><summary>Example output</summary>
117117

118118
```sh
119-
# HELP openmldb_connected_seconds_total duration for a component conncted time in seconds
119+
# HELP openmldb_connected_seconds_total duration for a component connected time in seconds
120120
# TYPE openmldb_connected_seconds_total counter
121121
openmldb_connected_seconds_total{endpoint="172.17.0.15:9520",role="tablet"} 208834.70900011063
122122
openmldb_connected_seconds_total{endpoint="172.17.0.15:9521",role="tablet"} 208834.70700001717
123123
openmldb_connected_seconds_total{endpoint="172.17.0.15:9522",role="tablet"} 208834.71399998665
124124
openmldb_connected_seconds_total{endpoint="172.17.0.15:9622",role="nameserver"} 208833.70000004768
125125
openmldb_connected_seconds_total{endpoint="172.17.0.15:9623",role="nameserver"} 208831.70900011063
126126
openmldb_connected_seconds_total{endpoint="172.17.0.15:9624",role="nameserver"} 208829.7230000496
127-
# HELP openmldb_connected_seconds_created duration for a component conncted time in seconds
127+
# HELP openmldb_connected_seconds_created duration for a component connected time in seconds
128128
# TYPE openmldb_connected_seconds_created gauge
129129
openmldb_connected_seconds_created{endpoint="172.17.0.15:9520",role="tablet"} 1.6501813860467942e+09
130130
openmldb_connected_seconds_created{endpoint="172.17.0.15:9521",role="tablet"} 1.6501813860495396e+09

docs/en/maintain/update_conf.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ We'll use the normal mode(background) to restart the components. If you want to
55
```
66

77
## Update Nameserver Configuration
8-
* Backup configuation
8+
* Backup configuration
99
```bash
1010
cp conf/nameserver.flags conf/nameserver.flags.bak
1111
```
12-
* Update configuation
12+
* Update configuration
1313
* Restart the nameserver
1414
```bash
1515
bash bin/start.sh restart nameserver
@@ -30,11 +30,11 @@ Here is the impact when update the configuration of tablet:
3030
* If the table is multi-replica, we will migrate the leader partitions in the tablet to be updating to other tablets, and migrate back after the upgrade. If there is write traffic during the update, there may be data loss.
3131
3232
Steps for updating are as follows:
33-
* Backup configuation
33+
* Backup configuration
3434
```bash
3535
cp conf/tablet.flags conf/tablet.flags.bak
3636
```
37-
* Update configuation
37+
* Update configuration
3838
* `pre-upgrade`: to reduce the interruption to the online service before the restart (refer to [Operation Tool](./openmldb_ops.md))
3939
```bash
4040
python tools/openmldb_ops.py --openmldb_bin_path=./bin/openmldb --zk_cluster=172.24.4.40:30481 --zk_root_path=/openmldb --cmd=pre-upgrade --endpoints=127.0.0.1:10921
@@ -67,21 +67,21 @@ After a tablet node is restarted, repeat the above steps for other tablets.
6767
After all tablets are restarted, resume write operations, and run the `showtablestatus` command to check whether the `Rows` number has increased.
6868
6969
## Update APIServer Configuration
70-
* Backup configuation
70+
* Backup configuration
7171
```bash
7272
cp conf/apiserver.flags conf/apiserver.flags.bak
7373
```
74-
* Update configuation
74+
* Update configuration
7575
* Restart the apiserver
7676
```bash
7777
bash bin/start.sh restart apiserver
7878
```
7979
## Update TaskManager Configuration
80-
* Backup configuation
80+
* Backup configuration
8181
```bash
8282
cp conf/taskmanager.properties conf/taskmanager.properties.bak
8383
```
84-
* Update configuation
84+
* Update configuration
8585
* Restart the taskmanager
8686
```bash
8787
bash bin/start.sh restart taskmanager

0 commit comments

Comments
 (0)