Skip to content

docs: update CourseGraph README, notably w.r.t. new Tutor plugin#30132

Merged
kdmccormick merged 1 commit intokdmccormick/coursegraph-push-on-updatefrom
kdmccormick/coursegraph-readme-plugin
Mar 28, 2022
Merged

docs: update CourseGraph README, notably w.r.t. new Tutor plugin#30132
kdmccormick merged 1 commit intokdmccormick/coursegraph-push-on-updatefrom
kdmccormick/coursegraph-readme-plugin

Conversation

@kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented Mar 28, 2022

Description

Update the README of the CMS's CourseGraph support app:

  • Point to the newly-developed CourseGraph plugin for Tutor, and remove some prose that's now redundant with the Tutor plugin's README.
  • Add a link to the now-public CourseGraph Queries wiki page.
  • Capitalize the G in CourseGraph.
  • Fix a couple misc. formatting things.

Other Information

Blocked by #29156

Fixes openedx-unsupported/tutor-contrib-coursegraph#13

Deadline

Before Nutmeg (4/9)

@kdmccormick kdmccormick force-pushed the kdmccormick/coursegraph-readme-plugin branch from 441ed9d to a523e6c Compare March 28, 2022 19:01
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it worth mentioning anything in this line about "feedback more than welcome"? I'm not sure, will leave up to you.

Copy link
Member Author

Choose a reason for hiding this comment

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

The top of the plugin's readme says essentially that, so I think this section is OK as-is, but if you felt strongly I'd be happy to include the call for feedback here as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

👍🏻 sgtm

@kdmccormick kdmccormick changed the base branch from master to kdmccormick/coursegraph-push-on-update March 28, 2022 21:44
@kdmccormick
Copy link
Member Author

Gonna merge this into my main CourseGraph PR instead of master so that it's simpler to revert the main PR if something goes wrong.

Update the README of the CMS's CourseGraph support app:
* Point to the newly-developed CourseGraph plugin for Tutor,
  and remove some prose that's now redundant with the Tutor
  plugin's README.
* Add a link to the now-public CourseGraph Queries wiki page.
* Capitalize the G in CourseGraph.
* Fix a couple misc. formatting things.
@kdmccormick kdmccormick force-pushed the kdmccormick/coursegraph-readme-plugin branch from a523e6c to 9a11488 Compare March 28, 2022 22:30
@kdmccormick kdmccormick merged this pull request into kdmccormick/coursegraph-push-on-update Mar 28, 2022
@kdmccormick kdmccormick deleted the kdmccormick/coursegraph-readme-plugin branch March 28, 2022 22:30
@kdmccormick
Copy link
Member Author

Hey @doctoryes , did you hit any trouble running a CourseGraph refresh?

@kdmccormick
Copy link
Member Author

^ Sorry, wrong PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update CourseGraph docs in edx-platform to point to Tutor plugin

2 participants