Skip to content

docs: document contentstore - #38950

Merged
bradenmacdonald merged 2 commits into
openedx:masterfrom
open-craft:braden/contentstore
Nov 16, 2026
Merged

bradenmacdonald merged 2 commits into
openedx:masterfrom
open-craft:braden/contentstore

Conversation

@bradenmacdonald

@bradenmacdonald bradenmacdonald commented Aug 4, 2026 •

Copy link
Copy Markdown
Contributor

In preparation for some upcoming work, Claude and I have produced some developer-oriented documentation around what contentstore is (as well as assetstore), and how every related system interacts with it today.

Preview the README here

Private ref: FAL-4371

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Aug 4, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform-oncall.

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.

@kdmccormick kdmccormick left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

reviewed for accuracy with Fable's help. just needs a few tweaks to bring it up to date with our latest ADRs; I'll go ahead and fix those + merge. thanks for the docs!

Comment thread xmodule/contentstore/README.rst Resolved
Comment thread xmodule/contentstore/README.rst Resolved
Comment thread xmodule/contentstore/README.rst Resolved
Comment thread xmodule/contentstore/README.rst Resolved
@kdmccormick

Copy link
Copy Markdown
Member

@bradenmacdonald looks like I can't push to your branch. Feel free to merge once you apply those suggestions!

@bradenmacdonald

Copy link
Copy Markdown
Contributor Author

Thanks @kdmccormick !

@bradenmacdonald
bradenmacdonald enabled auto-merge (squash) November 16, 2026 21:39
@bradenmacdonald
bradenmacdonald merged commit fe40f11 into openedx:master Nov 16, 2026
42 checks passed
@bradenmacdonald
bradenmacdonald deleted the braden/contentstore branch November 16, 2026 22:28
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Nov 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants