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.

Sign up for GitHub

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

chore: update linkinator comment #3870

Merged
merged 2 commits into from
Jul 17, 2024
Merged

chore: update linkinator comment #3870

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15239a2
chore: update linkinator comment
zirain Jul 16, 2024
dc521ca
Merge branch 'main' into fix-docs
zirain Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions tools/make/docs.mk
View file
Open in desktop
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