Merge pull request #159 from mo3et/docs/ser

docs: upgrade to Server v3.8.1 docs.

docs/guides/gettingStarted/imSourceCodeDeployment.mdx

@@ -5,48 +5,52 @@ sidebar_position: 1
 
 # 🛠 源码部署
 
-##  1. 环境及组件要求
+## 1. 环境及组件要求
+
 对于服务器环境、系统、以及所依赖组件的说明可以参考[此文档](./env-comp)
 
-## 2. 部署 OpenIM Server (IM) 
+## 2. 部署 OpenIM Server (IM)
+
+### 2.1 clone 仓库 建议切换到 release-v3.8 分支
 
-### 2.1  clone仓库 建议切换到release-v3.8分支
 ```
 git clone https://github.com/openimsdk/open-im-server && cd open-im-server
 ```
 
-### 2.2  部署组件 (mongodb/redis/zookeeper/kafka/MinIO等)
+### 2.2 部署组件 (mongodb/redis/zookeeper/kafka/MinIO 等)
+
 ```
 docker compose up -d
 ```
 
+### 2.3 设置外网 IP 或域名[参考 Nginx 配置](./nginxDomainConfig.mdx)
 
-### 2.3 设置外网IP 或域名[参考Nginx配置](./nginxDomainConfig.mdx)
 ```
-修改config/minio.yml中的externalAddress为http://外网IP:port 或 域名
-修改config/openim-api.yml中的grafanaURL: http://127.0.0.1:13000/为http://外网IP:port 或 域名
+修改 config/minio.yml 中的 externalAddress 为 http://外网IP:port 或 域名
+修改 config/openim-api.yml 中的 grafanaURL: http://127.0.0.1:13000/ 为 http://外网IP:port 或 域名
 ```
 
-
 ### 2.4 🛠️ 初始化
-第一次编译前，linux/mac平台下执行：
+
+第一次编译前，linux/mac 平台下执行：
+
 ```
 bash bootstrap.sh
 ```
-windows执行
+
+windows 执行
+
 ```
 bootstrap.bat
 ```
 
+### 2.5 🛠️ 编译(linux/windows/mac 平台均可用)
 
-
-### 2.5 🛠️ 编译(linux/windows/mac平台均可用)
 ```
 mage
 ```
 
-
-### 2.6 🚀 启动/停止/检测(linux/windows/mac平台均可用)
+### 2.6 🚀 启动/停止/检测(linux/windows/mac 平台均可用)
 
 ```
 # 启动
@@ -59,34 +63,39 @@ mage stop
 mage check
 ```
 
-
 ### 2.7 其他配置项修改
