Fix: Disable edit links for unreleased versions#1066
Conversation
There was a problem hiding this comment.
Pull request overview
Updates Docsy meta link rendering and link-check configuration to avoid CI failures caused by “Edit/View this page” GitHub links that point at content not present on the main branch yet (intended for unreleased docs content).
Changes:
- Adds a Docsy partial override to suppress GitHub view/edit/create-child links for
_devcontent. - Removes the htmltest ignore rule that skipped Docsy-generated GitHub
new|editURLs. - Expands AGENTS.md with local verification/testing guidance and doc versioning notes.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
themes/docsy-overrides/layouts/_partials/page-meta-links.html |
Conditionally hides GitHub meta links for _dev pages. |
AGENTS.md |
Adds contributor workflow tips (build/test/link checks/spellcheck/versioning). |
.htmltest.yml |
Changes link-check ignore patterns to start checking Docsy GitHub edit links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
the linter was failing for the latest release links which are valid in the PR branch but not valid against main. The |
Thanks, I reverted the _dev exclusion logic as you pointed out. |
|
Simplified per @yurishkuro's feedback — dropped the Docsy template override entirely. The fix is now just a one-line regex change in
- - ^https?://github\.com/.*?/.*?/(new|edit)/ # view-page, edit-source etc
+ - ^https?://github\.com/jaegertracing/documentation/(tree|edit|new)/ |
…1065) The previous regex missed /tree/ URLs (Docsy "View this page" links), causing htmltest to check them and get rate-limited (429) by GitHub. Signed-off-by: Jonah Kowall <jkowall@kowall.net>
jkowall
force-pushed
the
fix-issue-1065-edit-links
branch
from
12ef2fa to
cd87a23
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This PR fixes #1065 by disabling verification the 'Edit this page' links.
The fix is now just a one-line regex change in
.htmltest.yml:jaegertracing/documentationinstead of the overly broad.*?/.*?/treeto match "View this page" links (the actual source of CI failures), alongsideeditandnew