Skip to content

scripts/verify-links: update link check error messages (#2292) #2294

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

Merged
yikeke merged 2 commits into from
Feb 25, 2020
Merged

scripts/verify-links: update link check error messages (#2292) #2294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ceebf5
scripts/verify-links: update link check error messages
Feb 24, 2020
b184fbe
Update scripts/verify-links.sh
yikeke Feb 24, 2020
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
8 changes: 6 additions & 2 deletions scripts/verify-links.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,15 @@ error_files=$(cat $ERROR_REPORT | grep 'FILE: ' | wc -l)
error_output=$(cat $ERROR_REPORT)
echo ""
if [ "$error_files" -gt 0 ]; then
echo "error: $error_files files have invalid links (or alias links which are recommended to be replaced with latest one), please fix them!"
echo "Link error: $error_files files have invalid links. The faulty files are listed below, please fix the wrong links!"
echo ""
echo "=== Hint on how to fix links === "
echo "Links in TiDB documentation follow a style like '/reference/tidb-binlog/deploy.md#服务器要求'. That is, you need to make sure that:"
echo "1) Links start with a slash; 2) Anchor links are written in a '/dir/xxx.md#anchor-point' style; 3) Links don't start with a version, e.g. '/v3.0/...' is wrong and '/v3.0' should be removed."
echo ""
echo "=== ERROR REPORT == ":
echo "$error_output"
exit 1
else
echo "info: all files are ok!"
echo "Link check report: All files are ok. No deadlink found!"
fi