Issue tracker integration

[jmatsushita]

This is an issue meant to keep track of various sub issues that relate to integration with issue trackers as a user interaction and feedback mechanism (#28)

• Listing issues associated to a project Allow transclusion of API endpoint results #42
• Mapping one issue to a page as a discussion feature Implement github issues as a page discussion feature #24
  • With Allow transclusion of API endpoint results #42 this could be the transclusion of an issue thread in the section of a page. Possibly adding a form which would submit to a microservice API gateway for posting to the issue tracker.
• Making the content of the issue the master content (this approach is used when the OP is refined with the inputs from the discussion thread).

Notes

Semantics

• Watch/Subscribe
  • Item
  • Group
• Participate/Mentions
• Configure Delivery
  • Channels
    • Email
    • RSS
    • IRC/Chat
    • Third party platform (Github/Gitlab/...)
  • Frequency
    • Immediately
    • Batch

The first step is to depend on an external service for notifications (despite the need to register/login). Good candidates are the Github/Gitlab issue trackers (Gitlab self-hosted allowing to avoid third party authentication dependencies).

In that case there should be mappings of content items to issues (#24) and notifications can be managed through the issue subscription mechanism. Here are possible approaches:

Approach A

Example for one master repo

Repo: https://github.com/iilab/contentascode
Issues: https://github.com/iilab/contentascode/issues

One issue could be mapped to one page.

• PROS: The issue can be used as a discussion page.
• CONS: Lots of issues.

Implementation:

• At first an issue metadata key could be added with the issue number.
• Later an issue could be created automatically via the issue tracker's API.
• Commits could be checked and amended with the proper issue number so that they appear in the issue thread.

Approach B

One master repo, issues are orthogonal to the content (a more classical setup between code and issue tracking or documentation and issues)

Repo: https://github.com/iilab/openmentoring-mobile
Issues: https://github.com/iilab/openmentoring-mobile/issues

Approach C

Multiple subrepos, corresponding to "areas of interest"

Repo: https://code.iilab.org/openintegrity/openintegrity.org
Subrepos:

• https://code.iilab.org/openintegrity/framework
• https://code.iilab.org/openintegrity/design
• https://code.iilab.org/openintegrity/practices
• https://code.iilab.org/openintegrity/impact