Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wu-clan committed Dec 20, 2024
1 parent 3859def commit bdb5c5d
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 20 deletions.
6 changes: 3 additions & 3 deletions docs/.vuepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ export const mySidebar: SidebarMulti = {
prefix: 'summary/',
items: [
{text: '简介', link: 'intro'},
{text: '为什么选择我们?', link: 'why'},
{text: '快速开始', link: 'quick-start'},
{text: '为什么选择我们?', link: 'why'},
{text: '精简版', link: 'fsm'},
]
},
Expand All @@ -28,12 +28,12 @@ export const mySidebar: SidebarMulti = {
{text: '数据规则', link: 'data-rule', icon: 'mdi:planet'},
{text: '代码生成', link: 'code-generation'},
{text: '自定义异常', link: 'custom-err-msg', icon: 'mdi:planet'},
{text: '接口响应', link: 'response', icon: 'mdi:planet'},
{text: '接口响应', link: 'response'},
{text: '分页', link: 'paginate'},
{text: 'Celery', link: 'celery', icon: 'mdi:planet'},
{text: 'APScheduler', link: 'apscheduler'},
{text: '日志分析', link: 'log', icon: 'mdi:planet'},
{text: 'Socketio', link: 'socketio', icon: 'mdi:planet'},
{text: 'Socketio', link: 'socketio'},
]
},
{
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ config:
actions:
- theme: brand
text: 快速开始 ->
link: /guide/summary/intro
link: /guide/summary/quick-start
- theme: alt
text: 在线预览
link: https://fba.xwboy.top
text: 为什么选择我们?
link: /guide/summary/why
- type: features
features:
- title: 最新技术栈
Expand Down
11 changes: 5 additions & 6 deletions docs/guide/deploy/legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: 传统部署
---

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

coming soon...
我们在最初的框架实现中,使用的是 APScheduler,但后来我们迁移到了 [Celery](celery.md)
,详情请查看:[#225](https://github.com/fastapi-practices/fastapi_best_architecture/discussions/225)

FastAPI + APScheduler 现已作为独立仓库发行,它的优势在于其灵活性与动态任务,如果你没有繁重的任务需求,它将是一个不错的选择;

<RepoCard repo="wu-clan/fastapi_scheduler" />

::: warning
此仓库 master 分支使用 APScheduler 4.x 版本进行开发,但由于 aps
迟迟未发布 4.x 版本,所以请查看 [apscheduler-3.x](https://github.com/wu-clan/fastapi_scheduler/tree/apscheduler-3.x)
分支,它是目前最流行的版本,也相对比较稳定
:::
2 changes: 0 additions & 2 deletions docs/guide/reference/socketio.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@
title: Socketio
---

[//]: # (星球)

coming soon...
7 changes: 3 additions & 4 deletions docs/guide/summary/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ mvc 架构作为常规设计模式,在 python web 中很常见,但是三层

## 相关

::: tip 特别鸣谢
本文档由 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
驱动,感谢 [pengzhanbo](https://github.com/pengzhanbo) 对此开源项目的杰出贡献
:::
> [!IMPORTANT]
> 本文档由 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
> 驱动,感谢 [pengzhanbo](https://github.com/pengzhanbo) 对此开源项目的杰出贡献
3 changes: 2 additions & 1 deletion docs/sponsors.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ FBA 基于 MIT 开源协议,您可以查看我们的[授权协议](/guide/summ

## 有偿赞助

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

## 展位赞助商

Expand Down

0 comments on commit bdb5c5d

Please # to comment.