Skip to content

Commit

Permalink
chore: update linkinator comment (#3870)
Browse files Browse the repository at this point in the history
Signed-off-by: zirain <[email protected]>
  • Loading branch information
zirain authored Jul 17, 2024
1 parent 995803c commit cdc9a5f
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions tools/make/docs.mk
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
DOCS_OUTPUT_DIR := site/public
RELEASE_VERSIONS ?= $(foreach v,$(wildcard ${ROOT_DIR}/docs/*),$(notdir ${v}))
# TODO: github.com does not allow access too often, there are a lot of 429 errors
# find a way to remove github.com from ignore list
# TODO: example.com is not a valid domain, we should remove it from ignore list
LINKINATOR_IGNORE := "github.com githubusercontent.com example.com github.io _print"
CLEAN_NODE_MODULES ?= true

Expand Down Expand Up @@ -116,12 +119,8 @@ docs-release-gen:
@echo ' url = "/$(DOC_VERSION)"' >> site/hugo.toml

.PHONY: docs-check-links
docs-check-links:
docs-check-links: # Check for broken links in the docs
@$(LOG_TARGET)
# Check for broken links, right now we are focusing on the v1.0.0
# github.com does not allow access too often, there are a lot of 429 errors
# TODO: find a way to remove github.com from ignore list
# TODO: example.com is not a valid domain, we should remove it from ignore list
linkinator site/public/ -r --concurrency 25 --skip $(LINKINATOR_IGNORE)

release-notes-docs: $(tools/release-notes-docs)
Expand Down

0 comments on commit cdc9a5f

Please sign in to comment.