You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by "xuruidong (via GitHub)" <gi...@apache.org> on 2023/06/29 16:24:36 UTC
[GitHub] [apisix] xuruidong opened a new pull request, #9760: ci: check broken link
xuruidong opened a new pull request, #9760:
URL: https://github.com/apache/apisix/pull/9760
### Description
1. add ci configuration of check-broken-link
2. fix broken links
Fixes # (issue)
### Checklist
- [ ] I have explained the need for this PR and the problem it solves
- [ ] I have explained the changes or the new features added to this PR
- [ ] I have added tests corresponding to this change
- [ ] I have updated the documentation to reflect this change
- [ ] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first)
<!--
Note
1. Mark the PR as draft until it's ready to be reviewed.
2. Always add/update tests for any changes unless you have a good reason.
3. Always update the documentation to reflect the changes made in the PR.
4. Make a new commit to resolve conversations instead of `push -f`.
5. To resolve merge conflicts, merge master instead of rebasing.
6. Use "request review" to notify the reviewer after making changes.
7. Only a reviewer can mark a conversation as resolved.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] kayx23 commented on a diff in pull request #9760: ci: check broken link
Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on code in PR #9760:
URL: https://github.com/apache/apisix/pull/9760#discussion_r1255381553
##########
.github/workflows/link-check.yml:
##########
@@ -0,0 +1,49 @@
+name: 'Link Checker'
+
+# **What it does**: Renders the content of every page and check all internal links.
+# **Why we have it**: To make sure all links connect correctly.
+# **Who does it impact**: Docs content.
+
+on:
+ workflow_dispatch:
+ push:
+ # branches: [master, 'release/**']
+ paths:
+ - '**/*.md'
+ - '**/link-check.yml'
+ pull_request:
+ branches: [master, "release/**"]
+ paths:
+ - '**/*.md'
+ - '**/link-check.yml'
+
+permissions:
+ contents: read
+ # Needed for the 'trilom/file-changes-action' action
+ pull-requests: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+ group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+ cancel-in-progress: true
+
+jobs:
+ check-links:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+
+ - name: Get script
+ run: |
+ wget https://raw.githubusercontent.com/xuruidong/markdown-link-checker/main/link_checker.py
Review Comment:
@monkeyDluffy6017 note that this is a personal repo.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] monkeyDluffy6017 commented on pull request #9760: ci: check broken link
Posted by "monkeyDluffy6017 (via GitHub)" <gi...@apache.org>.
monkeyDluffy6017 commented on PR #9760:
URL: https://github.com/apache/apisix/pull/9760#issuecomment-1618788588
@guoqqqi please help to check this
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] monkeyDluffy6017 commented on pull request #9760: ci: check broken link
Posted by "monkeyDluffy6017 (via GitHub)" <gi...@apache.org>.
monkeyDluffy6017 commented on PR #9760:
URL: https://github.com/apache/apisix/pull/9760#issuecomment-1613540294
@kayx23 please help to check this
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] monkeyDluffy6017 merged pull request #9760: ci: check broken link
Posted by "monkeyDluffy6017 (via GitHub)" <gi...@apache.org>.
monkeyDluffy6017 merged PR #9760:
URL: https://github.com/apache/apisix/pull/9760
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] xuruidong commented on pull request #9760: ci: check broken link
Posted by "xuruidong (via GitHub)" <gi...@apache.org>.
xuruidong commented on PR #9760:
URL: https://github.com/apache/apisix/pull/9760#issuecomment-1619357145
Some more information about this PR:
1. I fixed all the broken relative path of markdown files
2. I fixed most of the broken external links, some links I don't konw how to fix
3. The ci configuration of "link checker" only check relative path of markdown files, and the external link checking is disabled (the default behave)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] monkeyDluffy6017 commented on pull request #9760: ci: check broken link
Posted by "monkeyDluffy6017 (via GitHub)" <gi...@apache.org>.
monkeyDluffy6017 commented on PR #9760:
URL: https://github.com/apache/apisix/pull/9760#issuecomment-1624070934
Excellent job!!!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] kayx23 commented on pull request #9760: ci: check broken link
Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on PR #9760:
URL: https://github.com/apache/apisix/pull/9760#issuecomment-1624921187
> 3\. The ci configuration of "link checker" only check relative path of markdown files, and the external link checking is disabled (the default behave)
@xuruidong I see you fixing external links in this PR as well. Did you manually check then?
Thanks for your contribution btw!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org