Skip to content
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

Improve the "Working on edx-platform Python dependencies" documentation #1048

Merged
merged 1 commit into from Apr 26, 2024

Conversation

bradenmacdonald
Copy link
Contributor

I couldn't get the edx-platform to persistently use my bind-mounted version of its dependency openedx-learning. I was about to write a giant post on Discourse to ask for help when I happened to notice that the documentation does contain the answer I needed ("What if my edx-platform package is not automatically bind-mounted?"). The problem was, this key section was separated from the related section ("Working on edx-platform Python dependencies") by unrelated topics like how to run the unit tests.

So, this PR:

  1. Moves that important section of the documentation up to where it's more relevant, and adds an explicit call out.
  2. Also updates tutor to be able to auto-detect openedx-learning without a plugin - as it is becoming a key platform dependency and at least at OpenCraft, many developers need to use a bind-mounted version of this dependency.

I didn't include a changelog entry as this is primarily a documentation-only change.

Copy link
Contributor

@DawoudSheraz DawoudSheraz left a comment

Choose a reason for hiding this comment

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

nit: since openedx-learning will be auto-magically mounted once the PR is merged (ignoring the doc changes), we should add a changelog entry for that.

@bradenmacdonald
Copy link
Contributor Author

Sure @DawoudSheraz. I added a changelog entry.

@DawoudSheraz DawoudSheraz merged commit 943bee6 into overhangio:nightly Apr 26, 2024
2 checks passed
@bradenmacdonald bradenmacdonald deleted the braden/bind-mount-docs branch April 26, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants