fastlane / fastlane/docs

Relative vs. absolute links?

Open
#1,123 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
HTML
Stars
338
Forks
580
Avg merge
6d 1h
Merged PRs (30d)
3

Description

So I am just curious… is there a general consensus or a pattern to follow what insite links should be relative like:

https://github.com/fastlane/docs/blob/84b76c0fd867bf3109ef255122fce4962707c2e8/docs/getting-started/ios/setup.md#L44-L48

and what should link absolutely as e.g.:

https://github.com/fastlane/docs/blob/84b76c0fd867bf3109ef255122fce4962707c2e8/docs/getting-started/ios/beta-deployment.md#L189

https://github.com/fastlane/docs/blob/84b76c0fd867bf3109ef255122fce4962707c2e8/docs/getting-started/ios/beta-deployment.md#L153

https://github.com/fastlane/docs/blob/8f70ddb339401c7b21785fbd1860569eca578c64/docs/best-practices/continuous-integration/codemagic.md#L7

I'm asking because on a few occasions I was tempted to propose a fix/cleanup for there, only to realise I'm not sure about any internal styleguide that would explain these discrepancies…

(The only pattern I've noticed is that /generated/ docs have the absolute URLs in them more often.)

Why I'm really raising this topic is… anywhere you leave absolute links, you:
1. effectively link from preview netlify builds to stable public site when previewing changes so it's hard to miss such changes in PR if you're mistakenly taken to live site instead…
2. and since these links are treated as external by the footer script (seeing the stable url as external to the netlify preview), they open in a new window, being rather obnoxious then…

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.