Skip to content

feat: serialize components using namespaced directory structure#351

Merged
ormsbee merged 2 commits intoopenedx:mainfrom
WGU-Open-edX:dwong2708/lp_dump_component_serialization
Aug 14, 2025
Merged

feat: serialize components using namespaced directory structure#351
ormsbee merged 2 commits intoopenedx:mainfrom
WGU-Open-edX:dwong2708/lp_dump_component_serialization

Conversation

@dwong2708
Copy link
Contributor

@dwong2708 dwong2708 commented Aug 6, 2025

Resolves: #350

Summary

This PR implements a new directory layout for component serialization based on:

  • Component namespace
  • Component type
  • Component identifier

Details

  • Each component is now stored in its own folder hierarchy.
  • A TOML file is included for each component, containing its basic metadata.
  • If versioned data is available, it is placed under a component_versions/<version>/ subdirectory inside the component’s folder.

Example Output

image

Implements new directory layout for component serialization based on:
- Component namespace
- Component type
- Component identifier

Each component is now stored in its respective folder structure with its TOML file,
and optionally includes a `component_versions/<version>/` subdirectory if version data is available
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 6, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Aug 6, 2025

Thanks for the pull request, @dwong2708!

This repository is currently maintained by @axim-engineering.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@dwong2708 dwong2708 requested a review from ormsbee August 7, 2025 23:04
@dwong2708 dwong2708 marked this pull request as ready for review August 7, 2025 23:04
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Aug 8, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Aug 8, 2025
@ormsbee ormsbee merged commit 44e5e86 into openedx:main Aug 14, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Aug 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Components Serialization

5 participants

Comments