知识文章管理插件

插件简介

本插件用于在 Hertz System 内快速搭建知识文章中心，统一沉淀系统使用说明、运维手册、业务知识等内容，为一线同学提供自助查询入口。

• 支持按栏目、标签、关键字对知识进行组织与检索；
• 支持将文章与业务菜单、页面进行关联，点击即可跳转到对应说明；
• 支持基础的阅读统计，帮助你了解高频问题与热门文章。

安装步骤

1. 后端安装（Django）

在部署 Hertz System 的后端虚拟环境中，通过公司私有 PyPI 源安装插件依赖：

pip install hertz-studio-django-wiki -i https://username:password@hzpypi.hzsystems.cn/simple/

安装完成后，在项目的 settings.py 中注册应用：

INSTALLED_APPS += [
    "hertz_studio_django_wiki",
]

保存配置并重新启动后端服务，使知识文章插件生效。

2. 前端集成

在管理端菜单中增加「知识文章」「使用帮助」等入口，并指向知识列表 / 详情页面。

根据实际信息架构调整路由和面包屑，使用户能从业务页面快速跳转到对应的帮助文档。

3. 配置环境变量

根据实际情况，在 .env 或配置中心中补充文章管理相关配置，例如：

KNOWLEDGE_SEARCH_ENABLED=true
KNOWLEDGE_DEFAULT_CATEGORY=产品文档
KNOWLEDGE_ALLOW_ANONYMOUS_READ=false

可根据项目需求调整上述开关，控制是否开启全文搜索、默认栏目以及匿名访问权限。

使用教程

1. 规划知识栏目

在后台「知识分类」中创建产品、运维、实施等栏目，并根据需要配置多级结构。

2. 编写并发布文章

在「知识文章」页面中按模板录入内容，补充标签、适用版本等元信息后发布。

3. 在业务页面挂接

在各业务模块的页面中，通过「帮助」入口跳转到对应文章，或在页面中嵌入知识链接。