Skip to content

如何使用与贡献 ​

本站是什么 ​

Wood 大数据知识体系 是一套面向一线数据开发的中文知识库:按岗位路径与技术域组织,强调可落地步骤、常见坑与验收方式。

同仓库下的微信小程序(miniprogram/)侧重刷题与速记;本站(website/)侧重体系化阅读与工程实践。二者内容互补,互不覆盖。

本地运行 ​

在仓库中进入本站目录:

bash
cd website
npm install
npm run docs:dev

浏览器打开终端提示的本地地址(通常是 http://localhost:5173)。

构建与预览:

bash
npm run docs:build
npm run docs:preview

目录约定 ​

内容根目录为 docs/:

路径含义
index.md首页与知识地图概览
guide/使用与贡献说明
map/岗位路径 × 技术域总图
warehouse/数仓分层与建模
hive/ spark/ flink/批/流引擎
kafka/ realtime/ quality/消息、实时、质量

侧边栏在 docs/.vitepress/config.mts 中维护;新增章节时请同步更新 config。

内容规则(必读) ​

只收录可落地内容,拒绝空泛理论堆砌。每篇尽量包含:

  1. 何时用:适用场景与不适用边界
  2. 怎么做:可执行步骤(DDL / 作业 / 配置)
  3. 常见坑:生产里真实踩过的坑
  4. 如何验证:检查 SQL、对账、监控指标

示例旗舰文:数仓分层实践(ODS→ADS)

如何贡献 ​

  1. 在对应技术域目录新增或修改 Markdown
  2. 更新 config.mts 侧边栏链接
  3. 本地 npm run docs:build 通过后再提交
  4. 标题与正文使用中文;代码与路径保持可复制

欢迎把一线踩坑写成「步骤 + 验收」格式,比长篇概念综述更有价值。

相关约定 ​