Files
ansible-playbook/llmdoc/index.md
Wang Defa 167fad20eb 添加 Nezha Agent 管理功能和完整文档系统
- 新增 Nezha Agent client_secret 更新 playbook(两种实现方案)
- 建立三层文档架构:docs/(用户文档)、examples/(配置示例)、llmdoc/(技术文档)
- 添加项目主 README.md 和配置示例文件
- 初始化 .gitignore 保护敏感信息
2025-12-16 10:52:38 +08:00

64 lines
2.8 KiB
Markdown

# Gitea Ansible Playbook 自动化部署项目索引
## 项目简介
本项目是一个专业的 Ansible Playbook 工具集,专门设计用于 Gitea 服务的自动化部署、配置和管理。通过模块化和高度可配置的方法,简化了 Gitea 服务的运维工作。
## 文档导航
### 概览
- [项目概览](/overview/project-overview.md): 项目目标、技术栈和核心特性的完整介绍
- [文档和示例使用指南](/guides/using-project-documentation.md): 如何有效利用项目文档和示例
### 指南
1. [文档和示例使用指南](/guides/using-project-documentation.md): 详细解释项目文档和示例目录的使用方法
2. [Gitea 部署指南](/guides/how-to-deploy-xxxigcc.md): 详细的 Gitea 服务安装步骤
3. [动态参数使用](/guides/using-dynamic-parameters.md): 如何利用动态参数配置
4. [Journald 配置指南](/guides/how-to-configure-journald.md): 系统日志配置最佳实践
5. [安全最佳实践](/guides/security-best-practices.md): 确保 Gitea 部署安全性
### 架构
1. [项目架构](/architecture/ansible-project-structure.md): Ansible Playbook 的整体结构解析
2. [安全架构](/architecture/security-architecture.md): 系统安全设计
3. [动态参数构建](/architecture/dynamic-parameter-building.md): 参数处理机制
4. [Journald 配置流程](/architecture/journald-configuration-flow.md): 日志配置内部工作原理
### 参考
1. [Ansible 模块列表](/reference/ansible-modules-used.md): 项目中使用的关键 Ansible 模块
2. [Gitea 参数规范](/reference/xxxigcc-parameters.md): 详细的参数配置指南
3. [安全清单](/reference/security-checklist.md): 部署安全检查清单
4. [Git 提交规范](/reference/git-conventions.md): 代码提交与协作指南
5. [Jinja2 参数模式](/reference/jinja2-parameter-patterns.md): 参数渲染高级用法
6. [编码规范](/reference/coding-conventions.md): 项目编码风格指南
7. [Journald 参数](/reference/journald-parameters.md): 日志系统详细参数
## 目录结构指南
### docs/ (用户文档)
专业、详细的用户指南和操作文档
### examples/ (配置示例)
各种功能和场景的配置模板和示例文件
### llmdoc/ (技术文档系统)
为 AI 代理提供结构化、可检索的技术文档
## 快速入门
1. 阅读[项目概览](/overview/project-overview.md)了解项目背景
2. 查看[文档和示例使用指南](/guides/using-project-documentation.md)
3. 查看[部署指南](/guides/how-to-deploy-xxxigcc.md)开始安装
4. 参考[参考文档](/reference/xxxigcc-parameters.md)进行详细配置
## 贡献与支持
- 遵循[安全最佳实践](/guides/security-best-practices.md)
- 查看[编码规范](/reference/coding-conventions.md)了解贡献指南
## 许可与版权
请参阅项目根目录下的 LICENSE 文件。
## 版本信息
最后更新时间: 2024年12月16日