update docs for #16

apache · Feb 5, 2016 · da4d57e · da4d57e
1 parent e4a7466
commit da4d57e
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 12 deletions.
diff --git a/elastic-job-core/src/main/java/com/dangdang/ddframe/job/api/JobConfiguration.java b/elastic-job-core/src/main/java/com/dangdang/ddframe/job/api/JobConfiguration.java
@@ -134,6 +134,11 @@ public class JobConfiguration {
      */
     private boolean misfire = true;
 
+    /**
+     * 作业辅助监控端口.
+     */
+    private int monitorPort = -1;
+
     /**
      * 作业分片策略实现类全路径.
      * 
@@ -159,9 +164,4 @@ public class JobConfiguration {
      * 如果可覆盖, 每次启动作业都以本地配置为准.
      */
     private boolean overwrite;
-
-    /**
-     * 作业辅助监控端口.
-     */
-    private int monitorPort = -1;
 }
diff --git a/...tic-job-core/src/main/java/com/dangdang/ddframe/reg/zookeeper/ZookeeperConfiguration.java b/...tic-job-core/src/main/java/com/dangdang/ddframe/reg/zookeeper/ZookeeperConfiguration.java
@@ -90,6 +90,7 @@ public class ZookeeperConfiguration extends AbstractRegistryCenterConfiguration
 
     /**
      * 内嵌Zookeeper的数据存储路径.
+     * 为空表示不开启内嵌Zookeeper.
      */
     private String nestedDataDir;
 

diff --git a/elastic-job-doc/content/post/directory_structure.md b/elastic-job-doc/content/post/directory_structure.md
@@ -22,10 +22,6 @@ weight=4
 
 使用示例。
 
-## elastic-job-test
-
-测试`elastic-job`使用的公用类，使用方无需关注。
-
 ## elastic-job-doc
 
 使用`markdown`生成文档的项目，使用方无需关注。
diff --git a/elastic-job-doc/content/post/release_notes.md b/elastic-job-doc/content/post/release_notes.md
@@ -6,6 +6,10 @@ weight=1
 
 # Release Notes
 
+## 1.0.4-snapshot
+1. 精简项目模块，移除elastic-job-test模块
+1. 功能提升Issuse#16，提供内嵌zookeeper，简化开发环境
+
 ## 1.0.3
 1. 修正Issuse#30，注册中心宕机较长时间后重新恢复，作业仍然无法继续执行
 1. 修正Issuse#36，任务在控制台暂停之后，无法恢复运行

diff --git a/elastic-job-doc/content/post/usage.md b/elastic-job-doc/content/post/usage.md
@@ -12,7 +12,7 @@ weight=5
 
 ## 安装Zookeeper
 
-请使用`Zookeeper 3.4.6`及其以上版本。[详情参见](https://zookeeper.apache.org/doc/trunk/zookeeperStarted.html)
+请使用`Zookeeper 3.4.6`及其以上版本。[详情参见](https://zookeeper.apache.org/doc/trunk/zookeeperStarted.html)。或使用`elastic-job`自带的内嵌`Zookeeper`
 
 ## 安装Maven
 

diff --git a/elastic-job-doc/content/post/user_guide.md b/elastic-job-doc/content/post/user_guide.md
@@ -165,7 +165,7 @@ public class XXXSimpleJob extends AbstractSimpleElasticJob {
 |failover                        |boolean|否     |false| 是否开启失效转移<br />仅`monitorExecution`开启，失效转移才有效                   |
 |misfire                         |boolean|否     |true | 是否开启错过任务重新执行                                                     |
 |jobShardingStrategyClass        |String |否     |true | 作业分片策略实现类全路径<br />默认使用平均分配策略<br />详情参见：[作业分片策略](http://dangdangdotcom.github.io/elastic-job/post/job_strategy)     |
-|description                     |String |否     |     | 作业描述信息                |
+|description                     |String |否     |     | 作业描述信息                                                                |
 | disabled                       |boolean|否     |false| 作业是否禁止启动<br />可用于部署作业时，先禁止启动，部署结束后统一启动             |
 | overwrite                      |boolean|否     |false| 本地配置是否可覆盖注册中心配置<br />如果可覆盖，每次启动作业都以本地配置为准        |
 
@@ -181,7 +181,9 @@ public class XXXSimpleJob extends AbstractSimpleElasticJob {
 |maxRetries                      |int    |`是`    |     | 最大重试次数                                                                 |
 |sessionTimeoutMilliseconds      |int    |否     |60000| 会话超时时间<br />单位：毫秒                                                  |
 |connectionTimeoutMilliseconds   |int    |否     |15000| 连接超时时间<br />单位：毫秒                                                  |
-|digest                          |String |否     |无验证| 连接Zookeeper的权限令牌<br />缺省为不需要权限验证                                                  |
+|digest                          |String |否     |无验证| 连接`Zookeeper`的权限令牌<br />缺省为不需要权限验证                              |
+|nestedPort                      |int    |否     |-1   | 内嵌`Zookeeper`的端口号<br />-1表示不开启内嵌`Zookeeper`                          |
+|nestedDataDir                   |String |否     |     | 内嵌`Zookeeper`的数据存储路径<br />为空表示不开启内嵌`Zookeeper`                   |
 
 ### 基于Spring但不使用命名空间