GitHub issue widget

[jtauber]

On #52, @balain suggested:

So, crazy idea(?). What if this task mode as a to-do list. E.g. create a component for widget development plan and manage/update it via the task mode to track progress/completed items. It would require an active host serving the management instance of DeepReader and provide a sandbox to test out various features - e.g. due dates, etc. But it would conflict with and/or potentially be confusing when using GitHub's issues list...

To which I replied:

I like your idea but I think it's orthogonal to what I'm suggesting. I'm specifically referring to a mode of interacting with the text that assesses comprehension of that text. But I think your idea is great and think you should create a new issue for it. But it occurs to me: for your idea, how about we just build a widget that interacts with the GitHub API? Avoids the conflict with GitHub and gives us an out-of-the-box microservice to use already.

[jtauber]

I then added:

Actually now that I think more about it, you could use GitHub integration not just for tasks that are orthogonal to the text (like your example of widget development plans) but actually for some crowdsourcing projects (although perhaps not student assessment). For example, imagine you had a repository where issues were labeled with CTS URNs or OSIS IDs. The GitHub widget could retrieve the relevant issue(s) for the passage being interacted with and let the reader view those issues and comment on them right from within the widget.

[jtauber]

So I think the starting point here is a widget that is hard-coded to a particular repo and lists the open issues in that repo.

Second step would be to allow some sort of interaction (which would require authentication)

Third step would be to (optionally) support scoping of issues to the text being viewed via CTS URN or OSIS ID label on the GitHub issue.

[balain]

I'd like to tackle this (at least steps 1 & 2) as a learning exercise, if it isn't urgent. It might take me several weeks...

[jtauber]

@balain things not marked Milestone 2 or 3 are definitely not urgent.

Would be excellent if you tackled this. It would be especially interesting if you used GitHub's GraphQL API because I think GraphQL could prove very interesting for a lot of DeepReader use cases and so working out how to support GraphQL queries from DeepReader would help us with a whole range of things.

[balain]

I submitted a pull request with a new GitHub component, but almost immediately (coincidentally?), my GitHub account was locked. I've asked to have it reinstated, but until then, I'm guessing my pull request won't be visible to you... GitHub issue resolved; pull request renamed -- WIP...