Skip to content

Commit d84240f

Browse files
committed
update docs
1 parent eeef7b0 commit d84240f

1 file changed

Lines changed: 27 additions & 6 deletions

File tree

docs/plugin/share.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: 插件分享
99
::: warning 插件仓库命名规则
1010
`插件仓库名 == 插件名`
1111

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

1414
插件总是独一无二的,不允许安装同名插件,所以在对插件进行命名时,应尽量保持其独特性,否则将导致插件冲突
1515
:::
@@ -35,9 +35,12 @@ title: 插件分享
3535
## 前端
3636

3737
::: warning 插件仓库命名规则
38-
`插件仓库名 == 插件名`
3938

40-
假如你的个人插件仓库命名为 `sms`,安装此插件后,`apps/web-antd/src/plugins` 目录下就会新增一个 `sms` 文件夹
39+
==为了区分 UI 插件,我们需要为插件仓库名添加 `_ui` 后缀=={.important}
40+
41+
`插件仓库名_ui == 插件名_ui`
42+
43+
假如插件仓库命名为 `sms_ui`,安装此插件后,`apps/web-antd/src/plugins` 目录下就会新增一个 `sms_ui` 文件夹
4144

4245
插件总是独一无二的,不允许安装同名插件,所以在对插件进行命名时,应尽量保持其独特性,否则将导致插件冲突
4346
:::
@@ -58,7 +61,9 @@ title: 插件分享
5861

5962
::::
6063

61-
## 发布
64+
## 发布插件
65+
66+
要想发布插件,你需要为 fba 插件 github 仓库创建一个 PR.
6267

6368
:::: steps
6469

@@ -77,7 +82,7 @@ title: 插件分享
7782

7883
```shell
7984
# 注意替换 add-your-plugin
80-
git checkout -b add-your-plugin
85+
git checkout -b add-your-plugin-branch
8186
```
8287

8388
4. 扩展子模块
@@ -97,7 +102,11 @@ title: 插件分享
97102
```shell
98103
# 注意替换 your-plugin-name
99104
git commit -m "Add your-plugin-name plugin"
100-
git push
105+
```
106+
107+
```shell
108+
# 注意替换 add-your-plugin-branch
109+
git push --set-upstream origin add-your-plugin-branch
101110
```
102111

103112
6. PR
@@ -109,3 +118,15 @@ title: 插件分享
109118
fba 团队将尽快完成检查,一旦您的 PR 合并,插件将被发布到 [插件市场](../market.md)
110119

111120
::::
121+
122+
## 更新插件
123+
124+
要想更新插件,你需要为 fba 插件 github 仓库创建一个 PR.
125+
126+
执行发布相同的步骤,只需将步骤 4 中的 `git submodule` 命令换成以下命令:
127+
128+
```shell
129+
git submodule update --remote plugins/your-plugin-name
130+
```
131+
132+
如果你想自动执行此过程,可以使用 [GitHub Action](https://github.com/fastapi-practices/plugin-release)

0 commit comments

Comments
 (0)