## 1. Project Overview & Quickstart (dataease/LICENSE)

# LICENSE

Open-source repository dataease/LICENSE

### Repository Details
- **Repository:** [dataease/LICENSE](https://github.com/dataease/LICENSE)
- **Primary Language:** Code

*Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.*

## 2. Official Technical Reference & Guides (dataease/docs)

## File: README.md

本仓库保存了 [DataEase 项目]() 的 [官方文档](https://dataease.io/docs/)，该文档使用 [MkDocs]() 文档框架下的 [Material for MkDocs]() 主题进行构建。

## 本地开发

### 克隆本仓库
```bash
git clone https://github.com/dataease/docs.git
```

### 安装依赖
```bash
cd docs
pip install -r requirements/requirements.txt
```

### 修改文档内容
本文档的文档结构定义在 `mkdocs.yml` 文件中，文档的具体内容均在 `docs` 目录中。
```yaml
..........
nav:
    - 项目介绍: index.md
    - 系统架构: system_arch.md
    - 安装部署: 
        - 在线安装: installation/online_installation.md
        - 离线安装: installation/offline_installation.md
        - 在线升级: installation/online_upgrade.md
        - 离线升级: installation/offline_upgrade.md
    - 用户手册:
        - 通用功能: user_manual/general.md
        - 数据源: user_manual/datasource_configuration.md
        - 数据集: user_manual/dataset_configuration.md
        - 视图: user_manual/view_generation.md
        - 仪表板: user_manual/dashboard_generation.md
        - 系统管理:
            - 用户管理: user_manual/system_management/user.md
            - 模版管理: user_manual/system_management/module.md
    - 使用教程:
        - 使用 DataEase 制作销售仪表板: manual_demo/sales_dashboard.md
    - 常见问题:
        - 安装配置: faq/configuration_faq.md
        - 系统管理: faq/system_management.md
        - 数据集: faq/dataset_faq.md
    - 开发文档: dev_manual.md
    - 关于:
        - 更新说明: about/changelog.md
        - 联系我们: about/contact.md
..........
```

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

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

### 构建文档
```bash
mkdocs build
```

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

## 帮助完善文档

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

### 克隆 fork 后的仓库
```bash
git clone https://github.com/your-github-account/docs.git
```

### 本地修改并调试

### Push 修改内容到 GitHub 仓库

### 提交 Pull Request 到本仓库

---

## File: docs/index.md

# 产品介绍

!!! Abstract ""
    DataEase 是开源的数据可视化分析工具，帮助用户快速分析数据并洞察业务趋势，从而实现业务的改进与优化。  
    DataEase 支持丰富的数据源连接，能够通过拖拉拽方式快速制作图表，并可以方便地与他人分享。

{ width="900px" }


!!! Abstract "文档指引"
    - **DataEase 介绍**    

         [**产品简介**](https://dataease.io/docs/#1)        [**安装部署**](https://dataease.io/docs/installation/installation_mode/)        [**体验环境**](https://dataease.fit2cloud.com/)        [**企业试用**](https://jinshuju.net/f/TK5TTd)        [**社区论坛**](https://bbs.fit2cloud.com/c/de/6)

      - **功能指南**

           [**数据连接**](https://dataease.io/docs/user_manual/datasource_description/)        [**数据准备**](https://dataease.io/docs/user_manual/dataset_description/)        [**数据管理**](https://dataease.io/docs/user_manual/dataset_design/)  

           [**仪表板设计**](https://dataease.io/docs/user_manual/dashboard_basicfunctions/)         [**创建图表**](https://dataease.io/docs/user_manual/view_module/view_generation/)        [**添加交互**](https://dataease.io/docs/user_manual/module_basicfunctions/#7)        [**数据筛选**](https://dataease.io/docs/user_manual/filter_module/filtertime_module/)        [**配置组件**](https://dataease.io/docs/user_manual/other_module/style_module/)

           [**查看分享**](https://dataease.io/docs/user_manual/other_module/style_module/)        [**移动端**](https://dataease.io/docs/user_manual/app_description/)          [**模板应用**](https://dataease.io/docs/user_manual/template_market/)        [**应用管理**](https://dataease.io/docs/user_manual/app_template_market/)        [**系统配置**](https://dataease.io/docs/user_manual/system_management/param/) 

    - **企业应用（X-Pack）**

           [**权限管理**](https://dataease.io/docs/xpack/sys_management_permission/)        [**平台对接**](https://dataease.io/docs/xpack/platform_abutment/)        [**认证设置**](https://dataease.io/docs/xpack/identification_setting/)        [**定时报告**](https://dataease.io/docs/xpack/sys_management_report/)        [**系统 API**](https://dataease.io/docs/xpack/sys_management_develop/) 

     - **进阶学习** 

           [**客户案例**](https://dataease.io/docs/customercase/#1)        [**仪表板案例**](https://dataease.io/docs/customercase/#2)       [**图表解析**](https://dataease.io/docs/chart_style_analysis/)        [**间距细节**](https://dataease.io/docs/spacing_design/)        [**更多实践**](https://kb.fit2cloud.com/categories/dataease) 

## 1 界面展示

{ width="900px" }

## 2 模板市场

!!! Abstract ""
    模板市场链接地址：https://dataease.io/templates/ 。

[{ width="1235px" }](https://dataease.io/templates/){ width="900px" }

## 3 产品优势

!!! Abstract ""
    - 开源开放：零门槛，线上快速获取和安装；快速获取用户反馈、按月发布新版本；
    - 简单易用：极易上手，通过鼠标点击和拖拽即可完成分析；
    - 秒级响应：集成 Apache Doris，超大数据量下秒级查询返回延时；
    - 安全分享：支持多种数据分享方式，确保数据安全。

## 4 主要功能

!!! Abstract ""

    - 图表展示: 支持 PC 端、移动端及大屏；
    - 图表制作: 支持丰富的图表类型（基于 Apache ECharts 实现）、支持拖拉拽方式快速制作仪表板；
    - 数据引擎: 支持直连模式、本地模式（基于 Apache Doris / Kettle 实现）；
    - 数据连接: 支持关系型数据库、Excel 等文件、Hadoop 等大数据平台、NoSQL 等各种数据源。

## 5 功能列表

!!! Abstract ""

    - [DataEase 功能列表](https://dataease.io/features.html)

## 6 了解更多

!!! Abstract ""

    - **如何向团队介绍 DataEase？：** https://dataease.io/download/introduce-dataease_202212.pdf
    - **获取新一代数据可视化分析平台建设指南：** https://jinshuju.net/f/cerWRY
    - **DataEase 知识库：** https://kb.fit2cloud.com/categories/dataease
    - **飞致云学堂：** https://edu.fit2cloud.com/index