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

Incorporates changes to make MITxOnline work with Tutor #1376

Merged
merged 15 commits into from
May 26, 2023

Conversation

jkachel
Copy link
Contributor

@jkachel jkachel commented Jan 24, 2023

Pre-Flight checklist

  • Testing
    • Code is tested
    • Changes have been manually tested

What are the relevant tickets?

n/a

What's this PR do?

Documentation updates and some minor code changes to facilitate using MITx Online with Tutor.

This also nerfs the old Refine Admin docs; they were out of date (we don't have a specific OIDC setup for that anymore).

How should this be manually tested?

Documentation/Tutor Deployment:
Note that Open edX's Tutor distribution replaces devstack - you can run them at the same time (they expose different ports) but I at least found that to be a bit confusing, not to mention resource intensive. If you're running this on an arm64/Apple Silicon machine, there are specific docs for that (you'll have to rebuild the openedx image anyway but there are other things that need to be done).

Build the documentation and then read it:

./pants docs ::
docker run --rm -ti --name mitxdocs -p 7888:80 -v `pwd`/dist/sphinx:/usr/share/nginx/html nginx

This will build the documentation, then run a nginx container on port 7888 pointed at the built docs (or just open it from dist/sphinx, that works too).

Follow the documentation at docs/source/configuration/tutor.rst (or http://localhost:7888/configuration/tutor.html if you did the Docker thing above). It should work.

Support:

  • The configure_instance command now accepts a --tutor flag - if you specify this, it will use "local.overhang.io" instead of "edx.odl.local:18000" for URLs in the appropriate spots. (This will get tested as part of the Tutor deployment docs but if you want to test it manually, you can - just check for different URLs in the OAuth2 application records.)
  • MITx Online containers should be able to resolve local.overhang.io, and it should resolve to what you've set OPENEDX_IP to rather than what's in DNS.

Any background context you want to provide?

HQ thread

devstack deprecation

@jkachel jkachel force-pushed the jkachel/tutor-openedx-changes branch from 74db9c8 to 9a965e8 Compare March 2, 2023 16:00
@codecov-commenter
Copy link

codecov-commenter commented Mar 2, 2023

Codecov Report

Merging #1376 (e31bcfb) into main (14fa795) will increase coverage by 0.48%.
The diff coverage is n/a.

❗ Current head e31bcfb differs from pull request most recent head d48a24f. Consider uploading reports for the commit d48a24f to get more accurate results

@@            Coverage Diff             @@
##             main    #1376      +/-   ##
==========================================
+ Coverage   82.44%   82.92%   +0.48%     
==========================================
  Files         315      313       -2     
  Lines       13525    13443      -82     
  Branches      952      954       +2     
==========================================
- Hits        11151    11148       -3     
+ Misses       2104     2027      -77     
+ Partials      270      268       -2     

see 43 files with indirect coverage changes

@asadali145
Copy link
Contributor

asadali145 commented Mar 14, 2023

@jkachel Once this PR is approved and merged, can we still use the Devstack-based edX installation with MIT xOnline?

@jkachel
Copy link
Contributor Author

jkachel commented Mar 14, 2023

@jkachel Once this PR is approved and merged, can we still use the Devstack-based edX installation with MIT xOnline?

Yes; the actual changes to the app are additive.

@jkachel jkachel force-pushed the jkachel/tutor-openedx-changes branch from 6186764 to 9ffca12 Compare March 17, 2023 13:08
@jkachel jkachel force-pushed the jkachel/tutor-openedx-changes branch from e31bcfb to d48a24f Compare May 26, 2023 18:25
@rachellougee rachellougee self-assigned this May 26, 2023
Copy link
Contributor

@rachellougee rachellougee left a comment

Choose a reason for hiding this comment

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

Great work! I was able to follow the documentation to get MITx Online app to work with tutor local, and ran a couple of commands to sync data.

@jkachel jkachel merged commit be7dc2f into main May 26, 2023
@jkachel jkachel deleted the jkachel/tutor-openedx-changes branch May 26, 2023 18:53
@odlbot odlbot mentioned this pull request May 30, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants