docs: Add architecture overview and update documentation for 2.0#584
Draft
StefanoFioravanzo wants to merge 3 commits intokubeflow:mainfrom
Draft
docs: Add architecture overview and update documentation for 2.0#584StefanoFioravanzo wants to merge 3 commits intokubeflow:mainfrom
StefanoFioravanzo wants to merge 3 commits intokubeflow:mainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
StefanoFioravanzo
force-pushed
the
docs/architecture-overview
branch
from
04396ad to
38db2fb
Compare
Add ARCHITECTURE.md with: - High-level system diagram showing data flow from notebook to KFP - Component overview (Backend + JupyterLab Extension) - Detailed data flow explanation (annotation → processing → compilation → execution) - Backend directory structure and key classes - Cell tag language reference - KFP v2 integration details - Configuration and marshal system overview - ASCII diagrams for visual learners This document helps newcomers understand how Kale converts notebooks into Kubeflow Pipelines and how the components interact. Signed-off-by: Stefano Fioravanzo <stefano.fioravanzo@gmail.com>
- Add link to docs/ARCHITECTURE.md for newcomers - Fix Python version requirement: 3.10+ → 3.12+ Signed-off-by: Stefano Fioravanzo <stefano.fioravanzo@gmail.com>
- Remove MiniKF/Rok integration mention (no longer maintained) - Remove PersistentVolumeClaim section (KFPv2 uses artifacts, not volumes) - Update compiler errors section for KFPv2 compatibility - Simplify ModuleNotFoundError solution with current approaches Signed-off-by: Stefano Fioravanzo <stefano.fioravanzo@gmail.com>
StefanoFioravanzo
force-pushed
the
docs/architecture-overview
branch
from
4fcd0a0 to
f92232e
Compare
Member
|
/assign |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
docs/ARCHITECTURE.md- Complete architecture overview including:README.mdFAQ.mdContext
The architecture documentation addresses the need for a high-level overview for newcomers to the repository. The FAQ updates remove references to deprecated integrations and KFPv1 patterns.
Test plan