Skip to content

Commit e99f784

Browse files
committed
update docs
1 parent fed879c commit e99f784

8 files changed

Lines changed: 27 additions & 19 deletions

File tree

docs/backend/deploy/Docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ fba 正在使用免费 SSL 证书:[httpsok-SSL](https://httpsok.com/p/4Qjd),
9292

9393
1. 拉取代码到服务器
9494

95-
将代码拉取到服务器通常采用 ssh 方式(更安全),当然你也可以选择使用 https 方式,具体方式请根据个人自行决定
95+
将代码拉取到服务器通常采用 ssh 方式(更安全),当然你也可以选择使用 HTTPS 方式,具体方式请根据个人自行决定
9696

9797
2. env
9898

docs/backend/reference/RBAC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: RBAC
55
我们通过自定义依赖组件,实现了 RBAC 的轻松集成,它可以通过 FastAPI Depends 轻松集成
66

77
::: caution
8-
fba [v1.2.0](../../changelog.md) 版本起,开始将【角色菜单】作为默认 RBAC 鉴权,Casbin 作为外置插件进行分发
8+
自 v1.2.0 开始,默认 RBAC 已更换为【[角色菜单](#角色菜单)】,【[Casbin-RBAC](#casbin)】将作为外置插件进行分发
99
:::
1010

1111
## 角色菜单
@@ -31,7 +31,7 @@ title: RBAC
3131

3232
2. 在系统菜单中添加权限标识
3333

34-
我们在接口依赖中可以看到 `sys:api:add` 之类的值,这些值正是对应着菜单中的权限标识,只有它们完全一致,并且用户拥有对应的菜单时,才可以获得相应的操作权限
34+
我们在接口依赖中可以看到 `sys:api:add` 之类的值,这些值正是对应着菜单中的权限标识字段,只有它们完全一致,并且用户拥有对应的菜单时,才可以获得相应的操作权限
3535

3636
:::
3737

docs/backend/reference/jwt.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ title: JWT
1010
在文件 `backend/common/security/jwt.py` 中,包含以下代码
1111

1212
```python
13-
# JWT authorizes dependency injection
14-
DependsJwtAuth = Depends(CustomHTTPBearer())
13+
# JWT dependency injection
14+
DependsJwtAuth = Depends(HTTPBearer())
1515
```
1616

1717
我们通过在接口函数中添加此依赖实现 JWT 快速校验,它可以帮助我们检查请求头中是否包含 Bearer Token,使用方式参考如下:
@@ -35,7 +35,9 @@ async def hello():
3535
你可以通过此方式获取 token,在大多数情况下,这更适用于配合前端实现登录授权
3636

3737
我们在 fba 中使用 [fast_captcha](https://github.com/wu-clan/fast-captcha) 生成 base64 验证码,然后通过接口进行数据返回;您可以通过在线
38-
base64 转图片或配合前端项目将其转为图片进行预览,以下使其工作流程:
38+
base64 转图片或配合前端项目将其转为图片进行预览
39+
40+
### 授权流程
3941

4042
```sequence 验证码登录逻辑
4143
actor 客户端

docs/frontend/deploy/docker.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Docker 部署
33
---
44

55
::: warning
6-
此教程以 https 为例
6+
此教程以 HTTPS 为例
77
:::
88

99
:::: steps
1010

1111
1. 拉取代码到服务器
1212

13-
将代码拉取到服务器通常采用 ssh 方式(更安全),当然你也可以选择使用 https 方式,具体方式请根据个人自行决定
13+
将代码拉取到服务器通常采用 ssh 方式(更安全),当然你也可以选择使用 HTTP 方式,具体方式请根据个人自行决定
1414

1515
2. env
1616

@@ -22,17 +22,17 @@ title: Docker 部署
2222

2323
4. 更新 `docker-compose` 脚本
2424

25-
::: caution 构建条件(不满足不要继续)
25+
脚本 `docker-compose.yml` 中有相关注释说明,根据需要进行修改即可
26+
27+
5. 执行一键启动命令
28+
29+
::: caution 必要条件
2630

2731
- 注释了 fba 后端 docker-compose 脚本中的 fba_ui 容器
2832
- 已经通过 docker-compose 构建 fba 后端
2933

3034
:::
3135

32-
脚本 `docker-compose.yml` 中有相关注释说明,根据需要进行修改即可
33-
34-
5. 执行一键启动命令
35-
3636
在项目根目录中打开终端,执行以下命令
3737

3838
```shell:no-line-numbers

docs/frontend/summary/arco.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ badge:
55
type: danger
66
---
77

8-
==此版本已停止更新维护!=={.danger}
8+
<p style="color: red;">此版本已停止更新和维护!相关代码仓库已封存!</p>
99

1010
我们已于 2025 年 3 月 29 日对 Arco 仓库进行封存,此后它将不再接收任何更新。尽管做出这一决定让我们心生不舍,毕竟 Arco
1111
曾承载了我们无数的探索与期待,但技术的脚步永不停歇,为了顺应更高效、更前沿的发展需求,我们不得不迈向新的篇章。
1212

1313
至此,承蒙每一位大佬的厚爱,请与我们携手共进,打开 [Vben Admin Antd](intro.md) 新篇章
1414

1515
::: note
16-
此实施内部通过硬编码实现了 Casbin RBAC 鉴权,如需解耦,需手动删除 casbin、API 管理及其所有调用
16+
此实施内部通过硬编码实现了 Casbin RBAC 鉴权,如需解耦,需手动删除 Casbin、API 管理及其所有调用
1717
:::
1818

1919
::: caution
20-
此实施自 fba [v1.0.4](../changelog.md) 版本起,正式宣告其使命完结,fba 后续版本将不再对此进行适配,请不要将其用于生产!
20+
此实施自 v1.0.4 版本起,正式宣告其使命完结,fba 后续版本将不再对此进行适配,请不要将其用于生产!
2121
:::

docs/frontend/summary/intro.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,10 @@ title: 介绍
88
fba 从始至终一直是企业级后端架构解决方案,并没有针对前端的专项计划,前端项目只是一项附加产物
99

1010
我们的团队中没有专业的前端工程师,如果您都此项目的发展和实施有更好的见解,请直接创建 Issues 或 PR
11+
:::
12+
13+
::: info
14+
如果您愿意为此负责,担任维护人员,随时欢迎提交申请
15+
16+
[**申请加入团队**](./join.md){.read-more}
1117
:::

docs/frontend/summary/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: 快速开始
33
---
44

5-
::: warning
6-
前端已默认集成<字典>功能,所以后端必须配置<字典插件>,并执行字典插件中的 SQL 脚本
5+
::: caution
6+
前端已默认集成【字典】功能,所以 fba 必须安装字典插件并执行插件中的 SQL 脚本
77
:::
88

99
::: steps

docs/team.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ groups:
8686
link: https://github.com/imbalich
8787
---
8888

89-
[申请 **加入团队**](./join.md){.read-more}
89+
[**申请加入团队**](./join.md){.read-more}

0 commit comments

Comments
 (0)