Render Error Tracking GitLab Issue link using GFM format
Problem to solve
GitLab issues associated with Sentry errors are surfaced and linked on the detail pages in GitLab. Currently, these render as full urls, e.g. https://<root>/<group>/<project>/issues/<id>. Ideally we would display this in the same format as we render links in GFM: e.g. #<id> or project#<id> - to help maintain consistency in GitLab UI.
Intended users
- Delaney (Development Team Lead)
- Sasha (Software Developer)
- Devon (DevOps Engineer)
- Sidney (Systems Administrator)
Further details
This work supports the Error Tracking Vision.
Proposal
Suggested solution
- Backend: make a call to the Render GFM method after Sentry data fetched.
- API: Return HTML instead of url string for issue link.
- Frontend: Render HTML string returned by backend.
Deliverable:
- Render the link in shorthand
This could be done 100% in the frontend with an additional call to the GFM preview endpoint, but this will introduce a delay and 'jumpiness' as the existing text is replaced. As such, the backend + frontend solution is preferred.
This issue is a follow-up from this discussion: #35891 (comment 253318534)