Skip to content

Conversation

@andrii-hantkovskyi
Copy link
Contributor

@andrii-hantkovskyi andrii-hantkovskyi commented Apr 18, 2025

This PR implements the new sections functionality in Learning Core, which allows for organizing subsections within hierarchical containers. Sections serve as containers that can store and manage subsections within the content structure.

Changes in this PR

  • Created new sections models and API as part of the sections app
  • Implemented container behavior where publishing a section automatically publishes its child subsections
  • Added comprehensive functionality to manage the section lifecycle:
    • Creation of sections and section versions
    • Ability to pin specific subsection versions or use the latest versions
    • Retrieval of subsections contained within sections (both draft and published)
  • Added high-level APIs for section management:
    • get_subsections_in_section to retrieve subsections in draft or published sections
    • get_subsections_in_published_section_as_of to access historical states of sections
    • Various utility functions for section creation and version management
  • Bumped openedx_learning to 0.25.0 to account for changes from Subsections in Learning Core #301, which were merged without a version update.

This implementation extends our hierarchical content structure, allowing for more organized content arrangement with subsections being contained within sections.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 18, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Apr 18, 2025

Thanks for the pull request, @andrii-hantkovskyi!

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.


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.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Apr 18, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Apr 18, 2025
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Apr 18, 2025
@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Apr 18, 2025
@e0d e0d moved this from Needs Tests Run or CLA Signed to Ready for Review in Contributions Apr 18, 2025
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

(partial review)

@andrii-hantkovskyi andrii-hantkovskyi marked this pull request as ready for review April 22, 2025 08:43
@andrii-hantkovskyi
Copy link
Contributor Author

Hello @kdmccormick and @ormsbee, could you please review this PR when you have a chance?

@kdmccormick kdmccormick self-requested a review April 22, 2025 14:03
@ormsbee ormsbee self-requested a review April 22, 2025 17:14
@@ -0,0 +1,50 @@
"""
Models that implement subsections
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Models that implement subsections
Models that implement sections

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated


def ready(self):
"""
Register Subsection and SubsectionVersion.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Register Subsection and SubsectionVersion.
Register Section and SectionVersion.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

"""

__version__ = "0.23.1"
__version__ = "0.25.0"
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this skipping 0.24.0 because we expect something else to land first?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Skipping because version was not updated in #301 (Subsections)

@ormsbee ormsbee merged commit d0832a8 into openedx:main Apr 22, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

6 participants