Tutor Adoption 1: CourseGraph Plugin

[kdmccormick]

Abstract

CourseGraph is a tool that allows course teams to answer questions about the content across all of an Instance's courses, in aggregate. This includes data such as counts and locations of specific xblocks, course structures, exam questions and content location. It represents the data in graph form via neo4j. This enables broad queries about course content and structure.

Background and Context

CourseGraph was first available as an unsupported part of Maple (via Devstack and the old Native Installation). With the move toward deprecating both Devstack and the Native Installation in favor of Tutor, there was a need for Nutmeg operators to easily install, configure and run CourseGraph as part of a Tutor-managed deployment.

Acceptance Criteria

CourseGraph can be easily run in development or production via a plugin for Tutor.

Notes

@kdmccormick : This started as a means for me to learn Tutor's plugin API, but with the extra time I have I'm going to carry it to completion. This milestone in particular isn't critical to the goals of the overall Tutor-as-Devstack project.

Tasks

Beta Give feedback

1. Advertise tutor-contrib-coursegraph tutor-contrib-coursegraph#26
   +0
   
2. Proof-of-concept dev-mode coursegraph plugin tutor-contrib-coursegraph#1
   +0
   
3. Make tutor-contrib-coursegraph work with k8s tutor-contrib-coursegraph#2
   +0
   
4. Include/exclude particular courses from CMS->CourseGraph refresh tutor-contrib-coursegraph#3
   +0
   
5. Prepare tutor-contrib-coursegraph for first release tutor-contrib-coursegraph#4
   +0
   
6. Allow Tutor plugins to run jobs to enable CourseGraph refresh command tutor-contrib-coursegraph#5
   +0
   
7. Update CourseGraph docs in edx-platform to point to Tutor plugin tutor-contrib-coursegraph#13
   +0
   
8. Release tutor-contrib-coursegraph as "beta" to PyPI tutor-contrib-coursegraph#14
   +0
   
9. Auto-merge tutor-contrib-coursegraph master into nightly tutor-contrib-coursegraph#15
   +0
   
10. Add guidance for CourseGraph access control tutor-contrib-coursegraph#19
    +0
    
11. Persist tutor-contrib-coursegraph data in k8s deployment tutor-contrib-coursegraph#21
    +0
    
12. Should we add the guidance to put CourseGraph behind a VPN? tutor-contrib-coursegraph#25
    question +1
    
13. [GH Request] Transfer tutor-contrib-coursegraph into openedx organization tcril-engineering#185
    github-request +1
    
14. Ensure tutor-contrib-coursegraph works with ENABLE_HTTPS tutor-contrib-coursegraph#17
    +0
    

[kdmccormick]

The work for this epic is complete! Deliverables:

• The plugin package, released on the Python Package Index (PyPI): https://pypi.org/project/tutor-contrib-coursegraph
• The source code, on GitHub, including instructions for using the plugin: https://github.com/openedx/tutor-contrib-coursegraph
• Extra documentation for CourseGraph in edx-platform: https://github.com/openedx/edx-platform/tree/master/cms/djangoapps/coursegraph#coursegraph-support
• Updated blog post: https://openedx.org/blog/announcing-coursegraph-a-new-tool-in-the-maple-release/ (the update section is at the bottom: "How do I deploy and operate CourseGraph?")

There is one task left, which I'm excusing from this epic's completion, because it can't be done until we're closer to Nutmeg's release in June: openedx/tutor-contrib-coursegraph#26