本仓库保存了 DataEase 项目 的 官方文档，该文档使用 MkDocs 文档框架下的 Material for MkDocs 主题进行构建。

本地开发

克隆本仓库

  1. git clone https://github.com/dataease/docs.git

安装依赖

  1. cd docs
  2. pip install -r requirements/requirements.txt

修改文档内容

本文档的文档结构定义在 mkdocs.yml 文件中，文档的具体内容均在 docs 目录中。

  1. ..........
  2. nav:
  3.     - 项目介绍: index.md
  4.     - 系统架构: system_arch.md
  5.     - 安装部署: 
  6.         - 在线安装: installation/online_installation.md
  7.         - 离线安装: installation/offline_installation.md
  8.         - 在线升级: installation/online_upgrade.md
  9.         - 离线升级: installation/offline_upgrade.md
  10.     - 用户手册:
  11.         - 通用功能: user_manual/general.md
  12.         - 数据源: user_manual/datasource_configuration.md
  13.         - 数据集: user_manual/dataset_configuration.md
  14.         - 视图: user_manual/view_generation.md
  15.         - 仪表板: user_manual/dashboard_generation.md
  16.         - 系统管理:
  17.             - 用户管理: user_manual/system_management/user.md
  18.             - 模版管理: user_manual/system_management/module.md
  19.     - 使用教程:
  20.         - 使用 DataEase 制作销售仪表板: manual_demo/sales_dashboard.md
  21.     - 常见问题:
  22.         - 安装配置: faq/configuration_faq.md
  23.         - 系统管理: faq/system_management.md
  24.         - 数据集: faq/dataset_faq.md
  25.     - 开发文档: dev_manual.md
  26.     - 关于:
  27.         - 更新说明: about/changelog.md
  28.         - 联系我们: about/contact.md
  29. ..........

文档内容使用 markdown 语法编写，若要添加新的文档，需要先在 mkdocs.yml 文件中的 nav 部分增加对应章节导航。

本地调试文档

  1. mkdocs serve

执行上述命令后，可通过 http://127.0.0.1:8000 地址查看生成的文档内容，当修改文档后，页面内容会自动更新。

构建文档

  1. mkdocs build

执行上述命令后，会在 site 目录下生成文档站点的静态文件，将目录中的内容复制到任意 HTTP 服务器上即可完成文档的部署。

帮助完善文档

Fork 文档仓库

点击仓库右上角的 fork 按钮，复制本仓库到自己的 github 账号。

克隆 fork 后的仓库

  1. git clone https://github.com/your-github-account/docs.git

本地修改并调试

Push 修改内容到 GitHub 仓库

提交 Pull Request 到本仓库