Skip to content

Commit 9311aa0

Browse files
committed
update docs
1 parent eeb7694 commit 9311aa0

File tree

3 files changed

+31
-24
lines changed

3 files changed

+31
-24
lines changed

docs/backend/summary/slim.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ FastAPI 最佳架构精简版的目标是仅保留最最最简单的架构代码
77
## SQLAlchemy
88

99
::: caution
10-
此版本的更新非实时不同步,我们目前正在寻找维护人员
10+
此版本的更新非实时同步,我们目前正在寻找维护人员
1111
:::
1212

1313
<LinkCard
@@ -20,7 +20,7 @@ icon="https://wu-clan.github.io/picx-images-hosting/logo/fba.png"
2020
## Tortoise-ORM
2121

2222
::: caution
23-
此版本的更新非实时不同步,我们目前正在寻找维护人员
23+
此版本的更新非实时同步,我们目前正在寻找维护人员
2424
:::
2525

2626
<LinkCard

docs/plugin/dev.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -188,23 +188,12 @@ EMAIL_CAPTCHA_EXPIRE_SECONDS: int
188188
```
189189

190190
整个结构分为【插件配置说明注释】、【插件环境变量配置及注释】、【插件基础配置及注释】,但是,在发布的插件中,我们无法添加这些配置,只能通过
191-
`README` 进行说明,提醒用户如何完成插件全局配置,可参考 fba 官方插件:[oss](https://github.com/fastapi-practices/oss)
192-
193-
::: caution
194-
全局配置默认使用最高优先级赋值,优先级如下:
195-
196-
```mermaid
197-
graph LR
198-
System("系统环境变量") --> DotEnv[".env"]
199-
DotEnv --> Settings["conf.py"]
200-
Settings --> Plugin["插件 settings 配置项"]
201-
```
202-
203-
:::
191+
`README` 进行说明,提醒用户如何完成插件全局配置
204192

205193
### 热插拔
206194

207-
从 ==v1.13.0=={.warning} 开始,按以下要求进行配置,将自动适配热插拔特性
195+
从 ==v1.13.0=={.note} 开始,按以下要求进行配置,将自动适配热插拔特性,可参考 fba
196+
官方插件:[oss](https://github.com/fastapi-practices/oss)
208197

209198
- 插件环境变量
210199

@@ -235,6 +224,17 @@ graph LR
235224
236225
完成以上配置后,如果插件无需更多修改,通过 [CLI 或 Git](./install.md) 方式安装插件后,将无损适配热插拔
237226
227+
::: important 全局配置应用优先级
228+
229+
```mermaid
230+
graph LR
231+
System("系统环境变量") --> DotEnv[".env"]
232+
DotEnv --> Settings["conf.py"]
233+
Settings --> Plugin["插件 settings 配置项"]
234+
```
235+
236+
:::
237+
238238
::: tip
239239
除此之外,我们仍强烈建议您在开发阶段添加 [全局配置](#全局配置),并在发布的插件 README 中添加全局配置说明,如果你和你的插件用户想通过
240240
IDE 获取全局配置键入提示,这是必需的,相反,你们将无法获取 IDE 键入提示

docs/plugin/share.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ title: 插件分享
1111

1212
假如插件仓库命名为 `sms`,安装此插件后,`backend/plugin` 目录下就会新增一个 `sms` 文件夹
1313

14-
插件总是独一无二的,不允许安装同名插件,所以在对插件进行命名时,应尽量保持其独特性,否则将导致插件冲突
14+
后端插件文件夹命名==不可随意修改==,这将对整个插件内的代码造成影响
15+
16+
插件总是独一无二的,不允许安装同名插件,所以在对插件进行命名时,应尽量保持其独特性
1517
:::
1618

1719
:::: steps
@@ -26,7 +28,7 @@ title: 插件分享
2628

2729
将在 fba 中开发好的所有插件代码拷贝到个人插件仓库中
2830

29-
::: caution
31+
::: important
3032
应拷贝插件目录中的所有文件,而不是拷贝插件目录
3133
:::
3234

@@ -35,14 +37,15 @@ title: 插件分享
3537
## 前端
3638

3739
::: warning 插件仓库命名规则
38-
39-
==为了区分 UI 插件,我们需要为插件仓库名添加 `_ui` 后缀=={.important}
40-
4140
`插件仓库名_ui == 插件名_ui`
4241

42+
为了更好的与后端插件进行区分,建议为前端插件仓库名添加 `_ui` 后缀
43+
4344
假如插件仓库命名为 `sms_ui`,安装此插件后,`apps/web-antd/src/plugins` 目录下就会新增一个 `sms_ui` 文件夹
4445

45-
插件总是独一无二的,不允许安装同名插件,所以在对插件进行命名时,应尽量保持其独特性,否则将导致插件冲突
46+
前端插件文件夹命名==可随意修改==,这不会对插件内的代码造成影响
47+
48+
插件总是独一无二的,不允许安装同名插件,所以在对插件进行命名时,应尽量保持其独特性
4649
:::
4750

4851
:::: steps
@@ -55,15 +58,19 @@ title: 插件分享
5558

5659
将在 fba_ui 中开发好的所有插件代码拷贝到个人插件仓库中,仅限 [Vben Admin Antd](../frontend/summary/intro.md) 工程
5760

58-
::: caution
61+
::: important
5962
应拷贝插件目录中的所有文件,而不是拷贝插件目录
6063
:::
6164

6265
::::
6366

6467
## 发布插件
6568

66-
要想发布插件,你需要为 fba 插件 github 仓库创建一个 PR.
69+
要想发布插件,你需要为 fba 插件仓库创建一个 PR.
70+
71+
::: tip
72+
插件总是独一无二的,如果插件名已存在,那你只能选择为即将发布的插件换个新名字
73+
:::
6774

6875
:::: steps
6976

0 commit comments

Comments
 (0)