From 24e3f93d598a3bebc1068f2256dfdbc4d908e332 Mon Sep 17 00:00:00 2001
From: Amber Zhang <42762957+Amber1990Zhang@users.noreply.github.com>
Date: Tue, 28 Sep 2021 19:34:14 +0800
Subject: [PATCH] install-dir info (#341)

* install-dir info

* update

* update2
---
 .../1.how-to-contribute.md                    |  4 +--
 .../installation-directory.md                 | 34 +++++++++++++++++++
 docs/mkdocs.yml                               |  1 +
 3 files changed, 37 insertions(+), 2 deletions(-)
 create mode 100644 docs/docs/docs-cn/4.installation-and-deployment/installation-directory.md

diff --git a/docs/docs/docs-cn/15.community-contribution/1.how-to-contribute.md b/docs/docs/docs-cn/15.community-contribution/1.how-to-contribute.md
index bfb7674ed..a6b5c24d9 100644
--- a/docs/docs/docs-cn/15.community-contribution/1.how-to-contribute.md
+++ b/docs/docs/docs-cn/15.community-contribution/1.how-to-contribute.md
@@ -11,10 +11,10 @@ OceanBase 数据库是一个开源的项目。欢迎您贡献代码或文档。
 贡献指南 
 -------------------------
 
-按照以下步骤提交 Pull Request（简称 PR）：
 **注意**
 
-本节介绍如何为 `master` 分支创建 PR。为其他分支创建 PR 的步骤与此类似。
+本节介绍如何为 `master` 分支创建 PR。为其他分支创建 PR 的步骤与此按照以下步骤提交 Pull Request（简称 PR）：
+类似。
 
 **步骤 1：Fork 项目仓库** 
 
diff --git a/docs/docs/docs-cn/4.installation-and-deployment/installation-directory.md b/docs/docs/docs-cn/4.installation-and-deployment/installation-directory.md
new file mode 100644
index 000000000..56c710931
--- /dev/null
+++ b/docs/docs/docs-cn/4.installation-and-deployment/installation-directory.md
@@ -0,0 +1,34 @@
+# OceanBase 安装路径
+
+OceanBase 数据库默认安装在 `/home/admin/oceanbase` 下，主要由以下子目录构成：
+
+```text
+|-- bin
+|-- etc
+|   |-- observer.config.bin
+|   `-- observer.config.bin.history
+|-- lib
+|-- log
+|   |-- election.log
+|   |-- election.log.wf
+|   |-- observer.log
+|   |-- observer.log.wf
+|   |-- rootservice.log
+|   |-- rootservice.log.wf
+|-- run
+|   |-- mysql.sock
+|   `-- observer.pid
+`-- store
+    |-- clog
+    |-- ilog
+    |-- slog
+    |-- sort_dir
+    `-- sstable
+```
+
+`bin` 目录存放二进制文件。
+`etc` 目录存放配置文件。
+`lib` 目录存放依赖。
+`log` 目录存放运行日志，包括选举模块日志、启动和运行日志和 RootService 日志。
+`run` 目录存放运行文件。
+`store` 目录存放数据文件。`clog` 为提交日志（Commit Log），记录事务和 PartitionService 提供的原始日志内容，所有分区共用。`ilog` （Index Log）为存储日志目录，记录分区内部 log_id > clog（file_id 和 offset）的索引信息，所有分区共用。`slog` （Storage Log）为存储日志，记录 SSTable 操作的信息。
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 4cab76f6b..b62c6c2f4 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -144,6 +144,7 @@ nav:
       - （可选）创建用户: docs-cn/4.installation-and-deployment/11.optional-create-a-user.md
       - 使用 RPM 包安装 OceanBase 数据库: docs-cn/4.installation-and-deployment/12.install-the-oceanbase-database-by-using-the-rpm-package.md
       - 使用源码构建 OceanBase 数据库: docs-cn/4.installation-and-deployment/13.get-the-oceanbase-database-by-using-source-code.md
+      - 安装路径说明: docs-cn/4.installation-and-deployment/installation-directory.md
     - 概括:
       - 整体架构: docs-cn/5.overview/1.overall-architecture.md
       - 数据分布: