Miscellaneous editorial updates.

milvus-io · Jul 26, 2020 · 5bdb57e · 5bdb57e
1 parent eb6fd62
commit 5bdb57e
Show file tree

Hide file tree

Showing 12 changed files with 46 additions and 77 deletions.
diff --git a/site/en/faq/troubleshoot.md b/site/en/faq/troubleshoot.md
@@ -16,11 +16,11 @@ $ docker logs <milvus container id>
 
 ## Operational issue
 
-Issues that occur during the server operation, which may cause server down. If you encounter issues during operation, first confirm that whether the issue is caused by the incompatibility of Milvus and SDK versions. Then check the error messages that are recorded in `/home/$USER/milvus/logs`.
+Issues that occur during the server operation, which may cause server down. If you encounter issues during operation, first confirm that whether the issue is caused by the incompatibility of Milvus and SDK versions. Then check the error messages that are recorded in **/home/$USER/milvus/logs**.
 
 ## API issue
 
-Issues that occur during the operation with Milvus through APIs. Corresponding error messages will be returned real time to the client side.
+Issues that occur during the operation with Milvus through APIs. Corresponding error messages will be returned in real time to the client.
 
 If you cannot resolve the issue easily yourself, you can:
 

diff --git a/site/en/menuStructure/en.json b/site/en/menuStructure/en.json
@@ -47,7 +47,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 2,
+      "order": 1,
       "isMenu": true
     },
     {
@@ -90,7 +90,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 4,
+      "order": 2,
       "isMenu": true
     },
     {
@@ -229,7 +229,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 5,
+      "order": 3,
       "isMenu": true
     },
     {
@@ -238,23 +238,23 @@
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 1
+      "order": 0
     },
     {
       "id": "data_manage.md",
       "title": "Manage metadata with MySQL",
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 2
+      "order": 1
     },
     {
-      "id": "monitoring_metrics.md",
-      "title": "Monitoring Metrics",
+      "id": "monitor.md",
+      "title": "Monitoring and Alerting",
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 3
+      "order": 2
     },
     {
       "id": "vector_db.md",
@@ -266,27 +266,20 @@
     },
     {
       "id": "metric.md",
-      "title": "Choosing a Distance Metric",
+      "title": "Choose a Distance Metric",
       "label1": "reference",
       "label2": "",
       "label3": "",
       "order": 5
     },
-    {
-      "id": "monitor.md",
-      "title": "Monitoring and Alerting",
-      "label1": "reference",
-      "label2": "",
-      "label3": "",
-      "order": 6
-    },
+
 
     {
       "id": "faq",
       "title": "FAQ",
       "label1": "",
       "label2": "",
-      "order": 7,
+      "order": 4,
       "isMenu": true
     },
     {
@@ -326,7 +319,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 8,
+      "order": 5,
       "isMenu": true
     },
     {
@@ -380,7 +373,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 9,
+      "order": 6,
       "isMenu": true
     },
     {
@@ -415,7 +408,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 10
+      "order": 7
     }
   ]
 }
