Skip to content
This repository has been archived by the owner on Jul 2, 2024. It is now read-only.

Add check that relative links are used (no absolute links to handbook.sourcegraph.com) #82

Open
felixfbecker opened this issue Oct 4, 2021 · 0 comments
Labels
🔧 Handbook tooling Any issues and asks related to handbook tooling, such as the checks and GitHub actions. team/content-platform

Comments

@felixfbecker
Copy link
Contributor

felixfbecker commented Oct 4, 2021

Using relative links is critical to make sure that the handbook can be browsed on deploy previews in PRs and on old revisions. It can be unintuitive for people not familiar with the concept though, which is why we have this handbook page: https://handbook.sourcegraph.com/editing/linking-within-handbook

Our link checker cannot check for this directly, but we could add a step that simply does a grep for links looking like [...](https://handbook.sourcegraph.com/...) in the content/ directory.

@felixfbecker felixfbecker added 🏗 Handbook website Any issues and asks related to the handbook website, not the content of the handbook. 🔧 Handbook tooling Any issues and asks related to handbook tooling, such as the checks and GitHub actions. and removed 🏗 Handbook website Any issues and asks related to the handbook website, not the content of the handbook. labels Oct 4, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🔧 Handbook tooling Any issues and asks related to handbook tooling, such as the checks and GitHub actions. team/content-platform
Projects
Status: Backlog 📓
Development

No branches or pull requests

2 participants