feat: 添加文档站点结构规划和核心分类

- 创建 CONTENT-PLANNING.md 详细规划文档
- 建立 6 大核心分类目录结构
  - DevOps(GitOps、CI/CD、基础设施)
  - 数据分析(n8n、可视化、ETL)
  - AI/ML(LLM、模型服务、AI 应用)
  - 可观测性(日志、链路、监控)
  - 项目管理(Plane、敏捷、协作)
  - 架构、安全、案例研究、资源中心

- 创建各分类索引页面,包含:
  - 系列文章规划
  - 快速导航卡片
  - 核心工具介绍
  - 架构图和最佳实践

- 更新导航菜单,支持下拉分类导航
- 支持 40-60 篇技术文档的扩展

规划内容:
- 文档元数据规范
- 4 周内容发布计划
- 标签系统设计
- SEO 优化策略
- 文档模板和审核清单

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
This commit is contained in:
2026-01-23 21:45:57 +08:00
co-authored by Claude Sonnet 4.5
parent d803f6f899
commit d8afd136e2
8 changed files with 1329 additions and 2 deletions
+485
View File
@@ -0,0 +1,485 @@
# LJWX Docs 文档站点结构规划
## 📋 项目概述
**目标**:在未来一个月内发布 40-60 篇专业技术实践文档
**用途**:公司项目宣传、技术分享、最佳实践展示
## 🗂️ 目录结构设计
### 方案一:按技术领域分类(推荐)
```
docs/
├── index.md # 首页
├── QUICK-REFERENCE.md # 快速参考
├── visual-test.md # 视觉测试
│
├── devops/ # DevOps 实践
│ ├── index.md # DevOps 分类首页
│ ├── gitops/ # GitOps 系列
│ │ ├── index.md # GitOps 系列索引
│ │ ├── gitea-setup.md # Gitea 私有化部署
│ │ ├── harbor-registry.md # Harbor 镜像仓库
│ │ ├── argocd-deployment.md # Argo CD 持续部署
│ │ └── gitops-workflow.md # GitOps 完整工作流
│ ├── ci-cd/ # CI/CD 系列
│ │ ├── index.md
│ │ ├── github-actions.md
│ │ └── jenkins-pipeline.md
│ └── infrastructure/ # 基础设施
│ ├── kubernetes-best-practices.md
│ └── docker-optimization.md
│
├── data-analytics/ # 数据分析
│ ├── index.md # 数据分析分类首页
│ ├── n8n/ # n8n 系列
│ │ ├── index.md # n8n 系列索引
│ │ ├── n8n-introduction.md # n8n 介绍
│ │ ├── n8n-data-pipeline.md # n8n 数据管道
│ │ ├── n8n-automation.md # n8n 自动化实践
│ │ └── n8n-integration.md # n8n 集成案例
│ ├── visualization/ # 数据可视化
│ │ ├── grafana-dashboard.md
│ │ └── superset-analytics.md
│ └── etl/ # ETL 工具
│ └── airflow-workflow.md
│
├── ai-ml/ # AI 与机器学习
│ ├── index.md # AI/ML 分类首页
│ ├── llm/ # 大语言模型
│ │ ├── index.md # LLM 系列索引
│ │ ├── qwen-deployment.md # 千问模型部署
│ │ ├── qwen-health-report.md # 千问解读健康报告
│ │ ├── llm-optimization.md # 模型优化
│ │ └── prompt-engineering.md # 提示词工程
│ ├── model-serving/ # 模型服务
│ │ └── ollama-deployment.md
│ └── applications/ # AI 应用
│ ├── chatbot-development.md
│ └── rag-implementation.md
│
├── observability/ # 可观测性
│ ├── index.md # 可观测性分类首页
│ ├── logging/ # 日志管理
│ │ ├── index.md # 日志系列索引
│ │ ├── loki-setup.md # Loki 日志系统
│ │ ├── elasticsearch-logging.md # ELK 日志方案
│ │ └── log-best-practices.md # 日志最佳实践
│ ├── tracing/ # 链路追踪
│ │ ├── jaeger-tracing.md # Jaeger 链路追踪
│ │ ├── tempo-setup.md # Tempo 配置
│ │ └── distributed-tracing.md # 分布式追踪
│ └── metrics/ # 指标监控
│ ├── prometheus-monitoring.md # Prometheus 监控
│ ├── grafana-dashboard.md # Grafana 仪表板
│ └── alerting-rules.md # 告警规则
│
├── project-management/ # 项目管理
│ ├── index.md # 项目管理分类首页
│ ├── plane/ # Plane 系列
│ │ ├── index.md # Plane 系列索引
│ │ ├── plane-deployment.md # Plane 私有化部署
│ │ ├── plane-workflow.md # Plane 工作流配置
│ │ ├── plane-best-practices.md # Plane 最佳实践
│ │ └── plane-integration.md # Plane 集成方案
│ ├── agile/ # 敏捷开发
│ │ └── scrum-practices.md
│ └── collaboration/ # 协作工具
│ └── notion-workspace.md
│
├── architecture/ # 架构设计
│ ├── index.md # 架构分类首页
│ ├── microservices/ # 微服务架构
│ │ ├── service-mesh.md
│ │ └── api-gateway.md
│ ├── cloud-native/ # 云原生
│ │ └── kubernetes-patterns.md
│ └── system-design/ # 系统设计
│ └── high-availability.md
│
├── security/ # 安全实践
│ ├── index.md # 安全分类首页
│ ├── authentication/ # 认证授权
│ │ └── oauth2-implementation.md
│ └── compliance/ # 合规性
│ └── data-privacy.md
│
├── case-studies/ # 案例研究
│ ├── index.md # 案例研究首页
│ ├── e-commerce-platform.md # 电商平台案例
│ ├── healthcare-system.md # 医疗系统案例
│ └── fintech-solution.md # 金融科技案例
│
└── resources/ # 资源中心
├── index.md # 资源中心首页
├── tools.md # 工具推荐
├── books.md # 书籍推荐
└── glossary.md # 术语表
```
### 方案二:按应用场景分类
```
docs/
├── solutions/ # 解决方案
│ ├── private-cloud/ # 私有云方案
│ ├── data-platform/ # 数据平台方案
│ └── ai-platform/ # AI 平台方案
│
├── practices/ # 实践指南
│ ├── development/ # 开发实践
│ ├── operations/ # 运维实践
│ └── management/ # 管理实践
│
└── tutorials/ # 教程系列
├── beginner/ # 入门教程
├── intermediate/ # 进阶教程
└── advanced/ # 高级教程
```
## 📝 文档元数据规范
每篇文档应包含以下 frontmatter:
```yaml
---
title: 文档标题
description: 文档描述(用于 SEO)
date: 2026-01-23
author: 作者名称
category: devops | data-analytics | ai-ml | observability | project-management
tags:
- gitops
- kubernetes
- argocd
series: GitOps 实践系列
seriesOrder: 1
difficulty: beginner | intermediate | advanced
readingTime: 15 min
featured: true
cover: /images/covers/gitops.jpg
---
```
## 🎯 内容规划示例
### 第一周(10-12 篇)
**DevOps 系列**
1. ✅ Gitea 私有化部署完整指南
2. ✅ Harbor 镜像仓库搭建与配置
3. ✅ Argo CD 实现 GitOps 持续部署
4. ✅ 打造完整的私有 GitOps 工作流
**数据分析系列**
5. ✅ n8n 介绍:低代码自动化平台
6. ✅ n8n 在数据分析中的应用
7. ✅ n8n 构建数据采集管道
**项目管理系列**
8. ✅ Plane 私有化部署指南
9. ✅ Plane 在中小型项目中的最佳实践
10. ✅ Plane 与 GitOps 的集成
### 第二周(10-12 篇)
**AI/ML 系列**
11. ✅ 千问大模型私有化部署
12. ✅ 千问解读健康测试报告实战
13. ✅ LLM 提示词工程最佳实践
14. ✅ RAG 系统构建指南
**可观测性系列**
15. ✅ Prometheus + Grafana 监控体系
16. ✅ Loki 日志聚合系统搭建
17. ✅ Jaeger 分布式链路追踪
18. ✅ 优雅管理链路、日志和 Metrics
### 第三周(10-12 篇)
**架构设计系列**
19. ✅ 微服务架构设计模式
20. ✅ Kubernetes 生产环境最佳实践
21. ✅ 服务网格 Istio 实践
22. ✅ API 网关设计与实现
**安全实践系列**
23. ✅ OAuth2 认证授权实现
24. ✅ Kubernetes 安全加固
25. ✅ 数据加密与隐私保护
### 第四周(10-12 篇)
**案例研究系列**
26. ✅ 电商平台技术架构演进
27. ✅ 医疗系统私有化部署案例
28. ✅ 金融科技 DevOps 实践
**工具链系列**
29. ✅ MinIO 对象存储实践
30. ✅ PostgreSQL 高可用方案
31. ✅ Redis 缓存架构设计
## 🎨 导航结构配置
### 主导航
```typescript
nav: [
{ text: '首页', link: '/' },
{ text: '快速开始', link: '/QUICK-REFERENCE' },
{
text: 'DevOps',
items: [
{ text: 'GitOps 实践', link: '/devops/gitops/' },
{ text: 'CI/CD', link: '/devops/ci-cd/' },
{ text: '基础设施', link: '/devops/infrastructure/' }
]
},
{
text: '数据分析',
items: [
{ text: 'n8n 自动化', link: '/data-analytics/n8n/' },
{ text: '数据可视化', link: '/data-analytics/visualization/' },
{ text: 'ETL 工具', link: '/data-analytics/etl/' }
]
},
{
text: 'AI/ML',
items: [
{ text: '大语言模型', link: '/ai-ml/llm/' },
{ text: '模型服务', link: '/ai-ml/model-serving/' },
{ text: 'AI 应用', link: '/ai-ml/applications/' }
]
},
{
text: '可观测性',
items: [
{ text: '日志管理', link: '/observability/logging/' },
{ text: '链路追踪', link: '/observability/tracing/' },
{ text: '指标监控', link: '/observability/metrics/' }
]
},
{
text: '项目管理',
items: [
{ text: 'Plane 实践', link: '/project-management/plane/' },
{ text: '敏捷开发', link: '/project-management/agile/' }
]
},
{
text: '更多',
items: [
{ text: '架构设计', link: '/architecture/' },
{ text: '安全实践', link: '/security/' },
{ text: '案例研究', link: '/case-studies/' },
{ text: '资源中心', link: '/resources/' }
]
}
]
```
## 🏷️ 标签系统
建议使用的标签:
**技术栈标签**
- `kubernetes`, `docker`, `gitops`, `argocd`, `gitea`, `harbor`
- `n8n`, `grafana`, `prometheus`, `loki`, `jaeger`
- `plane`, `jira`, `notion`
- `llm`, `qwen`, `ollama`, `rag`
- `postgresql`, `redis`, `minio`, `elasticsearch`
**场景标签**
- `private-deployment`, `cloud-native`, `microservices`
- `data-pipeline`, `automation`, `monitoring`
- `ci-cd`, `devops`, `gitops`
- `project-management`, `agile`
**难度标签**
- `beginner`, `intermediate`, `advanced`
## 📊 首页设计建议
### Hero 区域
- 突出公司技术实力
- 展示文档数量和更新频率
- 快速导航到热门分类
### 特色文章
- 最新发布的 6 篇文章
- 精选推荐文章
- 系列文章展示
### 分类导航
- 6 大主要分类卡片
- 每个分类显示文章数量
- 快速跳转
### 统计数据
- 总文章数
- 覆盖技术栈数量
- 代码示例数量
- 实战案例数量
## 🔍 搜索优化
### 搜索配置
```typescript
search: {
provider: 'local',
options: {
miniSearch: {
searchOptions: {
fuzzy: 0.2,
prefix: true,
boost: {
title: 4,
text: 2,
titles: 1
}
}
}
}
}
```
## 📈 SEO 优化
### 站点地图
- 自动生成 sitemap.xml
- 提交到搜索引擎
### Meta 标签
- 每篇文章独立的 title 和 description
- Open Graph 标签支持社交分享
- 结构化数据(JSON-LD)
## 🎯 实施步骤
### 第一阶段:基础结构(1-2 天)
1. ✅ 创建目录结构
2. ✅ 配置导航和侧边栏
3. ✅ 创建分类索引页面
4. ✅ 设置文档模板
### 第二阶段:内容迁移(1 天)
1. ✅ 迁移现有文档到新结构
2. ✅ 添加元数据
3. ✅ 更新内部链接
### 第三阶段:功能增强(2-3 天)
1. ✅ 添加标签页面
2. ✅ 实现系列文章导航
3. ✅ 添加阅读时间估算
4. ✅ 实现相关文章推荐
### 第四阶段:内容创作(持续)
1. ✅ 按计划创作文档
2. ✅ 定期审核和更新
3. ✅ 收集用户反馈
## 📝 文档模板
### 技术实践文档模板
```markdown
---
title: 文档标题
description: 简短描述
date: 2026-01-23
author: 作者名
category: devops
tags: [gitops, kubernetes]
series: GitOps 实践系列
seriesOrder: 1
difficulty: intermediate
readingTime: 15 min
---
# 文档标题
## 📋 概述
简要介绍本文内容和目标。
## 🎯 适用场景
- 场景 1
- 场景 2
## 🔧 前置要求
- 要求 1
- 要求 2
## 📖 正文内容
### 步骤 1:准备工作
### 步骤 2:配置
### 步骤 3:部署
## 💡 最佳实践
## ⚠️ 常见问题
## 🔗 相关资源
## 📝 总结
```
## 🎨 视觉元素
### 封面图片
- 尺寸:1200x630px
- 存储:`docs/public/images/covers/`
- 命名:`category-topic.jpg`
### 图表和截图
- 存储:`docs/public/images/articles/`
- 或使用 MinIO:`http://192.168.1.83:32001/ljwx-docs/images/`
### 视频
- 存储:MinIO `http://192.168.1.83:32001/ljwx-docs/videos/`
## 📊 内容管理
### Git 工作流
```bash
# 创建新文档分支
git checkout -b docs/gitops-argocd
# 编写文档
# ...
# 提交
git add .
git commit -m "docs: 添加 Argo CD 部署指南"
# 推送并创建 PR
git push origin docs/gitops-argocd
```
### 文档审核清单
- [ ] 标题清晰准确
- [ ] 元数据完整
- [ ] 代码示例可运行
- [ ] 图片清晰
- [ ] 链接有效
- [ ] 语法正确
- [ ] SEO 优化
## 🚀 下一步行动
1. **立即执行**:创建目录结构
2. **本周完成**:配置导航和首页
3. **持续进行**:按计划创作内容
4. **定期审核**:每周回顾和优化
---
**文档版本**:v1.0
**创建日期**:2026-01-23
**维护者**:brunogao
+49 -2
View File
@@ -23,8 +23,55 @@ export default withMermaid(defineConfig({
nav: [
{ text: '首页', link: '/' },
{ text: '快速开始', link: '/QUICK-REFERENCE' },
{ text: '指南', link: '/guide/' },
{ text: '视觉测试', link: '/visual-test' }
{
text: 'DevOps',
items: [
{ text: 'GitOps 实践', link: '/devops/gitops/' },
{ text: 'CI/CD', link: '/devops/ci-cd/' },
{ text: '基础设施', link: '/devops/infrastructure/' }
]
},
{
text: '数据分析',
items: [
{ text: 'n8n 自动化', link: '/data-analytics/n8n/' },
{ text: '数据可视化', link: '/data-analytics/visualization/' },
{ text: 'ETL 工具', link: '/data-analytics/etl/' }
]
},
{
text: 'AI/ML',
items: [
{ text: '大语言模型', link: '/ai-ml/llm/' },
{ text: '模型服务', link: '/ai-ml/model-serving/' },
{ text: 'AI 应用', link: '/ai-ml/applications/' }
]
},
{
text: '可观测性',
items: [
{ text: '日志管理', link: '/observability/logging/' },
{ text: '链路追踪', link: '/observability/tracing/' },
{ text: '指标监控', link: '/observability/metrics/' }
]
},
{
text: '项目管理',
items: [
{ text: 'Plane 实践', link: '/project-management/plane/' },
{ text: '敏捷开发', link: '/project-management/agile/' }
]
},
{
text: '更多',
items: [
{ text: '架构设计', link: '/architecture/' },
{ text: '安全实践', link: '/security/' },
{ text: '案例研究', link: '/case-studies/' },
{ text: '资源中心', link: '/resources/' },
{ text: '视觉测试', link: '/visual-test' }
]
}
],
sidebar: {
+102
View File
@@ -0,0 +1,102 @@
---
title: AI 与机器学习
description: 大语言模型、模型服务和 AI 应用实践
---
# AI 与机器学习
探索 AI 和机器学习的实践应用,包括大语言模型部署、模型服务和 AI 应用开发。
## 📚 系列文章
### 大语言模型系列
私有化部署和应用大语言模型。
- [千问大模型私有化部署指南](./llm/qwen-deployment)
- [千问解读健康测试报告实战](./llm/qwen-health-report)
- [LLM 提示词工程最佳实践](./llm/prompt-engineering)
- [RAG 系统构建指南](./llm/rag-implementation)
### 模型服务系列
模型部署和服务化的最佳实践。
- Ollama 本地模型部署
- vLLM 高性能推理服务
- TensorRT 模型优化
### AI 应用系列
构建实用的 AI 应用。
- 智能客服机器人开发
- 文档问答系统实现
- 代码助手构建指南
## 🎯 快速导航
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); gap: 20px; margin: 30px 0;">
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>🤖 大语言模型</h3>
<p>私有化部署千问、Llama 等开源模型</p>
<a href="./llm/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>⚡ 模型服务</h3>
<p>高性能模型推理和服务化部署</p>
<a href="./model-serving/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>💡 AI 应用</h3>
<p>构建实用的 AI 驱动应用</p>
<a href="./applications/">查看文章 →</a>
</div>
</div>
## 🛠️ 核心技术
- **千问(Qwen)** - 阿里云开源大语言模型
- **Ollama** - 本地 LLM 运行工具
- **LangChain** - LLM 应用开发框架
- **ChromaDB** - 向量数据库
- **FastAPI** - 高性能 API 框架
## 💡 应用场景
::: tip 健康报告解读
使用千问模型自动解读医疗健康测试报告,提供专业建议。
:::
::: tip 智能客服
构建基于 LLM 的智能客服系统,提升用户体验。
:::
::: tip 文档问答
实现 RAG 系统,对企业文档进行智能问答。
:::
## 🏗️ 典型架构
```mermaid
graph TB
User[用户] --> API[API 网关]
API --> LLM[LLM 服务]
API --> Vector[向量数据库]
LLM --> Qwen[千问模型]
Vector --> Chroma[ChromaDB]
subgraph "模型层"
Qwen
end
subgraph "数据层"
Chroma
Docs[文档库]
end
Chroma --> Docs
```
+79
View File
@@ -0,0 +1,79 @@
---
title: 数据分析
description: n8n 自动化、数据可视化和 ETL 工具实践
---
# 数据分析
探索现代数据分析工具和实践,包括 n8n 自动化平台、数据可视化和 ETL 流程。
## 📚 系列文章
### n8n 自动化系列
使用 n8n 构建强大的数据采集和处理管道。
- [n8n 介绍:低代码自动化平台](./n8n/n8n-introduction)
- [n8n 在数据分析中的应用](./n8n/n8n-data-analytics)
- [n8n 构建数据采集管道](./n8n/n8n-data-pipeline)
- [n8n 自动化实践案例](./n8n/n8n-automation)
### 数据可视化系列
打造专业的数据可视化仪表板。
- Grafana 仪表板设计
- Superset 数据分析平台
- Metabase 商业智能工具
### ETL 工具系列
数据提取、转换和加载的最佳实践。
- Apache Airflow 工作流编排
- dbt 数据转换工具
- Airbyte 数据集成平台
## 🎯 快速导航
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); gap: 20px; margin: 30px 0;">
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>🔄 n8n 自动化</h3>
<p>低代码自动化平台,构建数据管道</p>
<a href="./n8n/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>📊 数据可视化</h3>
<p>专业的数据可视化和仪表板工具</p>
<a href="./visualization/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>⚙️ ETL 工具</h3>
<p>数据提取、转换和加载工具链</p>
<a href="./etl/">查看文章 →</a>
</div>
</div>
## 🛠️ 核心工具
- **n8n** - 低代码自动化平台
- **Grafana** - 开源可视化平台
- **Apache Airflow** - 工作流编排工具
- **Superset** - 现代数据探索平台
- **dbt** - 数据转换工具
## 💡 应用场景
::: tip 数据采集
使用 n8n 自动采集多源数据,构建统一的数据仓库。
:::
::: tip 实时监控
通过 Grafana 实时监控业务指标和系统性能。
:::
::: tip 数据分析
使用 Superset 进行交互式数据探索和分析。
:::
+204
View File
@@ -0,0 +1,204 @@
---
title: GitOps 实践系列
description: 使用 Gitea、Harbor 和 Argo CD 打造完整的私有 GitOps 工作流
series: GitOps 实践
---
# GitOps 实践系列
## 📖 系列概述
本系列文章将指导您从零开始搭建完整的私有 GitOps 工作流,包括:
- **Gitea** - 轻量级私有 Git 服务
- **Harbor** - 企业级容器镜像仓库
- **Argo CD** - 声明式 GitOps 持续部署工具
## 📚 系列文章
### 1. Gitea 私有化部署完整指南
**状态**:📝 规划中
学习如何部署和配置 Gitea,打造私有的 Git 代码托管平台。
**内容包括**:
- Gitea 架构介绍
- Docker/Kubernetes 部署方式
- 数据库配置
- HTTPS 配置
- 用户和权限管理
- 备份和恢复
[查看文章 →](./gitea-setup)
---
### 2. Harbor 镜像仓库搭建与配置
**状态**:📝 规划中
搭建企业级容器镜像仓库,实现镜像的安全存储和分发。
**内容包括**:
- Harbor 架构和组件
- 高可用部署方案
- 镜像扫描和签名
- 镜像复制和同步
- 访问控制和审计
- 与 CI/CD 集成
[查看文章 →](./harbor-registry)
---
### 3. Argo CD 实现 GitOps 持续部署
**状态**:📝 规划中
使用 Argo CD 实现基于 Git 的声明式应用部署。
**内容包括**:
- Argo CD 核心概念
- 安装和配置
- Application 定义
- 多集群管理
- 自动同步策略
- Webhook 集成
- RBAC 权限控制
[查看文章 →](./argocd-deployment)
---
### 4. 打造完整的私有 GitOps 工作流
**状态**:📝 规划中
整合 Gitea、Harbor 和 Argo CD,构建端到端的 GitOps 工作流。
**内容包括**:
- 完整架构设计
- 代码提交到部署的完整流程
- CI/CD 流水线配置
- 环境管理(开发/测试/生产)
- 回滚和灾难恢复
- 监控和告警
- 最佳实践和常见问题
[查看文章 →](./gitops-workflow)
## 🎯 学习路径
```mermaid
graph LR
A[Gitea 部署] --> B[Harbor 配置]
B --> C[Argo CD 安装]
C --> D[完整工作流]
style A fill:#e1f5ff
style B fill:#e1f5ff
style C fill:#e1f5ff
style D fill:#c8e6c9
```
## 🏗️ 架构图
```mermaid
graph TB
subgraph "开发者"
Dev[开发者]
end
subgraph "Git 仓库"
Gitea[Gitea<br/>代码仓库]
end
subgraph "CI/CD"
CI[CI Pipeline<br/>构建 & 测试]
Harbor[Harbor<br/>镜像仓库]
end
subgraph "GitOps"
ArgoCD[Argo CD<br/>持续部署]
end
subgraph "Kubernetes"
K8s[Kubernetes<br/>应用运行]
end
Dev -->|1. Push Code| Gitea
Gitea -->|2. Trigger| CI
CI -->|3. Build Image| Harbor
Harbor -->|4. Store| Harbor
Gitea -->|5. Update Manifest| Gitea
ArgoCD -->|6. Watch| Gitea
ArgoCD -->|7. Pull Image| Harbor
ArgoCD -->|8. Deploy| K8s
```
## 💡 为什么选择 GitOps?
### 优势
✅ **声明式配置** - 所有配置存储在 Git 中,易于版本控制
✅ **自动化部署** - Git 提交自动触发部署,减少人为错误
✅ **可审计性** - 所有变更都有完整的 Git 历史记录
✅ **快速回滚** - 通过 Git revert 快速回滚到任意版本
✅ **一致性** - 确保集群状态与 Git 仓库保持一致
### 适用场景
- 🏢 企业私有云环境
- 🔒 对数据安全有严格要求
- 👥 多团队协作开发
- 🌍 多环境部署(开发/测试/生产)
- 📊 需要完整的审计追踪
## 🛠️ 技术栈
| 组件 | 版本 | 用途 |
|------|------|------|
| Gitea | 1.21+ | Git 代码托管 |
| Harbor | 2.10+ | 容器镜像仓库 |
| Argo CD | 2.10+ | GitOps 部署工具 |
| Kubernetes | 1.28+ | 容器编排平台 |
| PostgreSQL | 15+ | 数据库 |
| Redis | 7+ | 缓存 |
## 📋 前置要求
在开始本系列之前,您需要:
- ✅ 基本的 Linux 命令行知识
- ✅ 了解 Docker 和容器化概念
- ✅ 熟悉 Kubernetes 基础
- ✅ 了解 Git 基本操作
- ✅ 一个 Kubernetes 集群(可以是本地 Minikube 或云端集群)
## 🎓 学习目标
完成本系列后,您将能够:
- ✅ 独立部署和配置 Gitea、Harbor 和 Argo CD
- ✅ 设计和实现完整的 GitOps 工作流
- ✅ 实现自动化的 CI/CD 流水线
- ✅ 管理多环境的应用部署
- ✅ 处理常见的 GitOps 场景和问题
## 🔗 相关资源
- [Gitea 官方文档](https://docs.gitea.io/)
- [Harbor 官方文档](https://goharbor.io/docs/)
- [Argo CD 官方文档](https://argo-cd.readthedocs.io/)
- [GitOps 工作组](https://opengitops.dev/)
## 💬 讨论和反馈
如果您在学习过程中遇到问题,欢迎:
- 📝 在 [GitHub Issues](https://github.com/BrunoGao/ljwx-docs/issues) 提问
- 💬 在 [GitHub Discussions](https://github.com/BrunoGao/ljwx-docs/discussions) 讨论
- 📧 联系作者:brunogao
---
**系列状态**:📝 规划中
**预计完成时间**:2026年2月
**难度等级**:⭐⭐⭐ 中级
+86
View File
@@ -0,0 +1,86 @@
---
title: DevOps 实践
description: DevOps 工具链、GitOps、CI/CD 和基础设施最佳实践
---
# DevOps 实践
探索现代 DevOps 实践,包括 GitOps 工作流、CI/CD 流水线、容器化和基础设施即代码。
## 📚 系列文章
### GitOps 实践系列
打造完整的私有 GitOps 工作流,实现高效的持续部署。
- [Gitea 私有化部署完整指南](./gitops/gitea-setup)
- [Harbor 镜像仓库搭建与配置](./gitops/harbor-registry)
- [Argo CD 实现 GitOps 持续部署](./gitops/argocd-deployment)
- [打造完整的私有 GitOps 工作流](./gitops/gitops-workflow)
### CI/CD 系列
持续集成和持续部署的最佳实践。
- GitHub Actions 实战指南
- Jenkins Pipeline 配置
- GitLab CI/CD 实践
### 基础设施系列
容器化和编排平台的生产环境实践。
- Kubernetes 生产环境最佳实践
- Docker 镜像优化技巧
- Helm Chart 开发指南
## 🎯 快速导航
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); gap: 20px; margin: 30px 0;">
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>🔄 GitOps</h3>
<p>基于 Git 的声明式基础设施和应用部署</p>
<a href="./gitops/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>⚙️ CI/CD</h3>
<p>自动化构建、测试和部署流水线</p>
<a href="./ci-cd/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>🏗️ 基础设施</h3>
<p>容器化、编排和基础设施即代码</p>
<a href="./infrastructure/">查看文章 →</a>
</div>
</div>
## 🛠️ 核心工具
- **Gitea** - 轻量级 Git 服务
- **Harbor** - 企业级镜像仓库
- **Argo CD** - GitOps 持续部署
- **Kubernetes** - 容器编排平台
- **Docker** - 容器化技术
- **Helm** - Kubernetes 包管理器
## 💡 最佳实践
::: tip 基础设施即代码
使用 Git 管理所有基础设施配置,实现版本控制和可追溯性。
:::
::: tip 自动化优先
尽可能自动化所有重复性任务,减少人为错误。
:::
::: tip 安全第一
在 CI/CD 流程中集成安全扫描,及早发现漏洞。
:::
## 📖 相关资源
- [Kubernetes 官方文档](https://kubernetes.io/docs/)
- [Argo CD 文档](https://argo-cd.readthedocs.io/)
- [CNCF 云原生全景图](https://landscape.cncf.io/)
+172
View File
@@ -0,0 +1,172 @@
---
title: 可观测性
description: 日志管理、链路追踪和指标监控的完整解决方案
---
# 可观测性
构建完整的可观测性体系,包括日志聚合、分布式链路追踪和指标监控。
## 📚 系列文章
### 日志管理系列
集中式日志收集、存储和分析。
- [Loki 日志聚合系统搭建](./logging/loki-setup)
- [Elasticsearch 日志方案](./logging/elasticsearch-logging)
- [日志管理最佳实践](./logging/log-best-practices)
### 链路追踪系列
分布式系统的链路追踪和性能分析。
- [Jaeger 分布式链路追踪](./tracing/jaeger-tracing)
- [Tempo 链路追踪配置](./tracing/tempo-setup)
- [分布式追踪最佳实践](./tracing/distributed-tracing)
### 指标监控系列
系统和应用的指标采集与监控。
- [Prometheus 监控体系搭建](./metrics/prometheus-monitoring)
- [Grafana 仪表板设计](./metrics/grafana-dashboard)
- [告警规则配置指南](./metrics/alerting-rules)
## 🎯 快速导航
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); gap: 20px; margin: 30px 0;">
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>📝 日志管理</h3>
<p>集中式日志收集、存储和分析</p>
<a href="./logging/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>🔍 链路追踪</h3>
<p>分布式系统的请求链路追踪</p>
<a href="./tracing/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>📊 指标监控</h3>
<p>系统和应用的实时监控告警</p>
<a href="./metrics/">查看文章 →</a>
</div>
</div>
## 🛠️ 核心工具
- **Prometheus** - 指标采集和存储
- **Grafana** - 可视化和仪表板
- **Loki** - 日志聚合系统
- **Jaeger** - 分布式链路追踪
- **Tempo** - 分布式追踪后端
- **AlertManager** - 告警管理
## 💡 三大支柱
可观测性的三大支柱:
::: tip Metrics(指标)
通过 Prometheus 采集系统和应用指标,实时监控性能和健康状态。
:::
::: tip Logs(日志)
使用 Loki 集中管理日志,快速定位和排查问题。
:::
::: tip Traces(链路)
通过 Jaeger 追踪分布式请求链路,分析性能瓶颈。
:::
## 🏗️ 完整架构
```mermaid
graph TB
subgraph "应用层"
App1[应用 1]
App2[应用 2]
App3[应用 3]
end
subgraph "采集层"
Prom[Prometheus]
Loki[Loki]
Jaeger[Jaeger]
end
subgraph "存储层"
PromDB[(Prometheus DB)]
LokiDB[(Loki Storage)]
JaegerDB[(Jaeger Storage)]
end
subgraph "展示层"
Grafana[Grafana]
Alert[AlertManager]
end
App1 -->|Metrics| Prom
App2 -->|Metrics| Prom
App3 -->|Metrics| Prom
App1 -->|Logs| Loki
App2 -->|Logs| Loki
App3 -->|Logs| Loki
App1 -->|Traces| Jaeger
App2 -->|Traces| Jaeger
App3 -->|Traces| Jaeger
Prom --> PromDB
Loki --> LokiDB
Jaeger --> JaegerDB
PromDB --> Grafana
LokiDB --> Grafana
JaegerDB --> Grafana
Prom --> Alert
```
## 📖 最佳实践
### 1. 统一标签规范
使用一致的标签命名规范,便于关联不同维度的数据:
```yaml
labels:
app: myapp
env: production
cluster: k8s-prod
namespace: default
```
### 2. 合理的采集频率
- **高频指标**(CPU、内存):15-30秒
- **中频指标**(请求量、错误率):1分钟
- **低频指标**(磁盘使用):5分钟
### 3. 告警分级
- **P0**:影响核心业务,需要立即处理
- **P1**:影响部分功能,1小时内处理
- **P2**:性能下降,工作时间处理
- **P3**:优化建议,计划处理
## 🎓 学习路径
1. **基础**:了解可观测性概念和三大支柱
2. **实践**:搭建 Prometheus + Grafana 监控系统
3. **进阶**:集成 Loki 日志和 Jaeger 链路追踪
4. **优化**:调优性能、配置告警、建立 SLO
## 🔗 相关资源
- [Prometheus 官方文档](https://prometheus.io/docs/)
- [Grafana 官方文档](https://grafana.com/docs/)
- [Loki 官方文档](https://grafana.com/docs/loki/)
- [Jaeger 官方文档](https://www.jaegertracing.io/docs/)
+152
View File
@@ -0,0 +1,152 @@
---
title: 项目管理
description: Plane、敏捷开发和团队协作工具实践
---
# 项目管理
探索现代项目管理工具和敏捷开发实践,提升团队协作效率。
## 📚 系列文章
### Plane 实践系列
使用 Plane 进行高效的项目管理。
- [Plane 私有化部署指南](./plane/plane-deployment)
- [Plane 在中小型项目中的最佳实践](./plane/plane-best-practices)
- [Plane 工作流配置](./plane/plane-workflow)
- [Plane 与 GitOps 集成](./plane/plane-integration)
### 敏捷开发系列
敏捷方法论和实践。
- Scrum 实践指南
- 看板方法应用
- 敏捷估算技巧
### 协作工具系列
团队协作和知识管理工具。
- Notion 工作空间搭建
- Confluence 知识库管理
- Miro 协作白板应用
## 🎯 快速导航
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); gap: 20px; margin: 30px 0;">
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>✈️ Plane</h3>
<p>开源的项目管理和问题追踪工具</p>
<a href="./plane/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>🏃 敏捷开发</h3>
<p>Scrum、看板等敏捷方法论实践</p>
<a href="./agile/">查看文章 →</a>
</div>
<div style="padding: 20px; border: 1px solid var(--vp-c-divider); border-radius: 12px;">
<h3>🤝 协作工具</h3>
<p>团队协作和知识管理工具</p>
<a href="./collaboration/">查看文章 →</a>
</div>
</div>
## 🛠️ 核心工具
- **Plane** - 开源项目管理平台
- **Jira** - 企业级项目管理
- **Linear** - 现代问题追踪工具
- **Notion** - 全能工作空间
- **Miro** - 在线协作白板
## 💡 为什么选择 Plane?
### 优势
✅ **开源免费** - 完全开源,可私有化部署
✅ **现代界面** - 简洁美观的用户界面
✅ **功能完整** - 项目、问题、迭代、路线图
✅ **高度可定制** - 灵活的工作流配置
✅ **API 友好** - 完善的 REST API
### 适用场景
- 🏢 中小型团队项目管理
- 💻 软件开发项目追踪
- 🎯 敏捷开发实践
- 🔒 需要私有化部署
- 💰 预算有限的团队
## 🏗️ Plane 架构
```mermaid
graph TB
subgraph "前端"
Web[Web 应用]
Mobile[移动端]
end
subgraph "后端服务"
API[API 服务]
Worker[后台任务]
end
subgraph "数据层"
PG[(PostgreSQL)]
Redis[(Redis)]
MinIO[(MinIO)]
end
Web --> API
Mobile --> API
API --> PG
API --> Redis
API --> MinIO
Worker --> PG
Worker --> Redis
```
## 📖 最佳实践
### 1. 项目结构
```
项目
├── 迭代(Sprint)
│ ├── 用户故事
│ ├── 任务
│ └── Bug
├── 路线图
└── 文档
```
### 2. 工作流配置
```
待办 → 进行中 → 代码审查 → 测试 → 完成
```
### 3. 标签体系
- **优先级**:P0, P1, P2, P3
- **类型**:Feature, Bug, Task, Improvement
- **模块**:Frontend, Backend, DevOps, Design
## 🎓 学习路径
1. **入门**:了解 Plane 基本概念和功能
2. **部署**:私有化部署 Plane 实例
3. **配置**:设置项目、工作流和权限
4. **实践**:在实际项目中应用
5. **优化**:根据团队需求定制
## 🔗 相关资源
- [Plane 官方网站](https://plane.so/)
- [Plane GitHub](https://github.com/makeplane/plane)
- [Plane 文档](https://docs.plane.so/)