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] Publish CHANGELOG and other top-level *.md files on the Docsy site and drop markdown-link-check #1781

Open
Tracked by #1911
chalin opened this issue Jan 13, 2024 · 1 comment
Assignees
Labels
CI/infra CI & infrastructure docsy-docs docs about docsy e0-minutes Effort < 60 min enhancement New feature or request p2-medium
Milestone

Comments

@chalin
Copy link
Collaborator

chalin commented Jan 13, 2024

I think that it's useful to have at least the CHANGELOG published to the Docsy website. If we publish all top-level *.md files we'll be able to eliminate the need for the extra link checking via markdown-link-check. We'll then be able to rely on htmltest's reference caching capabilities.

I'm marking this is CI/infrastructure related since this is in part motivated replacing markdown-link-check by use of htmltest.

@chalin chalin added enhancement New feature or request e0-minutes Effort < 60 min docsy-docs docs about docsy CI/infra CI & infrastructure p2-medium p3-low labels Jan 13, 2024
@chalin chalin added this to the 24Q2 milestone Jan 13, 2024
@chalin chalin modified the milestones: 24Q2, 24Q1 Jan 13, 2024
@chalin chalin removed the p3-low label Jan 13, 2024
@chalin
Copy link
Collaborator Author

chalin commented Jan 13, 2024

And here's another reason: CI runs can fail because external link checking is inherently unstable. E.g.:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure docsy-docs docs about docsy e0-minutes Effort < 60 min enhancement New feature or request p2-medium
Projects
None yet
Development

No branches or pull requests

1 participant