[iotdb] 01/01: Add user guide for upgrading to 0.12

[ha...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

haonan pushed a commit to branch upgrade_user_guide
in repository https://gitbox.apache.org/repos/asf/iotdb.git

commit 2172217f70ef523f5fad065bf39f8a8047693fcf
Author: HTHou <hh...@outlook.com>
AuthorDate: Thu Jan 21 10:50:30 2021 +0800

    Add user guide for upgrading to 0.12
---
 docs/Download/README.md    | 15 ++++++++++++++-
 docs/zh/Download/README.md | 12 +++++++++++-
 2 files changed, 25 insertions(+), 2 deletions(-)

diff --git a/docs/Download/README.md b/docs/Download/README.md
index a176fbf..6933bca 100644
--- a/docs/Download/README.md
+++ b/docs/Download/README.md
@@ -56,12 +56,25 @@ Legacy version are available here: [https://archive.apache.org/dist/iotdb/](http
 
 **<font color=red>Attention</font>**:
 
-- How to upgrade a minor version (e.g., from v0.9.0 to v0.9.3)?
+- How to upgrade a minor version (e.g., from v0.11.0 to v0.11.1)?
   * versions which have the same major version are compatible.
   * Just download and unzip the new version. Then modify the configuration files to keep consistent 
   with what you set in the old version.
   * stop the old vesion instance, and start the new one.
 
+- How to upgrade from v.11.x or v0.10.x to v0.12.x?
+  * Upgrading from v0.11 or v0.10 to v0.12 is similar as v0.9 to v0.10. We the upgrade tool will rewrite the data files.
+  * Stop writing new data.
+  * Call `flush` command using sbin/start-cli.sh in original version to close all TsFiles.
+  * We recommend to backup the data file (also the wal files and mlog.txt) before upgrading for rolling back.
+  * Just download, unzip v0.12.x.zip, and modify conf/iotdb-engine.proeprties to let all the 
+  directories point to the folders set in previous version (or the backup folder). 
+  You can also modify other settings if you want. 
+  * Stop IoTDB v0.11 or v0.10 instance, and start v0.12.x, then the IoTDB will upgrade data file format automatically.
+  * __NOTICE 1: V0.12 changes many settings in conf/iotdb-engine.properties, so do not use previous 
+    configuration file directly.__
+  * __NOTICE 2: V0.12 doesn't support upgrade from v0.9 or lower version, please upgrade to v0.10 first if needed.__
+
 - How to upgrade from v.10.x to v0.11.x?
   * The data format (i.e., TsFile data) of v0.10.x and v0.11 are compatible, but the WAL file is 
   incompatible. So, you can follow the steps:
diff --git a/docs/zh/Download/README.md b/docs/zh/Download/README.md
index 1a3f9b7..97d06a7 100644
--- a/docs/zh/Download/README.md
+++ b/docs/zh/Download/README.md
@@ -55,11 +55,21 @@
 
 **<font color=red>升级注意事项</font>**:
 
-- 如何升级小版本 (例如，从 v0.9.0 to v0.9.3)?
+- 如何升级小版本 (例如，从 v0.11.0 to v0.11.1)?
   * 同一个大版本下的多个小版本是互相兼容的。
   * 只需要下载新的小版本， 然后修改其配置文件，使其与原有版本的设置一致。
   * 停掉旧版本进程，启动新版本即可。
 
+- 如何从v0.11.x或v0.10.x 升级到 v0.12.x? 
+  * 从0.11或0.10升级到0.12的过程与v0.9升级到v0.10类似，升级工具会自动进行数据文件的升级。
+  * 停掉旧版本新数据写入。
+  * 用CLI调用`flush`，确保关闭所有的TsFile文件.
+  * 我们推荐提前备份数据文件（以及写前日志和mlog文件），以备回滚。
+  * 下载最新版，解压并修改配置文件。将各数据目录都指向备份的或者v0.11或0.10原来使用的数据目录。 
+  * 停止旧版本IoTDB的实例，启动v0.12的实例。IoTDB将自动升级数据文件格式。
+    * __注意1：0.12的配置文件进行了较大改动，因此不要直接将原本的配置文件用于0.12__
+    * __注意2: 由于0.12不支持从0.9或者更低版本升级，如果需要升级，请先升级到0.10版本__
+ 
 - 如何从v0.10.x 升级到 v0.11.x?
   * 0.10 与0.11的数据文件格式兼容，但写前日志等格式不兼容，因此需要进行升级（但速度很快）：
   * 停掉0.10的新数据写入。