Doc iteration userguide (#1069)

milvus-io · Nov 12, 2021 · 565d69b · 565d69b
1 parent cb80c27
commit 565d69b
Show file tree

Hide file tree

Showing 58 changed files with 3,276 additions and 2,950 deletions.
diff --git a/site/en/Variables.json b/site/en/Variables.json
@@ -1,7 +1,7 @@
 {
   "milvus_release_version": "2.0.0-RC8",
   "milvus_python_sdk_version": "2.0.0rc8",
-  "milvus_node_sdk_version": "1.0.18",
+  "milvus_node_sdk_version": "1.0.19",
   "cpu_milvus_docker_image_version": "2.0.0-rc8",
   "gpu_milvus_docker_image_version": ""
 }
diff --git a/site/en/getstarted/cluster/install_cluster-docker.md b/site/en/getstarted/cluster/install_cluster-docker.md
@@ -113,7 +113,7 @@ Having installed Milvus, you can:
 - Check [Hello Milvus](example_code.md) to run an example code with different SDKs to see what Milvus can do.
 
 - Learn the basic operations of Milvus:
-  - [Connect to Milvus server](connect.md)
+  - [Connect to Milvus server](manage_connection.md)
   - [Conduct a vector search](search.md)
   - [Conduct a hybrid search](hybridsearch.md)
 

diff --git a/site/en/getstarted/cluster/install_cluster-helm.md b/site/en/getstarted/cluster/install_cluster-helm.md
@@ -151,7 +151,7 @@ Having installed Milvus, you can:
 - Check [Hello Milvus](example_code.md) to run an example code with different SDKs to see what Milvus can do.
 
 - Learn the basic operations of Milvus:
-  - [Connect to Milvus server](connect.md)
+  - [Connect to Milvus server](manage_connection.md)
   - [Conduct a vector search](search.md)
   - [Conduct a hybrid search](hybridsearch.md)
 

diff --git a/site/en/getstarted/cluster/install_cluster-milvusoperator.md b/site/en/getstarted/cluster/install_cluster-milvusoperator.md
@@ -478,7 +478,7 @@ my-release-pulsar-zookeeper-1                   1/1     Running     0          1
 my-release-pulsar-zookeeper-2                   1/1     Running     0          13m
 ```
 
-When the Milvus cluster is installed, you can learn how to [Connect to Milvus server](connect.md)
+When the Milvus cluster is installed, you can learn how to [Connect to Milvus server](manage_connection.md)
 
 ## Uninstall the Milvus cluster
 
@@ -509,7 +509,7 @@ If you use kind to install the K8s cluster, run $ kind delete cluster --name myk
 Having installed Milvus, you can:
 - Check [Hello Milvus](example_code.md) to run an example code with different SDKs to see what Milvus can do.
 - Learn the basic operations of Milvus:
-  - [Connect to Milvus server](connect.md)
+  - [Connect to Milvus server](manage_connection.md)
   - [Conduct a vector search](search.md)
   - [Conduct a hybrid search](hybridsearch.md)
 - [Upgrade Milvus Using Helm Chart](upgrade.md).

diff --git a/site/en/getstarted/install-node.md b/site/en/getstarted/install-node.md
@@ -32,7 +32,7 @@ $ npm install @zilliz/milvus2-sdk-node
 Having installed Milvus Node.js SDK, you can:
 
 - Learn the basic operations of Milvus:
-  - [Connect to Milvus server](connect.md)
+  - [Connect to Milvus server](manage_connection.md)
   - [Conduct a vector search](search.md)
   - [Conduct a hybrid search](hybridsearch.md)
 

diff --git a/site/en/getstarted/install-pymilvus.md b/site/en/getstarted/install-pymilvus.md
@@ -46,7 +46,7 @@ $ python -c "from pymilvus import Collection"
 Having installed PyMilvus, you can:
 
 - Learn the basic operations of Milvus:
-  - [Connect to Milvus server](connect.md)
+  - [Connect to Milvus server](manage_connection.md)
   - [Conduct a vector search](search.md)
   - [Conduct a hybrid search](hybridsearch.md)
 

diff --git a/site/en/getstarted/install_offline-docker.md b/site/en/getstarted/install_offline-docker.md
@@ -83,7 +83,7 @@ Having installed Milvus, you can:
 - Check [Hello Milvus](example_code.md) to run an example code with different SDKs to see what Milvus can do.
 
 - Learn the basic operations of Milvus:
-  - [Connect to Milvus server](connect.md)
+  - [Connect to Milvus server](manage_connection.md)
   - [Conduct a vector search](search.md)
   - [Conduct a hybrid search](hybridsearch.md)
 

diff --git a/site/en/getstarted/install_offline-helm.md b/site/en/getstarted/install_offline-helm.md
@@ -87,7 +87,7 @@ Having installed Milvus, you can:
 - Check [Hello Milvus](example_code.md) to run an example code with different SDKs to see what Milvus can do.
 
 - Learn the basic operations of Milvus:
-  - [Connect to Milvus server](connect.md)
+  - [Connect to Milvus server](manage_connection.md)
   - [Conduct a vector search](search.md)
   - [Conduct a hybrid search](hybridsearch.md)
 

diff --git a/site/en/getstarted/standalone/install_standalone-docker.md b/site/en/getstarted/standalone/install_standalone-docker.md
@@ -85,7 +85,7 @@ Having installed Milvus, you can:
 - Check [Hello Milvus](example_code.md) to run an example code with different SDKs to see what Milvus can do.
 
 - Learn the basic operations of Milvus:
-  - [Connect to Milvus server](connect.md)
+  - [Connect to Milvus server](manage_connection.md)
   - [Conduct a vector search](search.md)
   - [Conduct a hybrid search](hybridsearch.md)
 

diff --git a/site/en/getstarted/standalone/install_standalone-helm.md b/site/en/getstarted/standalone/install_standalone-helm.md
@@ -127,7 +127,7 @@ Having installed Milvus, you can:
 - Check [Hello Milvus](example_code.md) to run an example code with different SDKs to see what Milvus can do.
 
 - Learn the basic operations of Milvus:
-  - [Connect to Milvus server](connect.md)
+  - [Connect to Milvus server](manage_connection.md)
   - [Conduct a vector search](search.md)
   - [Conduct a hybrid search](hybridsearch.md)
 

diff --git a/site/en/home/home.json b/site/en/home/home.json
@@ -28,7 +28,7 @@
     "order": -1,
     "title": "Welcome to Milvus Documentation! ",
     "desc": [
-      "Here you will learn about <a href='overview.md'>what Milvus is</a>, and how to <a href='install_standalone-docker.md'>install</a>, <a href='connect.md'>use</a>, and <a href='aws.md'>deploy</a> Milvus to build an <a href='image_similarity_search.md'>application</a> according to your business need. You will also find <a href='performance_faq.md'>FAQs</a> and <a href='api-reference/pymilvus/v2.0.0rc6/api/collection.html'>API references</a> here.",
+      "Here you will learn about <a href='overview.md'>what Milvus is</a>, and how to <a href='install_standalone-docker.md'>install</a>, <a href='manage_connection.md'>use</a>, and <a href='aws.md'>deploy</a> Milvus to build an <a href='image_similarity_search.md'>application</a> according to your business need. You will also find <a href='performance_faq.md'>FAQs</a> and <a href='api-reference/pymilvus/v2.0.0rc6/api/collection.html'>API references</a> here.",
       "You can start by browsing the recomended contents below or using the search box at the top left to search across the documentation. If you do not find the information you are looking for, feel free to ask <i>MilMil</i> at the bottom right or submit an issue via GitHub by using the buttons at the top right of each page."
     ]
   },
@@ -38,15 +38,15 @@
         "label": "Use",
         "list": [{
             "text": "Create a Collection",
-            "link": "create.md"
+            "link": "manage_collection.md"
           },
           {
             "text": "Insert Data",
-            "link": "insert.md"
+            "link": "manage_data.md"
           },
           {
             "text": "Build an Index",
-            "link": "build.md"
+            "link": "manage_index.md"
           },
           {
             "text": "Vector Similarity Search",

diff --git a/site/en/home/home.md b/site/en/home/home.md
@@ -4,7 +4,9 @@ id: home.md
 
 # Welcome to Milvus Docs!
 
-Here you will learn about [what Milvus is](overview.md), and how to [install](install_standalone-docker.md), [use](connect.md), and [deploy](aws.md) Milvus to build an [application](image_similarity_search.md) according to your business need. You will also find [FAQs](performance_faq.md) and [API references](https://milvus.io/api-reference/pymilvus/v2.0.0rc8/api/collection.html) here.
+
+Here you will learn about [what Milvus is](overview.md), and how to [install](install_standalone-docker.md), [use](manage_connection.md), and [deploy](aws.md) Milvus to build an [application](image_similarity_search.md) according to your business need. You will also find [FAQs](performance_faq.md) and [API references](https://milvus.io/api-reference/pymilvus/v2.0.0rc8/api/collection.html) here.
+
 
 You can start by browsing the recomended contents below or using the search box at the top left to search across the documentation. If you do not find the information you are looking for, feel free to ask _MilMil_![MilMil](../../../assets/icon_bird.svg) at the bottom right or submit an issue via GitHub by using the buttons at the top right of each page.
 
@@ -45,9 +47,9 @@ You can start by browsing the recomended contents below or using the search box
 <div class="recomment-item">
   <p>Use</p>
 
-- [Create a Collection](create.md)
-- [Insert Data](insert.md)
-- [Build an Index](build.md)
+- [Create a Collection](manage_collection.md)
+- [Insert Data](manage_data.md)
+- [Build an Index](manage_index.md)
 - [Vector Similarity Search](search.md)
 - [Query](query.md)
 </div>

diff --git a/site/en/menuStructure/en.json b/site/en/menuStructure/en.json
@@ -151,60 +151,52 @@
       "isMenu": true
     },
     {
-      "id": "connect.md",
-      "title": "Connect to Milvus Server",
+      "id": "manage_connection.md",
+      "title": "Manage Milvus Connections",
       "label1": "userguide",
       "label2": "",
       "label3": "",
       "order": 0
     },
     {
-      "id": "create.md",
-      "title": "Create a Collection or Partition",
+      "id": "manage_collection.md",
+      "title": "Manage Collections",
       "label1": "userguide",
       "label2": "",
       "label3": "",
       "order": 1
     },
     {
-      "id": "insert.md",
-      "title": "Insert Data",
+      "id": "manage_partition.md",
+      "title": "Manage Partitions",
       "label1": "userguide",
       "label2": "",
       "label3": "",
       "order": 2
     },
     {
-      "id": "build.md",
-      "title": "Build an Index",
+      "id": "manage_data.md",
+      "title": "Manage Data",
       "label1": "userguide",
       "label2": "",
       "label3": "",
       "order": 3
     },
     {
-      "id": "drop.md",
-      "title": "Drop Collection/Partition/Index",
+      "id": "manage_index.md",
+      "title": "Manage Indexes",
       "label1": "userguide",
       "label2": "",
       "label3": "",
       "order": 4
     },
-    {
-      "id": "delete.md",
-      "title": "Delete an Entity",
-      "label1": "userguide",
-      "label2": "",
-      "label3": "",
-      "order": 5
-    },
     {
       "id": "search",
       "title": "Search and Query",
       "label1": "userguide",
       "label2": "",
       "label3": "",
-      "order": 6,
+      "order": 5,
       "isMenu": true
     },
     {
@@ -229,6 +221,14 @@
       "label1": "userguide",
       "label2": "search",
       "label3": "",
+      "order": 2
+    },
+    {
+      "id": "timetravel.md",
+      "title": "Search with Time Travel",
+      "label1": "userguide",
+      "label2": "search",
+      "label3": "",
       "order": 3
     },
     {

diff --git a/site/en/reference/schema/collection_schema.md b/site/en/reference/schema/collection_schema.md
@@ -5,7 +5,7 @@ summary: Learn how to define a collection schema in Milvus.
 
 # Collection Schema
 
-A collection schema is the logical definition of a collection. Usually you need to define the [field schema](field_schema.md) before defining a collection schema and [creating a collection](create.md). 
+A collection schema is the logical definition of a collection. Usually you need to define the [field schema](field_schema.md) before defining a collection schema and [creating a collection](manage_collection.md). 
 
 
 ## Collection schema properties

diff --git a/site/en/reference/schema/field_schema.md b/site/en/reference/schema/field_schema.md
@@ -5,7 +5,7 @@ summary: Learn how to define a field schema in Milvus.
 
 # Field Schema
 
-A field schema is the logical definition of a field. It is the first thing you need to define before defining a [collection schema](collection_schema.md) and [creating a collection](create.md). 
+A field schema is the logical definition of a field. It is the first thing you need to define before defining a [collection schema](collection_schema.md) and [creating a collection](manage_collection.md). 
 
 Milvus 2.0 supports a primary key field, a scalar field, and a vector field in a collection.
 

diff --git a/site/en/userGuide/build.md b/site/en/userGuide/build.md