Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI test for link breakage #156

Open
2 tasks
bgilbert opened this issue Aug 11, 2020 · 2 comments
Open
2 tasks

CI test for link breakage #156

bgilbert opened this issue Aug 11, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@bgilbert
Copy link
Contributor

Add a non-required CI job that checks PRs for:

  • Removal of existing pages
  • Removal of existing anchors (~= headings) within a page
@bgilbert bgilbert added the enhancement New feature or request label Aug 11, 2020
@lucab
Copy link
Contributor

lucab commented Aug 12, 2020

This relates to breakage like #160.

While the goal is indeed good (never breaking permalinks), I don't think we can realistically promise that "we won't change page names nor section title ever after initially merged" at this point.
This topic mixes with docs versioning too, because we wittingly traded in occasional breakage (including permalinks) for fresher / more refined content.

In the short term, I think that a more immediately valuable CI job is "all internal links are ok", and using more often Discourse as an intermediate anchor for those cases where we highly value link stability.

@bgilbert
Copy link
Contributor Author

This relates to breakage like #160.

It was originally prompted by #148 (comment).

While the goal is indeed good (never breaking permalinks), I don't think we can realistically promise that "we won't change page names nor section title ever after initially merged" at this point.

That's why I proposed a non-required CI job. I agree that we'll have to refactor the docs as they expand, but I think it'd be useful to have a speed bump so folks don't accidentally break external links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants