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.

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

fix markdown check issue[skip ci] #5276

Merged

Conversation

nvliyuan
Copy link
Collaborator

fix markdown checker permissions issue and reference links issue

Signed-off-by: liyuan <yuali@nvidia.com>
@nvliyuan nvliyuan marked this pull request as draft April 19, 2022 02:25
@nvliyuan nvliyuan changed the title fix markdown check issue[skip ci] [WIP]fix markdown check issue[skip ci] Apr 19, 2022
Signed-off-by: liyuan <yuali@nvidia.com>
@nvliyuan nvliyuan changed the title [WIP]fix markdown check issue[skip ci] fix markdown check issue[skip ci] Apr 19, 2022
@nvliyuan nvliyuan marked this pull request as ready for review April 19, 2022 08:53
@nvliyuan
Copy link
Collaborator Author

this pr is to fix the GitHub permissions issue, but I believe there are some other issues in the link check library, because there are some reference links marked as dead, but actually, they can be accessed, please see the log for more detail
image
and this link is not dead
image
I can not find a perfect workaround or fix for now

@sameerz sameerz added the documentation Improvements or additions to documentation label Apr 19, 2022
@sameerz
Copy link
Collaborator

sameerz commented Apr 19, 2022

I have a concern that the updated link check is referring to a personal github repository. I notice other repos that use gaurav-nelson/github-action-markdown-link-check have fixed this issue without creating forks. Is it possible for us to explore a bit further?

Also, some links are legitimately broken, and without this check we are missing those. For example, the links on https://github.com/NVIDIA/spark-rapids/blob/branch-22.06/docs/dev/shims.md for the following text are broken:

  1. ShimExpression For 3.0.x and 3.1.x
  2. ShimExpression For 3.2.x

Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: liyuan <yuali@nvidia.com>
@nvliyuan
Copy link
Collaborator Author

add a safe directory before the actions/checkout step to work around the permission issue.

@sameerz sameerz added this to the Apr 18 - Apr 29 milestone Apr 20, 2022
@jlowe
Copy link
Member

jlowe commented Apr 20, 2022

build

@nvliyuan nvliyuan merged commit 3141e03 into NVIDIA:branch-22.06 Apr 21, 2022
@nvliyuan nvliyuan deleted the branch-22.06-fix-markdown-check-issue branch March 22, 2023 05:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants