Docs: Add docs-check-links target#1546
Open
TomFern wants to merge 1 commit into
Open
Conversation
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
TomFern
changed the title
docs-check-links targetdocs-check-links target
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We have a
check-linkstarget in the vmdocs repository. This is a good start but it only detects broken links after changes in docs are merged into master in this repository.It would be nice to have a way to check the documentation in this repository (before creating a PR for instance). This PR introduces a
docs-check-linkstarget to thedocs/Makefile. This lets us see if we have any new broken links in the current branch/PR before merging into main.We've already implemented this on VictoriaMetrics here: VictoriaMetrics/VictoriaMetrics#11121