Migration Guide & Documentation

[ricardozanini]

Goal

Provide user documentation for Logic Operator v2.0

Note: The original scope included a SonataFlow migration guide. Given the clean-slate strategy, this is not applicable — there is no migration path, users start fresh with Logic Operator v2.0.

Scope

1. Documentation Site (kubesmarts.org/logic-operator)

• Getting Started guide (KIND local walkthrough)
• CRD reference — LogicFlowRuntime, LogicFlowDefinition, LogicFlowService
• Concepts — Runtime Model, Workflow Definitions, Durable Workflows, ConfigMap Hot-Reload
• Deployment guides — Overview, KIND local, Monitoring, Production checklist, Troubleshooting
• Samples — hello-world, persistence, Prometheus/Grafana, API key auth
• GitHub Actions deploy pipeline (publishes to kubesmarts.org/logic-operator)

2. Remaining Documentation

• Traffic splitting tutorial (blocked on Multi-Version Support & Traffic Splitting #11)
• Data Index integration guide (blocked on Data Index Integration #9)
• GoDoc API reference generation
• /examples directory with ready-to-apply YAML manifests

What's done

Full Antora documentation site published at kubesmarts.org/logic-operator.

Dependencies: EPIC 8 (partial) | Blocked on: #9, #11

[ricardozanini]

Implementation Traceability

Documentation site published at kubesmarts.org/logic-operator:

• PR docs: add Logic Operator v2.0 Antora documentation site #28 — docs: add Logic Operator v2.0 Antora documentation site: full Antora site with Getting Started, CRD reference (LogicFlowRuntime, LogicFlowDefinition, LogicFlowService), Concepts (runtime model, OWS workflow definitions, durable workflows, ConfigMap hot-reload), Deployment guides, and Samples (hello-world, persistence, monitoring, API key auth). Served via GitHub Pages Actions workflow.

Remaining items (traffic splitting tutorial, Data Index guide) depend on #9 and #11.