-
Notifications
You must be signed in to change notification settings - Fork 360
High-level architectural overview for Elyra components #3327
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
High-level architectural overview for Elyra components #3327
Conversation
Signed-off-by: Luciano Resende <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3327 +/- ##
=======================================
Coverage ? 87.78%
=======================================
Files ? 103
Lines ? 16396
Branches ? 93
=======================================
Hits ? 14394
Misses ? 2002
Partials ? 0 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Luciano Resende <[email protected]>
| The system is composed of several major subsystems that work together to provide a comprehensive data science platform. | ||
|
|
||
| ``` | ||
| ┌─────────────────────────────────────────────────────────────────────────────────┐ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we consider drawing this diagram using mermaid? easy to maintain!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive architectural documentation for Elyra as required for OpenSSF Silver badge certification. The documentation provides a detailed overview of Elyra's software architecture, components, and their relationships.
- Added a new architecture documentation file with detailed component descriptions
- Updated the documentation index to include the new architecture guide
- Provided comprehensive coverage of frontend, backend, storage, and external runtime integration
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/source/index.rst | Added reference to new architecture documentation in Developer Guide section |
| docs/source/developer_guide/architecture.md | New comprehensive architectural documentation covering all major Elyra components and their relationships |
Comments suppressed due to low confidence (1)
docs/source/index.rst:1
- [nitpick] The blank line at line 70 is inconsistent with the spacing pattern used elsewhere in the file. Consider removing this extra blank line to maintain consistent formatting throughout the document.
..
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
caponetto
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
--------- Signed-off-by: Luciano Resende <[email protected]>
What changes were proposed in this pull request?
High-level architectural overview for Elyra components
Note: this is an OpenSSF requirement for achieving the silver badge
How was this pull request tested?
Developer's Certificate of Origin 1.1