Skip to content

Conversation

@lresende
Copy link
Member

@lresende lresende commented Sep 1, 2025

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

   By making a contribution to this project, I certify that:

   (a) The contribution was created in whole or in part by me and I
       have the right to submit it under the Apache License 2.0; or

   (b) The contribution is based upon previous work that, to the best
       of my knowledge, is covered under an appropriate open source
       license and I have the right under that license to submit that
       work with modifications, whether created in whole or in part
       by me, under the same open source license (unless I am
       permitted to submit under a different license), as indicated
       in the file; or

   (c) The contribution was provided directly to me by some other
       person who certified (a), (b) or (c) and I have not modified
       it.

   (d) I understand and agree that this project and the contribution
       are public and that a record of the contribution (including all
       personal information I submit with it, including my sign-off) is
       maintained indefinitely and may be redistributed consistent with
       this project or the open source license(s) involved.

@lresende lresende added this to the 4.1.0 milestone Sep 1, 2025
@codecov
Copy link

codecov bot commented Sep 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@b323143). Learn more about missing BASE report.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

The system is composed of several major subsystems that work together to provide a comprehensive data science platform.

```
┌─────────────────────────────────────────────────────────────────────────────────┐
Copy link
Contributor

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!

@caponetto caponetto requested a review from Copilot September 6, 2025 14:17
Copy link

Copilot AI left a 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.

Copy link
Contributor

@caponetto caponetto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lresende lresende merged commit bbe16d4 into elyra-ai:main Sep 15, 2025
17 checks passed
@lresende lresende deleted the apple-update-architecture-doc branch September 15, 2025 02:48
jesuino pushed a commit to jesuino/elyra that referenced this pull request Oct 3, 2025
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.

3 participants