+
 [参考链接](https://github.com/openimsdk/open-im-server/blob/main/config/README.md)
 
+## 3. 部署 App Server (Chat)
 
+### 3.1 clone 仓库 建议切换到 release-v1.8 分支
 
-## 3. 部署 App Server (Chat)
-### 3.1  clone仓库 建议切换到release-v1.8分支
 ```
 git clone https://github.com/openimsdk/chat&& cd chat
 ```
+
 ### 3.2 🛠️ 初始化
-第一次编译前，linux/mac平台下执行：
+
+第一次编译前，linux/mac 平台下执行：
+
 ```
 bash bootstrap.sh
 ```
-windows执行
+
+windows 执行
+
 ```
 bootstrap.bat
 ```
 
-### 3.3 🛠️ 编译(linux/windows/mac平台均可用)
+### 3.3 🛠️ 编译(linux/windows/mac 平台均可用)
+
 ```
 mage
 ```
 
-
-### 3.4 🚀 启动/停止/检测(linux/windows/mac平台均可用)
+### 3.4 🚀 启动/停止/检测(linux/windows/mac 平台均可用)
 
 ```
 # 启动
@@ -101,21 +110,20 @@ mage check
 ```
 
 ### 3.5 其他配置项修改
-[参考链接](https://github.com/openimsdk/chat/blob/main/config/README.md)
 
+[参考链接](https://github.com/openimsdk/chat/blob/main/config/README.md)
 
 ---
+
 ---
 
-## 以下是release-v3.6及之前的版本部署流程
+## 以下是 release-v3.6 及之前的版本部署流程
+
 ## 2. 部署 OpenIM Server (IM)
 
 ### 2.1 📡 设置 OPENIM_IP
 
-
-
-
-🔔 **必须要设置OPENIM_IP，且不能是127.0.0.1**
+🔔 **必须要设置 OPENIM_IP，且不能是 127.0.0.1**
 
 ```
 # 如果服务器有外网IP
@@ -125,16 +133,10 @@ export OPENIM_IP="外网IP"
 export OPENIM_IP="内网IP"
 ```
 
-
-
-
-
-
-
-### 2.2 🏗️ 部署组件 (mongodb/redis/zookeeper/kafka/MinIO等)
+### 2.2 🏗️ 部署组件 (mongodb/redis/zookeeper/kafka/MinIO 等)
 
 ```
-git clone https://github.com/OpenIMSDK/open-im-server && cd open-im-server 
+git clone https://github.com/openimsdk/open-im-server && cd open-im-server
 # 建议切换到release-v3.6及以后的release分支
 make init && docker compose up -d
 
@@ -163,12 +165,13 @@ make check
 
 ## 3. 部署 App Server (Chat)
 
-### 3.1 🏗️ clone chat仓库
+### 3.1 🏗️ clone chat 仓库
+
 ```
 #返回上一级目录
 cd ..
 # clone仓库 建议切换到release-v1.6及以后的release分支
-git clone https://github.com/OpenIMSDK/chat chat && cd chat
+git clone https://github.com/openimsdk/chat chat && cd chat
 ```
 
 ### 3.2 🛠️ 编译
@@ -207,11 +210,11 @@ make check
 
 ### 6.1 🛠️ 共用配置项的修改
 
-| 配置项 | 需要修改的文件 | 操作 |
-| --- | --- | --- |
-| mongo/kafka/minio 相关 | .env, openim-server/config/config.yaml | 需重启组件和 IM |
-| redis/zookeeper 相关 | .env, openim-server/config/config.yaml, chat/config/config.yaml | 需重启组件、IM 和 Chat |
-| SECRET | openim-server/config/config.yaml, chat/config/config.yaml | 需重启 IM 和 Chat |
+| 配置项                 | 需要修改的文件                                                  | 操作                   |
+| ---------------------- | --------------------------------------------------------------- | ---------------------- |
+| mongo/kafka/minio 相关 | .env, openim-server/config/config.yaml                          | 需重启组件和 IM        |
+| redis/zookeeper 相关   | .env, openim-server/config/config.yaml, chat/config/config.yaml | 需重启组件、IM 和 Chat |
+| SECRET                 | openim-server/config/config.yaml, chat/config/config.yaml       | 需重启 IM 和 Chat      |
 
 ### 6.2 🔄 共用配置项中特殊配置项的修改
 
@@ -230,25 +233,22 @@ object:
 grafanaUrl: http://$OPENIM_IP:$GRAFANA_PORT
 ```
 
-
 3. 在 **`chat/config/config.yaml`** 中按照规则修改配置
 
 ```jsx
 如果IM在Chat不在同一台机器上，则需将127.0.0.1替换成IM所在机器的IP
 openIMUrl: "http://127.0.0.1:$API_OPENIM_PORT"
 ```
 
-
-
 4. 重启 IM 和 Chat
 
 ### 6.3 🛠️ 其他配置项的修改
 
 对于 **`.env`**、**`chat/config/config.yaml`** 和 **`openim-server/config/config.yaml`** 中的其他配置项，可以单独修改相应文件中的这些配置项。
 
-
 ### 6.4 端口的修改
-特别注意的是，对于IM相关任何端口的修改，都需要同步修改open-im-server/scripts/install/environment.sh中的端口
+
+特别注意的是，对于 IM 相关任何端口的修改，都需要同步修改 open-im-server/scripts/install/environment.sh 中的端口
 
 ---
 
@@ -261,20 +261,14 @@ openIMUrl: "http://127.0.0.1:$API_OPENIM_PORT"
 - 运行时日志，启动成功后定位问题时查看：`_output/logs/openim-all*`
 - 启动时日志，启动有错误时查看：`_output/logs/openim-*.log`
 
-
-
 ### 7.2 🚀 启动顺序
 
 启动顺序如下：
 
-- IM 依赖的组件：mongo/redis/kafka/zookeeper/minio等
+- IM 依赖的组件：mongo/redis/kafka/zookeeper/minio 等
 - **IM**
 - **Chat**
 
 ### 7.3 🐳 Docker 版本
 
-新版 Docker 已经整合了 docker-compose. 老版本的 Docker 可能不支持 gateway 功能❌。我们建议您升级到较新的版本，例如 `23.0.1`🔝
-
-
-
-
+新版 Docker 已经整合了 docker-compose. 老版本的 Docker 可能不支持 gateway 功能 ❌。我们建议您升级到较新的版本，例如 `23.0.1`🔝

docs/guides/gettingStarted/k8s-deployment.mdx

@@ -12,9 +12,9 @@ OpenIM支持多种集群部署方法，包括但不限于`helm`、`sealos`、`ku
 
 多个贡献者和之前的官方版本都提供了一些可供参考的解决方案：
 
-+ [k8s-jenkins仓库](https://github.com/OpenIMSDK/k8s-jenkins)
++ [k8s-jenkins仓库](https://github.com/openimsdk/k8s-jenkins)
 + [open-im-server-k8s-deploy仓库](https://github.com/openimsdk/open-im-server-k8s-deploy)
-+ [openim-charts仓库](https://github.com/OpenIMSDK/openim-charts)
++ [openim-charts仓库](https://github.com/openimsdk/openim-charts)
 + [deploy-openim仓库](https://github.com/showurl/deploy-openim)
 
 ### 依赖性检查

docs/guides/introduction/index.mdx

@@ -12,7 +12,7 @@ sidebar_position: 1
 
 > ⭐️ 我们感谢每一位支持我们的开发者。您的支持是我们力争成为开源IM领域领先者的坚实基石！
 
-[🔗 访问我们的Github仓库了解更多](https://github.com/OpenIMSDK/Open-IM-Server)
+[🔗 访问我们的Github仓库了解更多](https://github.com/openimsdk/open-im-server)
 
 # 我们的团队
 

docs/guides/introduction/product.mdx

@@ -11,21 +11,21 @@ sidebar_position: 1
 需要注意的是，开发者需要开发客户端UI，而OpenIM的DEMO仅作为参考。
 
 
-OpenIM 是由两大核心组件构成的即时通讯解决方案：**OpenIMSDK** 和 **OpenIMServer**。以下是其主要特征：
+OpenIM 是由两大核心组件构成的即时通讯解决方案：**OpenIM SDK** 和 **OpenIM Server**。以下是其主要特征：
 
-📦 **OpenIMSDK**: 
+📦 **OpenIM SDK**: 
 - 作为库文件形式，直接嵌入到应用程序中，便于开发者快速集成。
 
-🖥️ **OpenIMServer**: 
+🖥️ **OpenIM Server**: 
 - 作为独立的服务端程序私有化部署，提供强大的消息管理、分发、推送能力。
 
 
 
 ![关系示意图](./assets/relation.png)
 
-# 📘 详解OpenIMSDK
+# 📘 详解OpenIM SDK
 
-**OpenIMSDK** 是为 **OpenIMServer** 设计的IM SDK，嵌入客户端应用中。其主要功能和技术特点如下：
+**OpenIM SDK** 是为 **OpenIM Server** 设计的IM SDK，嵌入客户端应用中。其主要功能和技术特点如下：
 
 ## 🌟 主要功能：
 - 📦 本地存储
@@ -63,23 +63,23 @@ OpenIM 是由两大核心组件构成的即时通讯解决方案：**OpenIMSDK**
 | Unity | [open-im-sdk-unity](https://github.com/openimsdk/open-im-sdk-unity)            | Unity SDK                                                 | [open-im-unity-demo](https://github.com/openimsdk/open-im-unity-demo)                 | Unity示例 |
 | C/C++ | [open-im-sdk-cpp](https://github.com/openimsdk/openim-sdk-cpp)            | C/C++ SDK                                                 |                 | |
 
-## 🔍 详解OpenIMServer
+## 🔍 详解OpenIM Server
 
-**OpenIMServer** 具有以下特点：
+**OpenIM Server** 具有以下特点：
 
 - 🧩 多模块构成，如网关(gateway)和多个rpc服务。
 - 🌐 微服务架构，支持集群模式。
 - 🚀 部署方式多样，如源代码、kubernetes或docker部署。
 
-[🔗 OpenIMServer 仓库地址](https://github.com/openimsdk/open-im-server)
+[🔗 OpenIM Server 仓库地址](https://github.com/openimsdk/open-im-server)
 
 ### 🌐 REST API
 
-- OpenIMServer 提供了REST API供业务系统使用，例如通过建立群组、发送推送消息等。REST API以APP管理员身份调用，旨在赋予业务更多功能。
+- OpenIM Server 提供了REST API供业务系统使用，例如通过建立群组、发送推送消息等。REST API以APP管理员身份调用，旨在赋予业务更多功能。
 
 ### 📞 Webhook
 
-- OpenIMServer提供了回调能力以扩展更多的业务形态，所谓回调，即OpenIMServer会在某一事件发生之前或者之后，向指定的服务器发送请求，如发送消息之前或之后的回调。
+- OpenIM Server提供了回调能力以扩展更多的业务形态，所谓回调，即OpenIM Server会在某一事件发生之前或者之后，向指定的服务器发送请求，如发送消息之前或之后的回调。