PagerDuty/incident-response-docs

Links broken when viewing directly in GitHub.

richadams opened this issue · 1 comments

Viewing the docs directly in GitHub results in broken links. e.g. https://github.com/PagerDuty/incident-response-docs/blob/master/docs/getting_started.md

I ran into issues using relative links, so changed to absolute links. Unfortunately this breaks viewing the docs in GitHub. I found it hard to get the links to work in GitHub and on the rendered website at the same time. I'd fix one, and the other would break. For now, I focussed on making sure the rendered website at https://response.pagerduty.com works properly.

This issue is to find a way to get the GitHub links working again at the same time as the website.

Changing this to a "Won't Fix". We'll ensure that the website always works, but having it work natively in GitHub will be considered a "Nice to have" feature rather than a requirement.

We'll fix whatever issues we can, but we aren't going to invest significant effort to get it to work in both places.