From ca072917a66c984d3e634718432c4ee2b3bf0da5 Mon Sep 17 00:00:00 2001 From: zhengen Date: Wed, 18 Nov 2026 03:48:29 +0800 Subject: [PATCH] docs: add project memory and maintenance guide Remove the pending seed_own_showcase test cases. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- apps/core/tests.py | 50 ---------------------------- documents/项目记忆与维护指南.md | 59 +++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 50 deletions(-) create mode 100644 documents/项目记忆与维护指南.md diff --git a/apps/core/tests.py b/apps/core/tests.py index 5712fd8..c853d53 100644 --- a/apps/core/tests.py +++ b/apps/core/tests.py @@ -617,53 +617,3 @@ def test_bootstrap_deployment_also_initializes_rbac_groups(monkeypatch): expected_names = {"站点管理员", "编辑", "审核员", "作者", "查看者"} assert expected_names <= set(Group.objects.values_list("name", flat=True)) - - -def test_seed_own_showcase_requires_product_and_case_index(home_page): - """未创建产品栏目/客户案例栏目时应直接报错退出,而不是静默跳过。""" - from django.core.management import CommandError, call_command - - with pytest.raises(CommandError): - call_command("seed_own_showcase") - - -def test_seed_own_showcase_creates_product_and_case_pages(home_page): - """应在产品栏目下创建“世耀CMS”产品页,在客户案例栏目下创建官网自身案例页。""" - from django.core.management import call_command - - from apps.cases.models import CaseStudyIndexPage, CaseStudyPage - from apps.products.models import ProductIndexPage, ProductPage - - product_index = ProductIndexPage(title="产品", slug="products-test") - home_page.add_child(instance=product_index) - case_index = CaseStudyIndexPage(title="客户案例", slug="cases-test") - home_page.add_child(instance=case_index) - - call_command("seed_own_showcase") - - product_page = ProductPage.objects.child_of(product_index).get(slug="shiyao-cms") - assert product_page.title == "世耀CMS" - assert product_page.live is True - - case_page = CaseStudyPage.objects.child_of(case_index).get(slug="shiytech-website") - assert case_page.client_name == "衡水世耀科技有限公司" - assert case_page.live is True - - -def test_seed_own_showcase_is_idempotent(home_page): - """重复执行不应创建重复页面,仅更新已有内容。""" - from django.core.management import call_command - - from apps.cases.models import CaseStudyIndexPage, CaseStudyPage - from apps.products.models import ProductIndexPage, ProductPage - - product_index = ProductIndexPage(title="产品", slug="products-test") - home_page.add_child(instance=product_index) - case_index = CaseStudyIndexPage(title="客户案例", slug="cases-test") - home_page.add_child(instance=case_index) - - call_command("seed_own_showcase") - call_command("seed_own_showcase") - - assert ProductPage.objects.child_of(product_index).filter(slug="shiyao-cms").count() == 1 - assert CaseStudyPage.objects.child_of(case_index).filter(slug="shiytech-website").count() == 1 diff --git a/documents/项目记忆与维护指南.md b/documents/项目记忆与维护指南.md new file mode 100644 index 0000000..836e8fc --- /dev/null +++ b/documents/项目记忆与维护指南.md @@ -0,0 +1,59 @@ +# 项目记忆与维护指南 + +本文用于快速恢复项目上下文。详细设计、部署和测试步骤仍以对应专题文档为准。 + +## 项目结构与边界 + +- 后端仓库根目录:Django + Wagtail,提供内容模型、管理后台、Wagtail API v2 和自定义 API。 +- 前端位于 `wagtailcms-frontend/`,是**独立 Git 仓库**,使用 Next.js/React 消费后端 API。提交前后端改动时应分别在各自仓库提交,不能把前端目录当作后端仓库普通文件加入。 +- 本地联调、测试优先使用 Docker Compose;不需要生成或构建 Visual Studio 解决方案。 +- 浏览器请求使用 `NEXT_PUBLIC_API_URL`;Next.js 服务端在容器内请求后端时使用 `API_INTERNAL_URL`。本地 Compose 中分别对应 `http://localhost:18000` 和 `http://backend:8000`,不要合并成单一地址。 + +## 已有主要能力 + +- 企业官网页面与 StreamField 内容组件,包含首页、博客、产品、案例、解决方案、联系及通用内容页。 +- Wagtail API、自定义表单/线索 API、草稿预览、发布缓存失效、SEO 字段和站点级导航/配置。 +- RBAC 初始化、部署引导、企业开站向导、行业演示模板,以及隐私政策和线索删除申请能力。 +- 这些能力的具体实现状态以[设计方案分析与完善版](./设计方案分析与完善版.md)和源码为准。 + +## 常用验证 + +本地 Docker 环境启动方式、完整验收步骤和清理注意事项见[Docker 本地测试](./Docker本地测试.md)。常用命令: + +```powershell +docker.exe compose -f docker-compose.local.yml up -d --build --wait +docker.exe compose -f docker-compose.local.yml exec -T backend python -m pytest --ds=wagtailcms.settings.docker_local --create-db -q +docker.exe compose -f docker-compose.local.yml exec -T backend python manage.py check +docker.exe compose -f docker-compose.local.yml exec -T backend python manage.py makemigrations --check --dry-run +``` + +前端独立运行 Node 测试、Lint 和生产构建: + +```powershell +Push-Location wagtailcms-frontend +node --test tests/seo.test.cjs tests/site-setup.test.cjs +npm.cmd run lint +npm.cmd run build +Pop-Location +``` + +不要因测试需要清理 Docker 数据卷;只有确认不再需要本地数据时才使用 `down -v`。测试环境配置和凭据不得用于公网部署。 + +## 尚待完成或排期 + +### Phase 1 收尾 + +- 持续完善后端覆盖率;增加前端组件测试、端到端测试,并建立 CI 流水线及 StreamField 前后端 Schema 一致性检查。 +- 当前项目有后端 pytest、前端 Node 测试及 Docker 验收路径;具体执行结果需以最近一次实际运行记录为准。此前记录的 Docker 验收不代表当前改动已经验证。 + +### Phase 2 规划项 + +- 完成 OpenSearch + IK 中文分词 PoC 验证:确认插件加载,接入后端搜索配置,重建索引并验证中文搜索结果。 +- 评估并规划 GraphQL、正式 Wagtail 审核工作流和多语言支持;目前不能把现有 RBAC 发布闸门等同于正式 Workflow。 + +### Phase 3(按业务需要决定) + +- AI 摘要、翻译、SEO 重写。 +- SaaS 化与多租户评估;未有明确业务需求前避免过早引入多租户。 + +路线图的逐项依据见[设计方案 §2.16](./设计方案分析与完善版.md);OpenSearch 技术调研见该文档 §2.10。