feat: support i18n

milvus-io · Aug 23, 2024 · b237b8b · b237b8b
1 parent b1d3982
commit b237b8b
Show file tree

Hide file tree

Showing 17 changed files with 128 additions and 71 deletions.
diff --git a/.github/workflows/ci-i18n.yml b/.github/workflows/ci-i18n.yml
@@ -0,0 +1,57 @@
+name: ci-i18n
+
+on:
+  push:
+    branches:
+      - feat/v2.4.x-i18n
+    # paths:
+    #   - "site/zh/**"
+  release:
+    types: [released]
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build "
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v1
+        with:
+          ref: feat/v2.4.x-i18n
+
+      - name: Extract branch name
+        shell: bash
+        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+        id: extract_branch
+
+      - name: Md2md
+        run: |
+          cp site/en/Variables.json ./
+          mv site doc_from
+          sudo npm install @zilliz/mdtomd -g
+          goover
+          rm -rf doc_from/*
+          rm check-link.js
+          mv doc_to site
+
+      - name: Delete And Push
+        run: |
+          sudo apt-get update
+          sudo apt-get install jq
+          cd ../
+          git clone -b feat/localization https://.:${{ secrets.P_GITHUB_TOKEN }}@github.com/milvus-io/web-content.git target
+          git config --global user.email "[email protected]"
+          git config --global user.name "Milvus-doc-bot"
+          cp ./milvus-docs/version.json ./target
+          cd target
+          rm -rf `cat version.json | jq -r .version`
+          mkdir `cat version.json | jq -r .version`
+          cp -avr ../milvus-docs/** ./`cat version.json | jq -r .version`
+          git add .
+          git commit -m "Release new docs "
+          git push -f origin feat/localization
diff --git a/site/en/about/comparison.md b/site/en/about/comparison.md
@@ -52,7 +52,7 @@ Although both serve similar functions as vector databases, the domain-specific t
 | Deployment Modes | SaaS-only | Milvus Lite, On-prem Standalone & Cluster,  Zilliz Cloud Saas & BYOC |
 | Embedding Functions | Not available	 | Support with <a href="https://github.com/milvus-io/milvus-model">pymilvus[model]</a> |
 | Data Types | String, Number, Bool, List of String | String, VarChar, Number (Int, Float, Double), Bool, Array, JSON, Float Vector, Binary Vector, BFloat16, Float16, Sparse Vector |
-| Metric and Index Types | Cos, Dot, Euclidean<br>P-family, S-family | Cosine, IP (Dot), L2 (Euclidean),  Hamming, Jaccard<br>FLAT, IVF_FLAT, IVF_SQ8, IVF_PQ, HNSW, SCANN, GPU Indexes |
+| Metric and Index Types | Cos, Dot, Euclidean<br/>P-family, S-family | Cosine, IP (Dot), L2 (Euclidean),  Hamming, Jaccard<br/>FLAT, IVF_FLAT, IVF_SQ8, IVF_PQ, HNSW, SCANN, GPU Indexes |
 | Schema Design | Flexible mode | Flexible mode, Strict mode |
 | Multiple Vector Fields | N/A | Multi-vector and hybrid search |
 | Tools | Datasets, text utilities, spark connector | Attu, Birdwatcher, Backup, CLI, CDC, Spark and Kafka connectors |

diff --git a/site/en/about/roadmap.md b/site/en/about/roadmap.md
@@ -22,28 +22,28 @@ Welcome to the Milvus Roadmap! Join us on our continuous journey to enhance and
     </thead>
     <tbody>
         <tr>
-            <td><strong>AI-developer Friendly</strong><br><i>A developer-friendly technology stack, enhanced with the latest AI innovations</i></td>
-            <td><strong>Multi-Vectors & Hybrid Search</strong><br><i>Framework for multiplex recall and fusion</i><br><br><strong>GPU Index Acceleration</strong><br><i>Support for higher QPS and faster index creation</i><br><br><strong>Model Library in PyMilvus</strong><br><i>Integrated embedding models for Milvus</i></td>
-            <td><strong>Sparse Vector (GA)</strong><br><i>Local feature extraction and keyword search</i><br><br><strong>Milvus Lite (GA)</strong><br><i>A lightweight, in-memory version of Milvus</i><br><br><strong>Embedding Models Gallery</strong><br><i>Support for image and multi-modal embeddings and reranker models in model libraries</i></td>
-            <td><strong>Original Data-In and Data-Out</strong><br><i>Support for Blob data types</i><br><br><strong>Data Clustering</strong><br><i>Data co-locality</i><br><br><strong>Scenario-oriented Vector Search</strong><br><i>e.g. Multi-target search & NN filtering</i><br><br><strong>Support Embedding & Reranker Endpoint</strong></td>
+            <td><strong>AI-developer Friendly</strong><br/><i>A developer-friendly technology stack, enhanced with the latest AI innovations</i></td>
+            <td><strong>Multi-Vectors & Hybrid Search</strong><br/><i>Framework for multiplex recall and fusion</i><br/><br/><strong>GPU Index Acceleration</strong><br/><i>Support for higher QPS and faster index creation</i><br/><br/><strong>Model Library in PyMilvus</strong><br/><i>Integrated embedding models for Milvus</i></td>
+            <td><strong>Sparse Vector (GA)</strong><br/><i>Local feature extraction and keyword search</i><br/><br/><strong>Milvus Lite (GA)</strong><br/><i>A lightweight, in-memory version of Milvus</i><br/><br/><strong>Embedding Models Gallery</strong><br/><i>Support for image and multi-modal embeddings and reranker models in model libraries</i></td>
+            <td><strong>Original Data-In and Data-Out</strong><br/><i>Support for Blob data types</i><br/><br/><strong>Data Clustering</strong><br/><i>Data co-locality</i><br/><br/><strong>Scenario-oriented Vector Search</strong><br/><i>e.g. Multi-target search & NN filtering</i><br/><br/><strong>Support Embedding & Reranker Endpoint</strong></td>
         </tr>
         <tr>
-            <td><strong>Rich Functionality</strong><br><i>Enhanced retrieval and data management features</i></td>
-            <td><strong>Support for FP16, BF16 Datatypes</strong><br><i>These ML datatypes can help reduce memory usage</i><br><br><strong>Grouping Search</strong><br><i>Aggregate split embeddings</i><br><br><strong>Fuzzy Match and Inverted Index</strong><br><i>Support for fuzzy matching and inverted indexing for scalar types like varchar and int</i></td>
-            <td><strong>Inverted Index for Array & JSON</strong><br><i>Indexing for array and partial support JSON</i><br><br><strong>Bitset Index</strong><br><i>Improved execution speed and future data aggregation</i><br><br><strong>Truncate Collection</strong><br><i>Allows data clearance while preserving metadata</i><br><br><strong>Support for NULL and Default Values</strong></td>
-            <td><strong>Support for More Datatypes</strong><br><i>e.g. Datetime, GIS</i><br><br><strong>Advanced Text Filtering</strong><br><i>e.g. Match Phrase</i><br><br><strong>Primary Key Deduplication</strong></td>
+            <td><strong>Rich Functionality</strong><br/><i>Enhanced retrieval and data management features</i></td>
+            <td><strong>Support for FP16, BF16 Datatypes</strong><br/><i>These ML datatypes can help reduce memory usage</i><br/><br/><strong>Grouping Search</strong><br/><i>Aggregate split embeddings</i><br/><br/><strong>Fuzzy Match and Inverted Index</strong><br/><i>Support for fuzzy matching and inverted indexing for scalar types like varchar and int</i></td>
+            <td><strong>Inverted Index for Array & JSON</strong><br/><i>Indexing for array and partial support JSON</i><br/><br/><strong>Bitset Index</strong><br/><i>Improved execution speed and future data aggregation</i><br/><br/><strong>Truncate Collection</strong><br/><i>Allows data clearance while preserving metadata</i><br/><br/><strong>Support for NULL and Default Values</strong></td>
+            <td><strong>Support for More Datatypes</strong><br/><i>e.g. Datetime, GIS</i><br/><br/><strong>Advanced Text Filtering</strong><br/><i>e.g. Match Phrase</i><br/><br/><strong>Primary Key Deduplication</strong></td>
         </tr>
         <tr>
-            <td><strong>Cost Efficiency & Architecture</strong><br><i>Advanced systems emphasizing stability, cost efficiency, scalability, and performance</i></td>
-            <td><strong>Support for More Collections/Partitions</strong><br><i>Handles over 10,000 collections in smaller clusters</i><br><br><strong>Mmap Optimization</strong><br><i>Balances reduced memory consumption with latency</i><br><br><strong>Bulk Insert Optimazation</strong><br><i>Simplifies importing large datasets</i></td>
-            <td><strong>Lazy Load</strong><br><i>Data is loaded on-demand through read operations</i><br><br><strong>Major Compaction</strong><br><i>Re-distributes data based on configuration to enhance read performance</i><br><br><strong>Mmap for Growing Data</strong><br><i>Mmap files for expanding data segments</i></td>
-            <td><strong>Memory Control</strong><br><i>Reduces out-of-memory issues and provides global memory management</i><br><br><strong>LogNode Introduction</strong><br><i>Ensures global consistency and addresses the single-point bottleneck in root coordination</i><br><br><strong>Storage Format V2</strong><br><i>Universal format design lays the groundwork for disk-based data access</i></td>
+            <td><strong>Cost Efficiency & Architecture</strong><br/><i>Advanced systems emphasizing stability, cost efficiency, scalability, and performance</i></td>
+            <td><strong>Support for More Collections/Partitions</strong><br/><i>Handles over 10,000 collections in smaller clusters</i><br/><br/><strong>Mmap Optimization</strong><br/><i>Balances reduced memory consumption with latency</i><br/><br/><strong>Bulk Insert Optimazation</strong><br/><i>Simplifies importing large datasets</i></td>
+            <td><strong>Lazy Load</strong><br/><i>Data is loaded on-demand through read operations</i><br/><br/><strong>Major Compaction</strong><br/><i>Re-distributes data based on configuration to enhance read performance</i><br/><br/><strong>Mmap for Growing Data</strong><br/><i>Mmap files for expanding data segments</i></td>
+            <td><strong>Memory Control</strong><br/><i>Reduces out-of-memory issues and provides global memory management</i><br/><br/><strong>LogNode Introduction</strong><br/><i>Ensures global consistency and addresses the single-point bottleneck in root coordination</i><br/><br/><strong>Storage Format V2</strong><br/><i>Universal format design lays the groundwork for disk-based data access</i></td>
         </tr>
         <tr>
-            <td><strong>Enterprise Ready</strong><br><i>Designed to meet the needs of enterprise production environments</i></td>
-            <td><strong>Milvus CDC</strong><br><i>Capability for data replication</i><br><br><strong>Accesslog Enhancement</strong><br><i>Detailed recording for audit and tracing</i></td>
-            <td><strong>New Resource Group</strong><br><i>Enhanced resource management</i><br><br><strong>Storage Hook</strong><br><i>Support for Bring Your Own Key (BYOK) encryption</i></td>
-            <td><strong>Dynamic Replica Number Adjustment</strong><br><i>Facilitates dynamic changes to the number of replicas</i><br><br><strong>Dynamic Schema Modification</strong><br><i>e.g., Add/delete fields, modify varchar lengths</i><br><br><strong>Rust and C# SDKs</strong></td>
+            <td><strong>Enterprise Ready</strong><br/><i>Designed to meet the needs of enterprise production environments</i></td>
+            <td><strong>Milvus CDC</strong><br/><i>Capability for data replication</i><br/><br/><strong>Accesslog Enhancement</strong><br/><i>Detailed recording for audit and tracing</i></td>
+            <td><strong>New Resource Group</strong><br/><i>Enhanced resource management</i><br/><br/><strong>Storage Hook</strong><br/><i>Support for Bring Your Own Key (BYOK) encryption</i></td>
+            <td><strong>Dynamic Replica Number Adjustment</strong><br/><i>Facilitates dynamic changes to the number of replicas</i><br/><br/><strong>Dynamic Schema Modification</strong><br/><i>e.g., Add/delete fields, modify varchar lengths</i><br/><br/><strong>Rust and C# SDKs</strong></td>
         </tr>
     </tbody>
 </table>

diff --git a/site/en/adminGuide/deploy_etcd.md b/site/en/adminGuide/deploy_etcd.md
@@ -50,7 +50,7 @@ Run the following command to start Milvus that uses the etcd configurations.
 docker compose up
 ```
 
-<div class="alert note">Configurations only take effect after Milvus starts. See <a href=https://milvus.io/docs/install_standalone-docker.md#Start-Milvus>Start Milvus</a> for more information.</div>
+<div class="alert note">Configurations only take effect after Milvus starts. See <a href="https://milvus.io/docs/install_standalone-docker.md#Start-Milvus">Start Milvus</a> for more information.</div>
 
 ## Configure etcd on K8s
 

diff --git a/site/en/adminGuide/deploy_pulsar.md b/site/en/adminGuide/deploy_pulsar.md
@@ -34,7 +34,7 @@ Run the following command to start Milvus that uses the Pulsar configurations.
 docker compose up
 ```
 
-<div class="alert note">Configurations only take effect after Milvus starts. See <a href=https://milvus.io/docs/install_standalone-docker.md#Start-Milvus>Start Milvus</a> for more information.</div>
+<div class="alert note">Configurations only take effect after Milvus starts. See <a href="https://milvus.io/docs/install_standalone-docker.md#Start-Milvus">Start Milvus</a> for more information.</div>
 
 
 ## Configure Pulsar with Helm

diff --git a/site/en/adminGuide/deploy_s3.md b/site/en/adminGuide/deploy_s3.md
@@ -35,7 +35,7 @@ Run the following command to start Milvus that uses the S3 configurations.
 ```shell
 docker compose up
 ```
-<div class="alert note">Configurations only take effect after Milvus starts. See <a href=https://milvus.io/docs/install_standalone-docker.md#Start-Milvus>Start Milvus</a> for more information.</div>
+<div class="alert note">Configurations only take effect after Milvus starts. See <a href="https://milvus.io/docs/install_standalone-docker.md#Start-Milvus">Start Milvus</a> for more information.</div>
 
 ## Configure S3 on K8s
 

diff --git a/site/en/adminGuide/rbac.md b/site/en/adminGuide/rbac.md
@@ -58,7 +58,7 @@ client.update_password(
 ```python
 client.list_users()
 
-# output:
+# output
 # ['root', 'user_1']
 ```
 
@@ -67,7 +67,7 @@ client.list_users()
 ```python
 client.describe_user(user_name='user_1')
 
-# output:
+# output
 # {'user_name': 'user_1', 'roles': ()}
 ```
 
@@ -88,7 +88,7 @@ After creating a role, you can:
 ```python
 client.list_roles()
 
-# output:
+# output
 # ['admin', 'public', 'roleA']
 ```
 
@@ -120,7 +120,7 @@ client.describe_role(
     role_name='roleA'
 )
 
-# output:
+# output
 # {'role': 'roleA',
 #  'privileges': [{'object_type': 'User',
 #    'object_name': 'user_1',
@@ -150,8 +150,8 @@ client.describe_user(
     user_name='user_1'
 )
 
-# output:
-# {'user_name': 'user_1', 'roles': ('roleA',)}
+# output
+# {'user_name': 'user_1', 'roles': ('roleA')}
 ```
 
 ## 6. Revoke privileges

diff --git a/site/en/getstarted/run-milvus-gpu/install_cluster-helm-gpu.md b/site/en/getstarted/run-milvus-gpu/install_cluster-helm-gpu.md
@@ -174,7 +174,7 @@ In addition to a single GPU device, you can also assign multiple GPU devices to
     <ul>
       <li>The release name should only contain letters, numbers and dashes. Dots are not allowed in the release name.</li>
       <li>The default command line installs cluster version of Milvus while installing Milvus with Helm. Further setting is needed while installing Milvus standalone.</li>
-      <li>According to the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">deprecated API migration guide of Kuberenetes</a>, the <b>policy/v1beta1</b> API version of PodDisruptionBudget is not longer served as of v1.25. You are suggested to migrate manifests and API clients to use the <b>policy/v1</b> API version instead. <br>As a workaround for users who still use the <b>policy/v1beta1</b> API version of PodDisruptionBudget on Kuberenetes v1.25 and later, you can instead run the following command to install Milvus:<br>
+      <li>According to the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">deprecated API migration guide of Kuberenetes</a>, the <b>policy/v1beta1</b> API version of PodDisruptionBudget is not longer served as of v1.25. You are suggested to migrate manifests and API clients to use the <b>policy/v1</b> API version instead. <br/>As a workaround for users who still use the <b>policy/v1beta1</b> API version of PodDisruptionBudget on Kuberenetes v1.25 and later, you can instead run the following command to install Milvus:<br/>
       <code>helm install my-release milvus/milvus --set pulsar.bookkeeper.pdb.usePolicy=false,pulsar.broker.pdb.usePolicy=false,pulsar.proxy.pdb.usePolicy=false,pulsar.zookeeper.pdb.usePolicy=false</code></li> 
       <li>See <a href="https://artifacthub.io/packages/helm/milvus/milvus">Milvus Helm Chart</a> and <a href="https://helm.sh/docs/">Helm</a> for more information.</li>
     </ul>

diff --git a/site/en/getstarted/run-milvus-k8s/install_cluster-helm.md b/site/en/getstarted/run-milvus-k8s/install_cluster-helm.md
@@ -85,7 +85,7 @@ The command above deploys a Milvus cluster with its components and dependencies
   <ul>
     <li>The release name should only contain letters, numbers and dashes. Dots are not allowed in the release name.</li>
     <li>The default command line installs cluster version of Milvus while installing Milvus with Helm. Further setting is needed while installing Milvus standalone.</li>
-    <li>According to the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">deprecated API migration guide of Kubernetes</a>, the <b>policy/v1beta1</b> API version of PodDisruptionBudget is no longer served as of v1.25. You are suggested to migrate manifests and API clients to use the <b>policy/v1</b> API version instead. <br>As a workaround for users who still use the <b>policy/v1beta1</b> API version of PodDisruptionBudget on Kubernetes v1.25 and later, you can instead run the following command to install Milvus:<br>
+    <li>According to the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">deprecated API migration guide of Kubernetes</a>, the <b>policy/v1beta1</b> API version of PodDisruptionBudget is no longer served as of v1.25. You are suggested to migrate manifests and API clients to use the <b>policy/v1</b> API version instead. <br/>As a workaround for users who still use the <b>policy/v1beta1</b> API version of PodDisruptionBudget on Kubernetes v1.25 and later, you can instead run the following command to install Milvus:<br/>
     <code>helm install my-release milvus/milvus --set pulsar.bookkeeper.pdb.usePolicy=false,pulsar.broker.pdb.usePolicy=false,pulsar.proxy.pdb.usePolicy=false,pulsar.zookeeper.pdb.usePolicy=false</code></li> 
     <li>See <a href="https://artifacthub.io/packages/helm/milvus/milvus">Milvus Helm Chart</a> and <a href="https://helm.sh/docs/">Helm</a> for more information.</li>
   </ul>

diff --git a/site/en/home/home.md b/site/en/home/home.md
@@ -33,23 +33,23 @@ id: home.md
 <div class="start_card_container">
   <a href="install_standalone-docker.md">
     <img  src="../../../assets/home_install.svg" alt="icon" />
-    <p class="link-btn">Install Milvus <i class="fas fa-chevron-right"></i></p>
+    <p class="link-btn">Install Milvus</p>
   </a>
   <p>Learn how to install Milvus using either Docker Compose or on Kubernetes.</p>
 </div>
 
 <div class="start_card_container">
   <a href="quickstart.md">
     <img  src="../../../assets/home_quick_start.svg" alt="icon" />
-    <p class="link-btn">Quick Start <i class="fas fa-chevron-right"></i></p>
+    <p class="link-btn">Quick Start</p>
   </a>
   <p>Learn how to quickly run Milvus with sample code.</p>
 </div>
 
 <div class="start_card_container">
   <a href="/bootcamp">
     <img  src="../../../assets/home_bootcamp.svg" alt="icon" />
-    <p class="link-btn">Bootcamp <i class="fas fa-chevron-right"></i></p>
+    <p class="link-btn">Bootcamp</p>
   </a>
   <p>
   Learn how to build vector similarity search applications with Milvus.

diff --git a/site/en/migrate/es2m.md b/site/en/migrate/es2m.md
@@ -118,7 +118,7 @@ The following table describes the parameters in the example config file. For a f
 
     | Parameter | Description |
     | --- | --- |
-    | `target.mode` | Storage location for dumped files. Valid values:<br>- `local`: Store dumped files on local disks.<br>- `remote`: Store dumped files on object storage. |
+    | `target.mode` | Storage location for dumped files. Valid values:<br/>- `local`: Store dumped files on local disks.<br/>- `remote`: Store dumped files on object storage. |
     | `target.remote.outputDir` | Output directory path in the cloud storage bucket. |
     | `target.remote.cloud` | Cloud storage service provider. Example values: `aws`, `gcp`, `azure`. |
     | `target.remote.region` | Cloud storage region. It can be any value if you use local MinIO. |