Skip to content

Commit bdb5c5d

Browse files
committed
update docs
1 parent 3859def commit bdb5c5d

File tree

7 files changed

+28
-20
lines changed

7 files changed

+28
-20
lines changed

docs/.vuepress/sidebar.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ export const mySidebar: SidebarMulti = {
99
prefix: 'summary/',
1010
items: [
1111
{text: '简介', link: 'intro'},
12-
{text: '为什么选择我们?', link: 'why'},
1312
{text: '快速开始', link: 'quick-start'},
13+
{text: '为什么选择我们?', link: 'why'},
1414
{text: '精简版', link: 'fsm'},
1515
]
1616
},
@@ -28,12 +28,12 @@ export const mySidebar: SidebarMulti = {
2828
{text: '数据规则', link: 'data-rule', icon: 'mdi:planet'},
2929
{text: '代码生成', link: 'code-generation'},
3030
{text: '自定义异常', link: 'custom-err-msg', icon: 'mdi:planet'},
31-
{text: '接口响应', link: 'response', icon: 'mdi:planet'},
31+
{text: '接口响应', link: 'response'},
3232
{text: '分页', link: 'paginate'},
3333
{text: 'Celery', link: 'celery', icon: 'mdi:planet'},
3434
{text: 'APScheduler', link: 'apscheduler'},
3535
{text: '日志分析', link: 'log', icon: 'mdi:planet'},
36-
{text: 'Socketio', link: 'socketio', icon: 'mdi:planet'},
36+
{text: 'Socketio', link: 'socketio'},
3737
]
3838
},
3939
{

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ config:
1212
actions:
1313
- theme: brand
1414
text: 快速开始 ->
15-
link: /guide/summary/intro
15+
link: /guide/summary/quick-start
1616
- theme: alt
17-
text: 在线预览
18-
link: https://fba.xwboy.top
17+
text: 为什么选择我们?
18+
link: /guide/summary/why
1919
- type: features
2020
features:
2121
- title: 最新技术栈

docs/guide/deploy/legacy.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@ title: 传统部署
33
---
44

55
> [!IMPORTANT]
6-
> 由于传统部署方案涉及修改的地方较多且较为复杂,目前暂不提供此部署方案
6+
> 由于传统部署方案涉及修改的地方较多且较为复杂,因此无法提供此部署教程,但您可以选择 [有偿赞助](../../sponsors.md#有偿赞助)
7+
> ,我们可以为您提供一对一专属指导和远程支持
78
8-
> [!TIP]
9-
> 由于 FastAPI Best Architecture 线上服务器资源有限,当前使用【传统 + Docker】的方案进行部署,尽可能避免内存溢出导致的服务中断,
10-
> 我们后期或许会提供 BiliBili 免费教程
11-
>
12-
> 但是抱歉,我们不提供一对一免费协助,它将是一个==付费咨询==,您可以通过上方互动与我们取得联系
9+
::: info
10+
当前 FastAPI Best Architecture 线上服务器资源有限,使用【Docker + 传统】的方案进行部署,尽可能避免服务器内存溢出导致的服务中断
11+
:::

docs/guide/reference/apscheduler.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,15 @@
22
title: APScheduler
33
---
44

5-
coming soon...
5+
我们在最初的框架实现中,使用的是 APScheduler,但后来我们迁移到了 [Celery](celery.md)
6+
,详情请查看:[#225](https://github.com/fastapi-practices/fastapi_best_architecture/discussions/225)
7+
8+
FastAPI + APScheduler 现已作为独立仓库发行,它的优势在于其灵活性与动态任务,如果你没有繁重的任务需求,它将是一个不错的选择;
9+
10+
<RepoCard repo="wu-clan/fastapi_scheduler" />
11+
12+
::: warning
13+
此仓库 master 分支使用 APScheduler 4.x 版本进行开发,但由于 aps
14+
迟迟未发布 4.x 版本,所以请查看 [apscheduler-3.x](https://github.com/wu-clan/fastapi_scheduler/tree/apscheduler-3.x)
15+
分支,它是目前最流行的版本,也相对比较稳定
16+
:::

docs/guide/reference/socketio.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,4 @@
22
title: Socketio
33
---
44

5-
[//]: # (星球)
6-
75
coming soon...

docs/guide/summary/intro.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ mvc 架构作为常规设计模式,在 python web 中很常见,但是三层
101101

102102
## 相关
103103

104-
::: tip 特别鸣谢
105-
本文档由 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
106-
驱动,感谢 [pengzhanbo](https://github.com/pengzhanbo) 对此开源项目的杰出贡献
107-
:::
104+
> [!IMPORTANT]
105+
> 本文档由 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
106+
> 驱动,感谢 [pengzhanbo](https://github.com/pengzhanbo) 对此开源项目的杰出贡献

docs/sponsors.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ FBA 基于 MIT 开源协议,您可以查看我们的[授权协议](/guide/summ
1616

1717
## 有偿赞助
1818

19-
您可以加入我们的创建的[知识星球](https://t.zsxq.com/PDk8b),获取星球内提供的 FBA 独家教程(文字、视频)
19+
您可以加入我们的创建的[知识星球](https://t.zsxq.com/PDk8b),获取星球内提供的独家内容,另外,我们会为您添加 Discord
20+
身份标签,以便于后期进行活动投票,线上知道,远程支持等等...
2021

2122
## 展位赞助商
2223

0 commit comments

Comments
 (0)