Skip to content

[Doc] add project wiki#567

Merged
zixi0825 merged 1 commit intodatavane:devfrom
xxzuo:ai-wiki
Mar 5, 2026
Merged

[Doc] add project wiki#567
zixi0825 merged 1 commit intodatavane:devfrom
xxzuo:ai-wiki

Conversation

@xxzuo
Copy link
Collaborator

@xxzuo xxzuo commented Mar 2, 2026

Purpose of this pull request

Description

This PR adds comprehensive project documentation (RepoWiki) to the .qoder/repowiki directory, providing detailed technical documentation for the DataVines project.

What's Included

The RepoWiki contains the following documentation sections (in Chinese):

  1. Project Overview (项目概述.md) - Comprehensive introduction to DataVines including:

    • Project background and design goals
    • Core features: Data Catalog, Data Quality, Data Profiling
    • Plugin-based architecture design
    • Multiple execution modes
    • High availability and easy deployment
    • System architecture and technology stack
    • SPI plugin mechanism
    • Comparison with other data quality tools
  2. Quick Start Guide (快速入门.md) - Step-by-step guide covering:

    • Environment prerequisites (JDK 8+, Maven 3.6.1+, MySQL/PostgreSQL)
    • Database initialization
    • Service startup (direct and Docker methods)
    • Minimal configuration examples
    • End-to-end usage examples
    • OS-specific notes (Linux, Windows, macOS)
    • Troubleshooting common issues
  3. Developer Guide (开发者指南.md) - Detailed development documentation:

    • Project structure and module overview
    • Development environment setup
    • Build system and dependency management
    • Code style and standards (Checkstyle, ESLint)
    • Unit testing and integration testing
    • Code submission workflow
    • Code review standards
    • Debugging and performance analysis
    • Branch strategy and release process
    • New contributor onboarding guide
  4. Architecture Design (架构设计/) - In-depth technical architecture:

    • System architecture design
    • Plugin mechanism
    • Data flow design
    • Core architecture components
    • Registry center mechanism
    • Scheduling mechanism
  5. Module Details (模块详解/) - Documentation for each module

  6. Plugin Development (插件开发/) - Guide for developing plugins

  7. API Reference (API参考/) - API documentation

  8. Deployment Guide (部署指南/) - Deployment instructions

  9. Configuration (配置说明/) - Configuration documentation

  10. Database Design (数据库设计/) - Database schema documentation

  11. Core Features (核心功能/) - Feature documentation

Benefits

  1. Improved Onboarding Experience: New contributors can quickly understand the project structure and get started with development.

  2. Reduced Learning Curve: Comprehensive documentation helps developers understand the microkernel architecture and SPI plugin mechanism.

  3. Better Code Quality: Clear coding standards and review guidelines ensure consistent code quality across contributions.

  4. Easier Troubleshooting: Detailed troubleshooting guides reduce the time spent on common setup and configuration issues.

  5. Enhanced Collaboration: Standardized documentation makes it easier for distributed teams to collaborate effectively.

  6. Knowledge Preservation: Technical decisions and architecture designs are documented for future reference.

  7. Community Growth: Better documentation lowers the barrier for new contributors, helping to grow the community.

Technical Highlights Documented

  • Microkernel architecture with SPI plugin mechanism
  • Support for 27 built-in data quality check rules
  • Multiple execution engines (Spark, Local/JDBC)
  • Plugin-based design for connectors, metrics, notifications, and registries
  • Decentralized server architecture with horizontal scaling
  • Multi-datasource support (MySQL, PostgreSQL, ClickHouse, etc.)

Notes

  • Documentation is currently in Chinese
  • All documentation includes source code references for accuracy
  • Mermaid diagrams are used for visualizing architecture
  • Each document follows a consistent structure with table of contents

Type of Change: Documentation

Check list

  • Code changed are covered with tests, or it does not need tests for reason:
  • Change does not need document change

@zixi0825 zixi0825 merged commit ac3cc32 into datavane:dev Mar 5, 2026
4 checks passed
xxzuo added a commit that referenced this pull request Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants