Add entry for sdk (#2539)

* add * Update 6.eco-tool-version.md * Update list * Update 6.eco-tool-version.md * Update * Update 1.nebula-client.md * Update title
vesoft-inc · Apr 15, 2024 · 11794b4 · 11794b4
1 parent e66ede6
commit 11794b4
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 80 deletions.
diff --git a/docs-2.0-en/14.client/1.nebula-client.md b/docs-2.0-en/14.client/1.nebula-client.md
@@ -19,16 +19,4 @@ NebulaGraph supports multiple types of clients for users to connect to and manag
     -  NebulaPool and SessionPool in NebulaGraph Java
     -  ConnectionPool and SessionPool in NebulaGraph Go
 
-!!! caution
-
-    The following clients can also be used to connect to and manage NebulaGraph, but there is no uptime guarantee.
-
-    - [NebulaGraph PHP](https://github.com/nebula-contrib/nebula-php) 
-    - [NebulaGraph Node](https://github.com/nebula-contrib/nebula-node)
-    - [NebulaGraph .net](https://github.com/nebula-contrib/nebula-net)
-    - [NebulaGraph JDBC](https://github.com/nebula-contrib/nebula-jdbc)
-    - [NebulaGraph Carina（Python ORM）](https://github.com/nebula-contrib/nebula-carina)
-    - [NORM (Golang ORM)](https://github.com/zhihu/norm)
-    - [Graph-Ocean (Java ORM)](https://github.com/nebula-contrib/graph-ocean)
-    - [NebulaGraph Ngbatis (Java ORM in a MyBatis fashion)](https://github.com/nebula-contrib/ngbatis)
-    - [Jupyter NebulaGraph Extension](https://jupyter-nebulagraph.readthedocs.io/)
+
diff --git a/docs-2.0-en/14.client/contributed-clients.md b/docs-2.0-en/14.client/contributed-clients.md
@@ -0,0 +1,8 @@
+# Community contributed clients
+
+You can use the following clients developed by community users to connect to and manage NebulaGraph:
+
+- [NebulaGraph Rust](https://github.com/vesoft-inc/nebula-rust)
+- [NebulaGraph PHP](https://github.com/nebula-contrib/nebula-php) 
+- [NebulaGraph Node](https://github.com/nebula-contrib/nebula-node)
+- [NebulaGraph .NET](https://github.com/nebula-contrib/nebula-net)
diff --git a/docs-2.0-en/20.appendix/6.eco-tool-version.md b/docs-2.0-en/20.appendix/6.eco-tool-version.md
@@ -117,33 +117,37 @@ Docker Compose can quickly deploy NebulaGraph clusters. For how to use it, pleas
 | {{ nebula.tag }}| [Java](https://github.com/vesoft-inc/nebula-java/releases/tag/{{java.tag}})  |
 | {{ nebula.tag }}| [HTTP](https://github.com/vesoft-inc/nebula-http-gateway/releases/tag/{{gateway.tag}})  |
 
-## Other utilities and tools
-
-The following are useful utilities and tools contributed and maintained by community users.
-* ORM
-    * Spring Boot-based ORM: [NGBATIS](https://github.com/nebula-contrib/ngbatis)
-    * Swagger Springboot Demo: [nebula-swagger-demo](https://github.com/nebula-contrib/nebula-swagger-demo)
-    * Java ORM: [graph-ocean](https://github.com/nebula-contrib/graph-ocean)
-    * JDBC Connector: [nebula-jdbc](https://github.com/nebula-contrib/nebula-jdbc)
-    * Python ORM: [nebula-carina](https://github.com/nebula-contrib/nebula-carina)
-    * Golang ORM: [norm](https://github.com/nebula-contrib/norm)
-* Data processing
-    * Stream ETL: [nebula-real-time-exchange](https://github.com/nebula-contrib/nebula-real-time-exchange)
-    * DataX Plugin: [nebula-datax-plugin](https://github.com/nebula-contrib/nebula-datax-plugin)
-* Backend services
-    * Infrastructure services:[graph-gateway](https://github.com/nebula-contrib/graph-gateway)
-* Quick deployment
-    * Getting started with NebulaGraph in Docker Desktop: [nebulagraph-docker-ext](https://github.com/nebula-contrib/nebulagraph-docker-ext)
-    * Running NebulaGraph in a browser: [nebulagraph-lite](https://github.com/nebula-contrib/nebulagraph-lite)
-* Testing
-    * Java testing library: [testcontainers-nebula](https://github.com/nebula-contrib/testcontainers-nebula)
-* Clients
-    * Scala client: [zio-nebula](https://github.com/nebula-contrib/zio-nebula)
-    * Node.js client: [nebula-node](https://github.com/nebula-contrib/nebula-node)
-    * PHP client: [nebula-php](https://github.com/nebula-contrib/nebula-php)
-    * .NET client: [nebula-net](https://github.com/nebula-contrib/nebula-net)
-* Terminal 
-    * Nebula-console plugin for JetBrains IDEs: [nebula-console-intellij-plugin](https://github.com/nebula-contrib/nebula-console-intellij-plugin)
 
+## Community contributed tools
 
 
+The following are useful utilities and tools contributed and maintained by community users. 
+
+
+- Object Relational Mapping (ORM) frameworks
+  - [NGBATIS](https://github.com/nebula-contrib/ngbatis): An ORM framework that integrates with the Spring Boot ecosystem
+  - [graph-ocean](https://github.com/nebula-contrib/graph-ocean): An ORM framework developed based on NebulaGraph Java client
+  - [nebula-jdbc](https://github.com/nebula-contrib/nebula-jdbc): An ORM framework that supports JDBC  
+  - [nebula-carina](https://github.com/nebula-contrib/nebula-carina): An ORM framework developed based on NebulaGraph Python client
+  - [norm](https://github.com/nebula-contrib/norm): An ORM framework written in Golang
+
+- Data processing tools
+  - [nebula-real-time-exchange](https://github.com/nebula-contrib/nebula-real-time-exchange): Enables real-time data synchronization from MySQL to NebulaGraph
+  - [nebula-datax-plugin](https://github.com/nebula-contrib/nebula-datax-plugin): Provides NebulaGraph's Reader and Writer plugins based on DataX to enable offline data synchronization
+
+- Quick deployment
+  - [nebulagraph-docker-ext](https://github.com/nebula-contrib/nebulagraph-docker-ext): Starts NebulaGraph in Docker Desktop in 10 seconds
+  - [nebulagraph-lite](https://github.com/nebula-contrib/nebulagraph-lite): A NebulaGraph sandbox running in the browser
+
+- Testing
+  - [testcontainers-nebula](https://github.com/nebula-contrib/testcontainers-nebula): A lightweight database testing library for Java
+
+- Clients
+  - [zio-nebula](https://github.com/nebula-contrib/zio-nebula): Scala client
+  - [nebula-node](https://github.com/nebula-contrib/nebula-node): Node.js client
+  - [nebula-php](https://github.com/nebula-contrib/nebula-php): PHP client
+  - [nebula-net](https://github.com/nebula-contrib/nebula-net): .NET client
+  - [nebula-rust](https://github.com/vesoft-inc/nebula-rust): Rust client
+
+- Terminal tools
+  - [nebula-console-intellij-plugin](https://github.com/nebula-contrib/nebula-console-intellij-plugin): A Nebula-console plugin for JetBrains IDEs that supports syntax highlighting, function field auto-completion, data table pagination, and relationship graphs.
diff --git a/docs-2.0-zh/14.client/1.nebula-client.md b/docs-2.0-zh/14.client/1.nebula-client.md
@@ -18,17 +18,3 @@
 
     - NebulaGraph Java 客户端提供的 NebulaPool 和 SessionPool 
     - NebulaGraph Go 客户端提供的 ConnectionPool 和 SessionPool
-
-!!! caution
-
-    以下客户端工具也可用于连接和管理 {{nebula.name}} 。他们由非常酷的社区用户提供和维护，欢迎大家参与测试和贡献。
-
-    - [NebulaGraph PHP](https://github.com/nebula-contrib/nebula-php) 
-    - [NebulaGraph Node](https://github.com/nebula-contrib/nebula-node)
-    - [NebulaGraph .net](https://github.com/nebula-contrib/nebula-net)
-    - [NebulaGraph JDBC](https://github.com/nebula-contrib/nebula-jdbc)
-    - [NebulaGraph Carina（Python ORM）](https://github.com/nebula-contrib/nebula-carina)
-    - [NORM（Golang ORM）](https://github.com/zhihu/norm)
-    - [Graph-Ocean（Java ORM）](https://github.com/nebula-contrib/graph-ocean)
-    - [NebulaGraph Ngbatis（MyBatis 风格的 Java ORM）](https://github.com/nebula-contrib/ngbatis)
-    - [Jupyter NebulaGraph Extension](https://jupyter-nebulagraph.readthedocs.io/)
diff --git a/docs-2.0-zh/14.client/contributed-clients.md b/docs-2.0-zh/14.client/contributed-clients.md
@@ -0,0 +1,8 @@
+# 社区贡献的客户端
+
+你可以使用社区用户开发的以下客户端连接和管理 {{nebula.name}} 图数据库：
+
+- [NebulaGraph Rust](https://github.com/vesoft-inc/nebula-rust)
+- [NebulaGraph PHP](https://github.com/nebula-contrib/nebula-php) 
+- [NebulaGraph Node](https://github.com/nebula-contrib/nebula-node)
+- [NebulaGraph .NET](https://github.com/nebula-contrib/nebula-net)
diff --git a/docs-2.0-zh/20.appendix/6.eco-tool-version.md b/docs-2.0-zh/20.appendix/6.eco-tool-version.md
@@ -124,33 +124,36 @@ Docker Compose 可以快速部署 {{nebula.name}} 集群。如何使用请参见
 | {{ nebula.tag }}| [HTTP](https://github.com/vesoft-inc/nebula-http-gateway/releases/tag/{{gateway.tag}})  |
 
 
-## 其他工具
+## 社区贡献的工具
 
-这里罗列社区用户贡献的实用工具，各项目由其发起人及工具爱好者共同维护。
 
-* ORM
-    * Spring Boot 的数据库 ORM 框架：[NGBATIS](https://github.com/nebula-contrib/ngbatis)
-    * Swagger Springboot Demo：[nebula-swagger-demo](https://github.com/nebula-contrib/nebula-swagger-demo)
-    * Java ORM：[graph-ocean](https://github.com/nebula-contrib/graph-ocean)
-    * 对接 JDBC：[nebula-jdbc](https://github.com/nebula-contrib/nebula-jdbc)
-    * Python ORM：[nebula-carina](https://github.com/nebula-contrib/nebula-carina)
-    * Golang ORM：[norm](https://github.com/nebula-contrib/norm)
-* 数据工具
-    * Stream ETL：[nebula-real-time-exchange](https://github.com/nebula-contrib/nebula-real-time-exchange)
-    * 对接 DataX：[nebula-datax-plugin](https://github.com/nebula-contrib/nebula-datax-plugin)
-* 后端服务
-    * 基础服务工程：[graph-gateway](https://github.com/nebula-contrib/graph-gateway)
-* 轻便部署
-    * 10s 拉起 Docker 图库服务：[nebulagraph-docker-ext](https://github.com/nebula-contrib/nebulagraph-docker-ext)
-    * 一个运行在浏览器的 NebulaGraph 沙盒：[nebulagraph-lite](https://github.com/nebula-contrib/nebulagraph-lite)
-* 测试服务
-    * 轻量级的数据库 Java 测试库：[testcontainers-nebula](https://github.com/nebula-contrib/testcontainers-nebula)
-* 客户端
-    * Scala 客户端：[zio-nebula](https://github.com/nebula-contrib/zio-nebula)
-    * Node.js 客户端：[nebula-node](https://github.com/nebula-contrib/nebula-node)
-    * PHP 客户端：[nebula-php](https://github.com/nebula-contrib/nebula-php)
-    * .NET 客户端：[nebula-net](https://github.com/nebula-contrib/nebula-net)
-* 终端工具
-    * JetBrains IDE 系列 nebula-console 插件：[nebula-console-intellij-plugin](https://github.com/nebula-contrib/nebula-console-intellij-plugin)
+这里罗列社区用户贡献的实用工具，各项目由其发起人及工具爱好者共同维护。
 
+- ORM（Object Relational Mapping）框架
+  - [NGBATIS](https://github.com/nebula-contrib/ngbatis)：对接 Spring Boot 生态的数据库 ORM 框架
+  - [graph-ocean](https://github.com/nebula-contrib/graph-ocean)：基于 nebula-java 客户端的 ORM，详细介绍参见文稿[《隐藏在 graph-ocean 背后的星辰大海》](https://discuss.nebula-graph.com.cn/t/topic/8745)
+  - [nebula-jdbc](https://github.com/nebula-contrib/nebula-jdbc)：对接 JDBC 的 nebula-java 衍生品，详细介绍参见文稿[《NebulaGraph 支持 JDBC 协议》](https://discuss.nebula-graph.com.cn/t/topic/5657)
+  - [nebula-carina](https://github.com/nebula-contrib/nebula-carina)：基于 nebula-python 客户端的 ORM，详细介绍参见文稿[《NebulaGraph ORM 项目 Carina 简化 Web、AI 开发》](https://discuss.nebula-graph.com.cn/t/topic/12314)
+  - [norm](https://github.com/nebula-contrib/norm)：采用 Golang 编写的 ORM 项目，详细介绍参见文稿[《Norm 知乎开源的 ORM 利器》](https://discuss.nebula-graph.com.cn/t/topic/6423)
+
+- 数据工具
+  - [nebula-real-time-exchange](https://github.com/nebula-contrib/nebula-real-time-exchange)：支持 MySQL 到 NebulaGraph 的数据实时同步功能
+  - [nebula-datax-plugin](https://github.com/nebula-contrib/nebula-datax-plugin)：基于 DataX 实现的 NebulaGraph 的 Reader 和 Writer 插件，可方便用户离线实现数据同步
+
+- 轻便部署
+  - [nebulagraph-docker-ext](https://github.com/nebula-contrib/nebulagraph-docker-ext)：10s 拉起 Docker 图库服务
+  - [nebulagraph-lite](https://github.com/nebula-contrib/nebulagraph-lite)：一个运行在浏览器的 NebulaGraph 沙盒
+
+- 测试服务
+  - [testcontainers-nebula](https://github.com/nebula-contrib/testcontainers-nebula)：轻量级的数据库 Java 测试库
+
+- 客户端
+  - [zio-nebula](https://github.com/nebula-contrib/zio-nebula)：Scala 客户端
+  - [nebula-node](https://github.com/nebula-contrib/nebula-node)：Node.js 客户端
+  - [nebula-php](https://github.com/nebula-contrib/nebula-php)：PHP 客户端
+  - [nebula-net](https://github.com/nebula-contrib/nebula-net)：.NET 客户端
+  - [nebula-rust](https://github.com/vesoft-inc/nebula-rust)：Rust 客户端
+
+- 终端工具
+  - [nebula-console-intellij-plugin](https://github.com/nebula-contrib/nebula-console-intellij-plugin)：JetBrains IDE 系列 nebula-console 插件，支持语法高亮、函数字段自动补全、数据表格分页显示、关系图展示等等功能
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -644,6 +644,7 @@ nav:
     - NebulaGraph Java: 14.client/4.nebula-java-client.md
     - NebulaGraph Python: 14.client/5.nebula-python-client.md
     - NebulaGraph Go: 14.client/6.nebula-go-client.md
+    - Community contributed clients: 14.client/contributed-clients.md
 
 
   - Studio:
@@ -1005,6 +1006,7 @@ nav:
     - NebulaGraph Java: 14.client/4.nebula-java-client.md
     - NebulaGraph Python: 14.client/5.nebula-python-client.md
     - NebulaGraph Go: 14.client/6.nebula-go-client.md
+    - 社区贡献的客户端: 14.client/contributed-clients.md
 
   - NebulaGraph Studio:
     - 认识 NebulaGraph Studio: