ptyp commented on a change in pull request #399:
URL:
https://github.com/apache/dolphinscheduler-website/pull/399#discussion_r665499277
##########
File path: docs/en-us/dev/user_doc/registry_spi.md
##########
@@ -0,0 +1,27 @@
+### Dolphinscheduler Registry SPI main design
+
+#### How to use？
Review comment:
Actually, "how to use?" is not a correct structure. Here you can
directly use "The usage instruction" or any other similar phrases, or the
corrected version "How to use it?"(phrase version)/"How do you use
it?"(sentence version).
##########
File path: docs/en-us/dev/user_doc/registry_spi.md
##########
@@ -0,0 +1,27 @@
+### Dolphinscheduler Registry SPI main design
+
+#### How to use？
+
+First you need to execute the `mvn -U install package -Prelease
-Dmaven.test.skip=true` installation plugin to generate the plugin JAR of the
registry. The directory is:
dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry
Review comment:
The meaning of the first sentence may be ambiguous. "First, you need to
execute the `mvn -U install package -Prelease -Dmaven.test.skip=true` to
install the plugin for generating the plugin JAR of the registry." should be
better.
BTY, a full stop is missed in the second sentence:).
##########
File path: docs/en-us/dev/user_doc/registry_spi.md
##########
@@ -0,0 +1,27 @@
+### Dolphinscheduler Registry SPI main design
+
+#### How to use？
+
+First you need to execute the `mvn -U install package -Prelease
-Dmaven.test.skip=true` installation plugin to generate the plugin JAR of the
registry. The directory is:
dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry
+
+Next, do the following configuration (using zookeeper as an example)
+
+| Parameter | Default
| Description |
+| :---------------------: |
------------------------------------------------------------ |
---------------------------------------- |
+| zookeeper.quorum | localhost:2181
| zk Cluster connection information |
+| registry.plugin.dir |
/Users/username/workspaces/dolphinscheduler/dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
| Registration Center Plugin Directory |
+| registry.plugin.name\| | zookeeper
| Registration Center specific plugin name |
+| registry.plugin.binding | registry
| Dolphinscheduler plugin category |
+| registry.servers | 127.0.0.1:2181
| ZK connection address |
+
+For specific configuration information, please refer to the parameter
information that provided by the specific plugin, for example zk:
org/apache/dolphinscheduler/plugin/registry/zookeeper/ZookeeperConfiguration.java
All configuration information should be prefixed with +registry. For example,
base.sleep.time.ms should be configured in the registry like this:
registry.base.sleep.time.ms=100.
+
+#### FAQ
+
+1: not found registry plugin
+
+Please check that `mvn -U install package -Prelease -Dmaven.test.skip=true` is
executed, and that the directory configured in registry.plugin.dir in the
configuration file contains the relevant plugins.
Review comment:
You may miss the "if" in first half of sentence "Please check if ...".
And for the second half, It demonstrates better as "Besides, Please check if
the directory ..." while taking this whole sentence into two seperate parts.
##########
File path: docs/en-us/dev/user_doc/registry_spi.md
##########
@@ -0,0 +1,27 @@
+### Dolphinscheduler Registry SPI main design
+
+#### How to use？
+
+First you need to execute the `mvn -U install package -Prelease
-Dmaven.test.skip=true` installation plugin to generate the plugin JAR of the
registry. The directory is:
dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry
+
+Next, do the following configuration (using zookeeper as an example)
+
+| Parameter | Default
| Description |
+| :---------------------: |
------------------------------------------------------------ |
---------------------------------------- |
+| zookeeper.quorum | localhost:2181
| zk Cluster connection information |
+| registry.plugin.dir |
/Users/username/workspaces/dolphinscheduler/dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
| Registration Center Plugin Directory |
+| registry.plugin.name\| | zookeeper
| Registration Center specific plugin name |
+| registry.plugin.binding | registry
| Dolphinscheduler plugin category |
+| registry.servers | 127.0.0.1:2181
| ZK connection address |
+
+For specific configuration information, please refer to the parameter
information that provided by the specific plugin, for example zk:
org/apache/dolphinscheduler/plugin/registry/zookeeper/ZookeeperConfiguration.java
All configuration information should be prefixed with +registry. For example,
base.sleep.time.ms should be configured in the registry like this:
registry.base.sleep.time.ms=100.
Review comment:
I changed a little bit about this sentence. The meaning of this version
would be clearer and you can take it as a reference.
"For the specific configuration information, please refer to the parameter
information that provided by the specific plugin. Taking zk as an example, all
the parameters of this configuration information about zk are in the class
org/apache/dolphinscheduler/plugin/registry/zookeeper/ZookeeperConfiguration.java.
If a parameter is needed to be changed to a specific value instead of the
default, it can be configured directly in the registry. However, the prefix
should be added to indicate this is a parameter of the registry. For example,
"base.sleep.time.ms" should be configured in the registry as:
"registry.base.sleep.time.ms=100"."
##########
File path: docs/en-us/dev/user_doc/registry_spi.md
##########
@@ -0,0 +1,27 @@
+### Dolphinscheduler Registry SPI main design
+
+#### How to use？
+
+First you need to execute the `mvn -U install package -Prelease
-Dmaven.test.skip=true` installation plugin to generate the plugin JAR of the
registry. The directory is:
dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry
+
+Next, do the following configuration (using zookeeper as an example)
+
+| Parameter | Default
| Description |
+| :---------------------: |
------------------------------------------------------------ |
---------------------------------------- |
+| zookeeper.quorum | localhost:2181
| zk Cluster connection information |
+| registry.plugin.dir |
/Users/username/workspaces/dolphinscheduler/dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
| Registration Center Plugin Directory |
+| registry.plugin.name\| | zookeeper
| Registration Center specific plugin name |
+| registry.plugin.binding | registry
| Dolphinscheduler plugin category |
+| registry.servers | 127.0.0.1:2181
| ZK connection address |
+
+For specific configuration information, please refer to the parameter
information that provided by the specific plugin, for example zk:
org/apache/dolphinscheduler/plugin/registry/zookeeper/ZookeeperConfiguration.java
All configuration information should be prefixed with +registry. For example,
base.sleep.time.ms should be configured in the registry like this:
registry.base.sleep.time.ms=100.
+
+#### FAQ
+
+1: not found registry plugin
+
+Please check that `mvn -U install package -Prelease -Dmaven.test.skip=true` is
executed, and that the directory configured in registry.plugin.dir in the
configuration file contains the relevant plugins.
+
+2：registry connect timeout
+
+You can increase the relevant timeout parameters.
Review comment:
“increase“ should be “add”
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