diff --git a/site/en/quick_start/install_milvus/install_milvus.md b/site/en/quick_start/install_milvus/install_milvus.md
@@ -49,5 +49,4 @@ Refer to [Build Milvus from source](https://github.com/milvus-io/milvus/blob/mas
   
 - If you're ready to run Milvus in production:
 
-  - [Configure Milvus for Production](performance_tuning.md)
   - Build a [monitoring and alerting system](monitor.md) to check real-time application performance
diff --git a/site/en/reference/milvus_config.md b/site/en/reference/milvus_config.md
@@ -142,7 +142,7 @@ This section determines whether to enable GPU support/usage in Milvus. GPU suppo
 </div>
 
 <div class="alert note">
-In Milvus, index building and search computation are separate processes, which can be executed on CPU, GPU, or both. You can assign index building and search computation to multiple GPUs by adding GPUs under <code>search_devices</code> or <code>build_index_devices</code>. Please refer to the following YAML sample code:
+In Milvus, index building and search computation are separate processes, which can be executed on CPU, GPU, or both. You can assign index building and search computation to multiple GPUs by adding GPUs under <code>search_devices</code> or <code>build_index_devices</code>. See the following YAML sample code:
 </div>
 
 ```yaml

diff --git a/site/en/reference/monitor.md b/site/en/reference/monitor.md
@@ -60,7 +60,7 @@ Milvus generates detailed time series metrics. This page shows you how to pull t
 
 ### Install Prometheus
 
-1. Download the [Prometheus tarball](https://prometheus.io/download/) for your OS.
+1. Download the [Prometheus tarball](https://prometheus.io/download/) for your operating system.
 
 2. Go to the Prometheus file directory, and make sure Prometheus is installed successfully:
 
@@ -182,7 +182,7 @@ metric:
 2. Use your browser to open `http://<hostname of machine running grafana>:3000` and log into the Grafana UI.
 
 <div class="alert note">
-Grafana's default username and password are both "admin". You can create a Grafana account of your own.
+Grafana's default username and password are both <code>admin</code>. You can create a Grafana account of your own.
 </div>
 
 3. [Add Prometheus as a data source](https://grafana.com/docs/grafana/latest/features/datasources/prometheus/).
@@ -193,7 +193,7 @@ Grafana's default username and password are both "admin". You can create a Grafa
    | :------ | :----------------------------------------------------- |
    | Name    | Prometheus                                             |
    | Default | `True`                                                   |
-   | URL     | `http://<hostname of machine running prometheus>:9090` |
+   | URL     | *http://<hostname of machine running prometheus>:9090* |
    | Access  | Browser                                                |
 
 5. Download the starter [Grafana dashboard](https://github.com/milvus-io/docs/blob/v{{var.release_version}}/assets/monitoring/dashboard.json) for Milvus:
@@ -206,7 +206,7 @@ Grafana's default username and password are both "admin". You can create a Grafa
 
 ### Send notifications with Alertmanager
 
-1. Download the [latest Alertmanager tarball](https://prometheus.io/download/#alertmanager) for your OS.
+1. Download the [latest Alertmanager tarball](https://prometheus.io/download/#alertmanager) for your operating system.
 
 2. Ensure that Alertmanager is properly installed:
 

diff --git a/site/zh-CN/faq/troubleshoot.md b/site/zh-CN/faq/troubleshoot.md
@@ -16,7 +16,7 @@ $ docker logs <milvus container id>
 
 ## 服务运行问题
 
-服务运行期间发生的故障有可能导致服务瘫痪。遇到此类故障时，请先检查系统版本和所使用的客户端版本是否兼容，然后再查询相关错误信息。服务运行的错误信息将被记录在 `/home/$USER/milvus/logs` 文件中。
+服务运行期间发生的故障有可能导致服务瘫痪。遇到此类故障时，请先检查系统版本和所使用的客户端版本是否兼容，然后再查询相关错误信息。服务运行的错误信息将被记录在 **/home/$USER/milvus/logs** 文件中。
 
 ## API 问题
 

diff --git a/site/zh-CN/menuStructure/cn.json b/site/zh-CN/menuStructure/cn.json
@@ -48,7 +48,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 2,
+      "order": 1,
       "isMenu": true
     },
     {
@@ -105,7 +105,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 4,
+      "order": 2,
       "isMenu": true
     },
     {
@@ -208,7 +208,7 @@
     },
     {
       "id": "search_vector_python.md",
-      "title": "搜索向量",
+      "title": "查询向量",
       "label1": "quick_start",
       "label2": "get_started",
       "label3": "",
@@ -244,7 +244,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 5,
+      "order": 3,
       "isMenu": true
     },
     {
@@ -253,15 +253,15 @@
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 1
+      "order": 0
     },
     {
       "id": "data_manage.md",
       "title": "使用 MySQL 管理元数据",
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 2
+      "order": 1
     },
 
     {
@@ -270,23 +270,23 @@
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 4
+      "order": 2
     },
     {
       "id": "metric.md",
       "title": "选择距离计算方式",
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 5
+      "order": 3
     },
     {
       "id": "monitor",
       "title": "监控与报警",
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 6,
+      "order": 4,
       "isMenu": true
     },
     {
@@ -320,30 +320,30 @@
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 7
+      "order": 5
     },
     {
       "id": "mishards.md",
       "title": "Mishards - Milvus 集群分片中间件",
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 8
+      "order": 6
     },
     {
       "id": "storage_operation.md",
       "title": "存储操作",
       "label1": "reference",
       "label2": "",
       "label3": "",
-      "order": 9
+      "order": 7
     },
     {
       "id": "faq",
       "title": "常见问题",
       "label1": "",
       "label2": "",
-      "order": 7,
+      "order": 4,
       "isMenu": true
     },
     {
@@ -383,7 +383,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 8,
+      "order": 5,
       "isMenu": true
     },
     {
@@ -437,7 +437,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 9,
+      "order": 6,
       "isMenu": true
     },
     {
@@ -472,7 +472,7 @@
       "label1": "",
       "label2": "",
       "label3": "",
-      "order": 10
+      "order": 7
     }
   ]
 }
diff --git a/site/zh-CN/quick_start/get_started/search_vector_python.md b/site/zh-CN/quick_start/get_started/search_vector_python.md
@@ -2,11 +2,11 @@
 id: search_vector_python.md
 ---
 
-# 搜索向量
+# 查询向量
 
-Milvus 支持在 collection 或分区中搜索向量。
+Milvus 支持在 collection 或分区中查询向量。
 
-## 在 collection 中搜索向量
+## 在 collection 中查询向量
 
 1. 创建搜索参数。搜索参数是一个 JSON 字符串，在 Python SDK 中以字典来表示。
 
@@ -38,7 +38,7 @@ Milvus 支持在 collection 或分区中搜索向量。
    >>> milvus.search(collection_name='test01', query_records=q_records, top_k=2, params=search_param)
    ```
 
-## 在分区中搜索向量
+## 在分区中查询向量
 
 ```python
 # create 5 vectors of 256-dimension

diff --git a/site/zh-CN/quick_start/install_milvus/gpu_milvus_docker.md b/site/zh-CN/quick_start/install_milvus/gpu_milvus_docker.md
@@ -73,7 +73,7 @@ $ wget http://raw.githubusercontent.com/milvus-io/milvus/v{{var.release_version}
 
 ## 启动 Milvus Docker 容器
 
-启动 Docker 容器之前，你必须将 `server_config.yaml` 中 `gpu` 部分的 `enable` 设为 `true`。
+启动 Docker 容器之前，你必须将 **server_config.yaml** 中 `gpu` 部分的 `enable` 设为 `true`。
 
 启动 Docker 容器，将本地的文件路径映射到容器中：
 

diff --git a/site/zh-CN/quick_start/install_milvus/install_milvus.md b/site/zh-CN/quick_start/install_milvus/install_milvus.md
@@ -50,5 +50,4 @@ Milvus 中的向量搜索包含但不限于这两个独立的部分：创建索
 
 - 如果你已准备好在生产环境中部署 Milvus：
 
-  - [配置 Milvus 以用于生产环境](performance_tuning.md)
   - 创建 [监控与报警系统](monitor.md) 实时监控系统性能
Original file line number	Diff line number	Diff line change
Expand Up		@@ -49,5 +49,4 @@ Refer to [Build Milvus from source](https://github.com/milvus-io/milvus/blob/mas

		- If you're ready to run Milvus in production:

		- [Configure Milvus for Production](performance_tuning.md)
		- Build a [monitoring and alerting system](monitor.md) to check real-time application performance
-Original file line number
+Diff line change
@@ Expand Up @@
     </div>
     <div class="alert note">
-    In Milvus, index building and search computation are separate processes, which can be executed on CPU, GPU, or both. You can assign index building and search computation to multiple GPUs by adding GPUs under <code>search_devices</code> or <code>build_index_devices</code>. Please refer to the following YAML sample code:
+    In Milvus, index building and search computation are separate processes, which can be executed on CPU, GPU, or both. You can assign index building and search computation to multiple GPUs by adding GPUs under <code>search_devices</code> or <code>build_index_devices</code>. See the following YAML sample code:
     </div>
     ```yaml
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,5 +50,4 @@ Milvus 中的向量搜索包含但不限于这两个独立的部分：创建索

		- 如果你已准备好在生产环境中部署 Milvus：

		- [配置 Milvus 以用于生产环境](performance_tuning.md)
		- 创建 [监控与报警系统](monitor.md) 实时监控系统性能