update docs

Author: wu-clan

docs/.vuepress/public/images/plugin_template.png

@@ -74,7 +74,7 @@ export const mySidebar: ThemeSidebarMulti = {
             collapsed: false,
             items: [
                 { text: '插件开发', link: 'dev' },
-                { text: '插件发布', link: 'publish' },
+                { text: '插件分享', link: 'share' },
             ]
         },
         {

docs/.vuepress/public/images/plugin_zip.png

@@ -4,25 +4,17 @@ title: 插件开发
 
 ## 后端
 
-:::: steps
+::: steps
 
 1. 拉取最新的 fba 项目到本地并配置好开发环境
 2. 通过 [插件分类](#插件分类)、[插件路由结构](#插件路由结构)、[插件配置](#插件配置)、[数据库兼容性](#数据库兼容性)
    了解插件系统的运作机制
 3. 根据 [插件目录结构](#插件目录结构) 进行插件开发
 4. 完成插件开发
-5. 插件分享 <Badge type="warning" text="可选" />
 
-   使用插件模板仓库 [fba_plugin_template](https://github.com/fastapi-practices/fba_plugin_template)
-   创建个人仓库，并将插件代码上传到个人仓库
+5. [插件分享](./share.md) <Badge type="warning" text="可选" />
 
-   ::: warning
-   请不要将插件代码以 PR 的方式进行提交！
-   :::
-
-6. [申请发布插件](publish.md) <Badge type="warning" text="可选" />
-
-::::
+:::
 
 ### 插件分类
 
@@ -92,25 +84,26 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对
 
 ### 插件目录结构
 
+插件统一放置在 `backend/plugin` 目录下，以下是插件的目录结构
+
 ::: file-tree
 
-- backend 固定目录 <Badge type="danger" text="必须" />
-    - plugin 固定目录 <Badge type="danger" text="必须" />
-        - xxx 插件名 <Badge type="danger" text="必须" />
-            - api/ 接口 <Badge type="danger" text="必须" />
-            - crud/ CRUD <Badge type="warning" text="非必须" />
-            - model 模型 <Badge type="warning" text="非必须" />
-                - __init__.py 在此文件内导入所有模型类 <Badge type="danger" text="必须" />
-                - …
-            - schema/ 数据传输 <Badge type="warning" text="非必须" />
-            - service/ 服务 <Badge type="warning" text="非必须" />
-            - utils/ 工具包 <Badge type="warning" text="非必须" />
-            - __init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
-            - conf.py 插件独立配置 <Badge type="warning" text="非必须" />
-            - … 更多其他配置，例如 enums.py... <Badge type="warning" text="非必须" />
-            - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
-            - README.md 插件使用说明 <Badge type="danger" text="必须" />
-            - requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />
+- xxx 插件名 <Badge type="danger" text="必须" />
+    - api/ 接口 <Badge type="danger" text="必须" />
+    - crud/ CRUD <Badge type="warning" text="非必须" />
+    - model 模型 <Badge type="warning" text="非必须" />
+        - __init__.py 在此文件内导入所有模型类 <Badge type="danger" text="必须" />
+        - …
+    - schema/ 数据传输 <Badge type="warning" text="非必须" />
+    - service/ 服务 <Badge type="warning" text="非必须" />
+    - utils/ 工具包 <Badge type="warning" text="非必须" />
+    - __init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
+    - .env.example 插件环境变量配置示例 <Badge type="warning" text="非必须" />
+    - conf.py.example 插件独立配置示例 <Badge type="warning" text="非必须" />
+    - … 更多其他配置，例如 enums.py... <Badge type="warning" text="非必须" />
+    - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
+    - README.md 插件使用说明和您的联系方式 <Badge type="danger" text="必须" />
+    - requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />
 
 :::
 

docs/.vuepress/sidebar.ts

@@ -8,35 +8,42 @@ title: 快速开始
 @tab 手动
 
 1. 获取插件仓库源码并下载
-2. 将源码中的插件目录直接拷贝到 fba 项目对应的目录下
+2. 拷贝插件代码
 
    ::: tabs
    @tab 后端
 
-   将插件源码 `backend/plugin/` 目录下的插件文件夹拷贝到 fba 项目 `backend/plugin/` 目录下
+   将下载的源码直接拷贝到 `backend/plugin` 目录下
 
    @tab 前端
 
    暂无此计划...
    :::
 
 3. 如果插件包含依赖（requirements.txt），执行 `backend/scripts/init_plugin.py` 文件安装依赖
-4. 根据插件使用说明（README.md）完成安装
+4. 根据插件说明（README.md）进行相关配置
+5. 重启服务
 
-@tab 半自动
+@tab ZIP
 
 1. 获取打包好的插件 zip 压缩包 <Badge type="warning" text="二选一" />
 
-    - 下载插件 GitHub 仓库为 zip 压缩包
+    - 下载插件仓库为 zip 压缩包，例如 GitHub
 
-      ::: details 示例
-      ![cg1](/images/plugin_zip.png)
-      :::
+      ![zip](/images/plugin_zip.png)
 
-    - 通过 fba 插件打包接口创建的 zip 压缩包
+    - 通过 fba 插件打包接口下载的 zip 压缩包
 
-2. 将压缩包通过 fba 插件安装接口进行安装
-3. 根据插件使用说明（README.md）完成安装
+2. 将 zip 压缩包通过 zip 插件安装接口进行安装
+3. 根据插件说明（README.md）进行相关配置
+4. 重启服务
+
+@tab GIT
+
+1. 获取插件 git 仓库地址，理论上支持任何平台（GitHub、Gitlab、Gitee、Gitea...）
+2. 通过 git 插件安装接口进行安装
+3. 根据插件说明（README.md）进行相关配置
+4. 重启服务
 
 ::::
 

docs/plugin/dev.md

@@ -0,0 +1,44 @@
+---
+title: 插件分享
+---
+
+:::: steps
+
+1. 创建个人插件仓库
+
+   使用插件模板仓库 [fba_plugin_template](https://github.com/fastapi-practices/fba_plugin_template)
+   创建个人插件仓库，个人插件仓库命名请遵循以下规则：
+
+   `个人插件仓库名 == 插件名`
+
+   当我们创建个人插件仓库的时候，应将 `backend/plugin` 目录下的插件名作为仓库名使用，这样，插件将符合 fba 内置规则，并允许通过
+   git 快捷安装
+
+   ::: warning
+   插件总是独一无二的，不允许安装同名插件，所以我们在对插件进行命名时，应尽量保持其独特性
+   :::
+
+   ![repo](/images/plugin_template.png)
+
+2. 上传代码
+
+   将本地插件中的所有文件拷贝到个人插件仓库中
+
+   ::: caution
+   应拷贝插件目录下的所有文件，而不是直接拷贝插件目录
+   :::
+
+::::
+
+## 公开
+
+我们为插件创建了一个 [插件市场](market.md)，用于展示和导航
+
+如果您开发的插件与 fba 兼容，欢迎在 Discord
+社区的 [插件系统](https://discord.com/channels/1185035164577972344/1349951379560599572) 频道与我们分享
+
+> [!IMPORTANT]
+> 发布插件必须满足以下要求：
+>
+> - 提供插件 GitHub 仓库地址
+> - 在插件仓库内提供至少一种您的（任意）联系方式用于技术支持