[auto-pick-to-v3.5.0]increment-changes-on-ent-docs (#2793)

* increment-changes-on-ent-docs * Update use-importer.md * Update mkdocs.yml * Update mkdocs.yml --------- Co-authored-by: abby.huang <[email protected]>
vesoft-inc · May 29, 2023 · 861a64a · 861a64a
1 parent 0a5e536
commit 861a64a
Show file tree

Hide file tree

Showing 11 changed files with 99 additions and 49 deletions.
diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md
@@ -2,8 +2,10 @@
 
 本文列出了使用{{nebula.name}} {{ nebula.release }} 时可能遇到的常见问题，用户可以使用文档中心或者浏览器的搜索功能查找相应问题。
 
+{{comm.comm_begin}}
 如果按照文中的建议无法解决问题，请到[{{nebula.name}} 论坛](https://discuss.nebula-graph.com.cn/) 提问或提交 [GitHub issue](https://github.com/vesoft-inc/nebula/issues)。
 
+
 ## 关于本手册
 
 ### 为什么手册示例和系统行为不一致？
@@ -18,6 +20,7 @@
     2. 使用 Markdown 修改文档。完成后点击页面底部的 "Commit changes"，这会触发一个 GitHub pull request。
     3. 完成 [CLA 签署](../15.contribution/how-to-contribute.md)，并且至少 2 位 reviewer 审核通过即可合并。
 
+{{comm.comm_end}}
 ## 关于历史兼容性
 
 {{ comm.comm_begin }} 

diff --git a/docs-2.0/20.appendix/error-code.md b/docs-2.0/20.appendix/error-code.md
@@ -3,8 +3,9 @@
 {{nebula.name}}运行出现问题时，会返回错误码。本文介绍错误码的详细信息。
 
 !!! note
-
+    {comm.comm_begin}
     - 如果出现错误但没有返回错误码，或错误码描述不清，请在[论坛](https://discuss.nebula-graph.com.cn/)或 [GitHub](https://github.com/vesoft-inc/nebula/issues) 反馈。
+    {comm.comm_end}
     - 返回`0`表示执行成功。
 
 |错误名称|错误码|说明|

diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md
@@ -1,12 +1,15 @@
 # {{nebula.name}}学习路径
 
-本文介绍{{nebula.name}}学习路径，用户可以通过路径中的文档及视频由浅入深地学习 NebulaGraph。
+本文介绍{{nebula.name}}学习路径，用户可以通过路径中的文档及视频由浅入深地学习{{nebula.name}}。
 
+{{comm.comm_begin}}
  ![learning path](https://docs-cdn.nebula-graph.com.cn/figures/learning-path.png)
 
 完成{{nebula.name}}学习后，参加[技能认证](https://www.bilibili.com/video/BV1Ga411x7RE)考试还可以获取认证证书。详情参见下文**通过 CI/CP 考试**。
 
 <iframe src="//player.bilibili.com/player.html?aid=215181639&bvid=BV1Ga411x7RE&cid=752738115&page=1&high_quality=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" width="720px" height="480px"> </iframe>
+{{comm.comm_end}}
+
 
 ## 1. 关于{{nebula.name}}
 
@@ -263,6 +266,8 @@
   | 文档                                                         |
   | ------------------------------------------------------------ |
   | [常见问题 FAQ](https://docs.nebula-graph.com.cn/{{nebula.release}}/20.appendix/0.FAQ/#faq) |
+
+{{comm.comm_begin}}
 ## 7. 实操作业
 
  用户可以通过完成以下实操作业来检测是否玩转{{nebula.name}}。
@@ -296,3 +301,5 @@
 - 有关 [{{nebula.name}}索引](../3.ngql-guide/14.native-index-statements/README.md)原理的介绍，参见[开源分布式图数库论文](https://arxiv.org/pdf/2206.07278.pdf)中的 2.4 节。
 
 - 有关{{nebula.name}}语言的概述，参见[开源分布式图数库论文](https://arxiv.org/pdf/2206.07278.pdf)中的 2.8 节。
+
+{{comm.comm_end}}
diff --git a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md
@@ -1,4 +1,10 @@
+{{comm.comm_begin}}
 # 准备编译、安装和运行{{nebula.name}}的环境
+{{comm.comm_end}}
+
+{{ent.ent_begin}}
+# 准备安装和运行{{nebula.name}}的环境
+{{ent.ent_end}}
 
 本文介绍编译、安装{{nebula.name}}的要求和建议，以及如何预估集群运行所需的资源。
 
@@ -27,6 +33,9 @@
 
     从 3.0.2 开始，{{nebula.name}}在 Docker Hub 上的 Docker 支持 ARM64 架构。社区用户可以在 ARM macOS 的 Docker Desktop 上或者 ARM Linux Server 上运行容器化的{{nebula.name}}。
 
+
+  {{ comm.comm_begin }}
+
 ## 编译源码要求
 
 ### 硬件要求
@@ -132,23 +141,7 @@
 
 3. 如果 CMake 或 g++ 版本不符合要求，访问官网以获取符合需要的版本。
 
-<!--或根据以下方法安装合适版本的 GCC。
-
-  - CentOS 系统的用户依次执行以下命令：
-
-    ```
-    yum install centos-release-scl
-    yum install devtoolset-11
-    scl enable devtoolset-11 'bash'
-    ```
-
-  - Ubuntu 系统的用户依次执行以下命令：
-
-    ```
-    add-apt-repository ppa:ubuntu-toolchain-r/test
-    apt install gcc-11 g++-11
-    ```
--->
+  {{ comm.comm_end }}
 
 ## 测试环境要求
 

diff --git a/...tallation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md b/...tallation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
@@ -19,6 +19,7 @@
 
 ## 操作步骤
 
+  {{ comm.comm_begin }}
 1. 使用如下地址下载{{nebula.name}}的 tar.gz 文件。
 
   下载前需将`<release_version>`替换为需要下载的版本。
@@ -55,6 +56,11 @@
   ```bash
   wget https://oss-cdn.nebula-graph.com.cn/package/{{nebula.release}}/nebula-graph-{{nebula.release}}.el7.x86_64.tar.gz
   ```
+  {{ comm.comm_end }}
+
+  {{ent.ent_begin}}
+1. [联系我们](https://yueshu.com.cn/contact)获取{{nebula.name}}安装包。
+  {{ent.ent_end}}
 
 2. 解压 tar.gz 文件到{{nebula.name}}安装目录。
 
@@ -67,16 +73,27 @@
 
   例如：
 
+  {{comm.comm_begin}}
   ```bash
   tar -xvzf nebula-graph-{{nebula.release}}.el7.x86_64.tar.gz -C /home/joe/nebula/install
   ```
+  {{comm.comm_end}}
+
+  {{ent.ent_begin}}
+  ```bash
+  tar -xvzf yueshu-graph-{{nebula.release}}.el7.x86_64.tar.gz -C /home/joe/nebula/install
+  ```
+  {{ent.ent_end}}
 
 3. 修改配置文件名以应用配置。
 
   进入解压出的目录，将子目录`etc`中的文件`nebula-graphd.conf.default`、`nebula-metad.conf.default`和`nebula-storaged.conf.default`重命名，删除`.default`，即可应用{{nebula.name}}的默认配置。
 
 {{ ent.ent_begin }}
-4. 在{{nebula.name}}的 Meta 服务配置文件（`nebula-metad.conf`）中，设置`license_manager_url`的值为许可证管理工具所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。
+4. 配置 License 管理工具 License Manager 地址。
+
+  1. 在{{nebula.name}}的 Meta 服务配置文件（`nebula-metad.conf`）中，设置`license_manager_url`的值为许可证管理工具所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。
+  2. 将 Meta、Storage 和 Graph 服务的配置文件（`nebula-metad.conf`、`nebula-graphd.conf`、`nebula-storaged.conf`）中的所有`local_ip`（默认`127.0.0.1`）替换为各服务所在主机的真实 IP，以及将`meta_server_addrs`地址替换为 Meta 服务所在主机 IP 地址和端口号`9559`。
 
 {{ ent.ent_end }}
 

diff --git a/...-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md b/...-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
@@ -32,7 +32,9 @@
 
 - [使用 RPM 或 DEB 包安装{{nebula.name}}](2.install-nebula-graph-by-rpm-or-deb.md)
 
+{{ comm.comm_begin }}
 - [使用源码安装{{nebula.name}}](1.install-nebula-graph-by-compiling-the-source-code.md)
+{{ comm.comm_end }}
 
 ### 修改配置文件
 

diff --git a/docs-2.0/nebula-importer/use-importer.md b/docs-2.0/nebula-importer/use-importer.md
@@ -25,13 +25,13 @@ NebulaGraph Importer（简称 Importer）是一款{{nebula.name}}的 CSV 文件
 在使用 NebulaGraph Importer 之前，请确保：
 
 - 已部署{{nebula.name}}服务。目前有三种部署方式：
-
-  - [Docker Compose 部署](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md)
-
+
   - [RPM/DEB 包安装](../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)
+    {{comm.comm_begin}}
+  - [Docker Compose 部署](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md)
 
   - [源码编译安装](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)
-
+    {{comm.comm_end}}
 - {{nebula.name}} 中已创建 Schema，包括图空间、Tag 和 Edge type，或者通过参数`manager.hooks.before.statements`设置。
 
 ## 操作步骤

diff --git a/docs-2.0/reuse/source_connect-to-nebula-graph.md b/docs-2.0/reuse/source_connect-to-nebula-graph.md
@@ -1,4 +1,4 @@
-本文介绍如何使用原生命令行客户端 Nebula Console 连接 NebulaGraph。
+本文介绍如何使用原生命令行客户端 Nebula Console 连接{{nebula.name}}。
 
 <!--本文中的链接必须用外链，因为这篇文档是复用的，用内部链接会出错。-->
 
@@ -10,7 +10,7 @@
 
 ## 前提条件
 
--{{nebula.name}}服务已[启动](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/manage-service/)。
+- {{nebula.name}}服务已[启动](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/manage-service/)。
 
 - 运行 Nebula Console 的机器和运行{{nebula.name}}的服务器网络互通。
 

diff --git a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md
@@ -5,27 +5,30 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如
     部署{{nebula.name}}集群的方式参见[使用 RPM/DEB 包部署集群](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts/)。<!--这里用外链。-->
 
 
-{{ ent.ent_begin }}
-!!! enterpriseonly
-
-    企业版请[联系我们](https://yueshu.com.cn/contact)。
-
-{{ ent.ent_end }}
-
 ## 前提条件
 
 - 安装`wget`工具。
 {{ ent.ent_begin }}
-- 已[在 LM 中加载 License Key](https://docs.nebula-graph.com.cn/{{nebula.release}}/9.about-license/2.license-management-suite/3.license-manager/)。
+- 已[在 LM 中加载 License Key](https://ent-docs.nebula-graph.com.cn/{{nebula.release}}/9.about-license/2.license-management-suite/3.license-manager/)。
 {{ ent.ent_end }}
 
 ## 下载安装包
 
+
+{{ ent.ent_begin }}
+
+[联系我们](https://yueshu.com.cn/contact)获取{{nebula.name}}安装包。
+
+{{ ent.ent_end }}
+
 !!! note
 
     - 当前仅支持在 Linux 系统下安装{{nebula.name}}，且仅支持 CentOS 7.x、CentOS 8.x、Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04 操作系统。
 
-    - 如果用户使用的是国产化的 Linux 操作系统，请[安装企业版{{nebula.name}}](https://www.nebula-graph.com.cn/contact)。  
+    - 如果用户使用的是国产化的 Linux 操作系统，请[安装企业版{{nebula.name}}](https://yueshu.com.cn/contact)。  
+
+
+{{ comm.comm_begin }}
 
 ### 阿里云 OSS 下载
 
@@ -102,6 +105,8 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如
     wget https://oss-cdn.nebula-graph.com.cn/package/nightly/2021.11.24/nebula-graph-2021.11.24-nightly.ubuntu1804.amd64.deb.sha256sum.txt
     ```
 
+{{ comm.comm_end }}
+
 ## 安装{{nebula.name}}
 
 - 安装 RPM 包
@@ -114,9 +119,17 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如
 
   例如，要在默认路径下安装{{nebula.release}}版本的 RPM 包，运行如下命令：
 
+  {{ comm.comm_begin }}
   ```bash
   sudo rpm -ivh nebula-graph-{{nebula.release}}.el7.x86_64.rpm
   ``` 
+  {{ comm.comm_end }}
+
+  {{ ent.ent_begin }}
+  ```bash
+  sudo rpm -ivh yueshu-graph-{{nebula.release}}.el7.x86_64.rpm
+  ```  
+  {{ ent.ent_end }}
 
 - 安装 DEB 包
 
@@ -129,14 +142,24 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如
 
   例如安装{{nebula.release}}版本的 DEB 包：
 
+  {{ comm.comm_begin }}
   ```bash
   sudo dpkg -i nebula-graph-{{nebula.release}}.ubuntu1804.amd64.deb
   ```
+  {{ comm.comm_end }}
+
+  {{ ent.ent_begin }}
+  ```bash
+  sudo dpkg -i yueshu-graph-{{nebula.release}}.ubuntu1804.amd64.deb
+  ```
+  {{ ent.ent_end }}
+
 
 {{ ent.ent_begin }}
-## 配置许可证管理工具地址
+## 配置 License 管理工具（LM）地址
 
-在{{nebula.name}}的 Meta 服务配置文件（`nebula-metad.conf`）中，设置`license_manager_url`的值为许可证管理工具所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。
+1. 在{{nebula.name}}的 Meta 服务配置文件（`nebula-metad.conf`）中，设置`license_manager_url`的值为许可证管理工具所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。
+2. 将 Meta、Storage 和 Graph 服务的配置文件（`nebula-metad.conf`、`nebula-graphd.conf`、`nebula-storaged.conf`）中的所有`local_ip`（默认`127.0.0.1`）替换为各服务所在主机的真实 IP，以及将`meta_server_addrs`地址替换为 Meta 服务所在主机 IP 地址和端口号`9559`。
 
 {{ ent.ent_end }}
 

diff --git a/docs-2.0/reuse/source_manage-service.md b/docs-2.0/reuse/source_manage-service.md
@@ -1,16 +1,17 @@
+
+{{ comm.comm_begin }}
 {{nebula.name}}支持通过脚本管理服务。
+{{ comm.comm_end }}
 
 {{ ent.ent_begin }}
+{{nebula.name}}支持使用脚本管理服务和使用 systemd 管理服务。
 
-!!! enterpriseonly
-
-    企业版还支持使用 systemd 管理服务。
-
-!!! danger
+!!! caution
 
     这两种方式互不兼容，选择使用其中一种。
 
 {{ ent.ent_end }}
+
 ## 使用脚本管理服务
 
 使用脚本`nebula.service`管理服务，包括启动、停止、重启、中止和查看。

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -135,6 +135,7 @@ plugins:
         - nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md
         - nebula-cloud/nebula-cloud-on-alibabacloud/3.delete-service-instance.md
         - nebula-cloud/nebula-cloud-on-alibabacloud/4.scaling-services.md
+        - 4.deployment-and-installation/3.upgrade-nebula-graph/_upgrade-nebula-from-300-to-latest.md
         # exclude.ent.end
         # exclude.comm.begin
         - nebula-dashboard/1.what-is-dashboard.md
@@ -152,6 +153,13 @@ plugins:
         - 20.appendix/release-notes/nebula-comm-release-note.md
         - 20.appendix/release-notes/studio-release-note.md
         - 20.appendix/release-notes/dashboard-comm-release-note.md
+        - 4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md
+        - 15.contribution/how-to-contribute.md
+        - 4.deployment-and-installation/standalone-deployment.md
+        - 4.deployment-and-installation/3.upgrade-nebula-graph/_upgrade-nebula-from-300-to-latest.md
+        - 8.service-tuning/enable_autofdo_for_nebulagraph.md
+        - 20.appendix/history.md
+        - 20.appendix/mind-map.md
         # exclude.comm.end
 
 # Exclude the file with the following file name.
@@ -554,14 +562,12 @@ nav:
 
   - 安装部署:
       - 准备资源: 4.deployment-and-installation/1.resource-preparations.md
-      - 编译与安装:
-          - 使用源码安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md
+      - 安装软件包:
           - 使用 RPM/DEB 包安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md
-          - 使用 tar.gz 文件安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
+          - 使用 TAR 包安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
           - 使用 Docker Compose 部署: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
           - 使用 RPM/DEB 包部署多机集群: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
           - 使用生态工具安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md
-      - 安装存算合并版悦数图数据库: 4.deployment-and-installation/standalone-deployment.md
       - 管理服务: 4.deployment-and-installation/manage-service.md
       - 连接服务: 4.deployment-and-installation/connect-to-nebula-graph.md
       - 管理 Storage 主机: 4.deployment-and-installation/manage-storage-host.md
@@ -653,7 +659,6 @@ nav:
       - 系统建模: 8.service-tuning/3.system-design.md
       - 执行计划: 8.service-tuning/4.plan.md
       - 超级节点(稠密点): 8.service-tuning/super-node.md
-      - 启用 AutoFDO: 8.service-tuning/enable_autofdo_for_nebulagraph.md
       - 实践案例: 8.service-tuning/practice.md
 
   - 客户端:
@@ -806,8 +811,6 @@ nav:
       - 学习路径: 20.appendix/learning-path.md
       - 常见问题 FAQ: 20.appendix/0.FAQ.md
       - 生态工具概览: 20.appendix/6.eco-tool-version.md
-      - 年表: 20.appendix/history.md
-      - 思维导图: 20.appendix/mind-map.md
       - 错误码: 20.appendix/error-code.md
 # nav.ent.begin