Skip to content

README.md

Latest commit

 

History

History
58 lines (44 loc) · 1.29 KB

README.md

File metadata and controls

58 lines (44 loc) · 1.29 KB

DataFlow Operator Documentation

Documentation site for DataFlow Operator, built with MkDocs Material.

Live site: https://dataflow-operator.github.io/docs/

Languages

  • English (docs/en/)
  • Russian (docs/ru/)

Local development

pip install -r requirements.txt
mkdocs serve

Open http://localhost:8000.

Build

mkdocs build

Output goes to site/.

Structure

docs/
├── mkdocs.yml              # MkDocs configuration
├── requirements.txt        # Python dependencies
├── docs/
│   ├── en/                 # English documentation
│   ├── ru/                 # Russian documentation
│   ├── images/             # Logo, favicon
│   ├── stylesheets/        # Custom CSS
│   └── javascripts/        # Custom JS
└── .github/workflows/
    └── docs.yml            # CI: deploy to GitHub Pages

Topics covered

  • Getting Started
  • Architecture
  • Connectors (Kafka, PostgreSQL, ClickHouse, Trino, Nessie)
  • Transformations
  • Configuration examples
  • Error handling and fault tolerance
  • Prometheus metrics
  • Web GUI
  • MCP server
  • Development guide
  • Connector development
  • Semantic versioning and releases