-
Notifications
You must be signed in to change notification settings - Fork 837
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(docs): Added a GitHub action for markdown link check. #5997
base: v2
Are you sure you want to change the base?
Conversation
Rakavitha Kodhandapani seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left some comments. Has this been tested, perhaps in a fork of the repo?
name: Broken link report | ||
about: Automated issue template for reporting link checker fails | ||
title: Failing link check ({{ date | date('dddd, MMMM Do') }}) | ||
labels: bug, automated issue, link check |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add v2
@@ -0,0 +1,31 @@ | |||
name: Check all Markdown links daily |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As the main branch is not v2
in the github repo, this will also require a "dummy" workflow checked in in the main master
branch in a follow up PR. check here for an example: https://github.com/SeldonIO/seldon-core/blob/master/.github/workflows/license.yml
@@ -0,0 +1,31 @@ | |||
name: Check all Markdown links daily | |||
|
|||
on: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we also add manual trigger option and push on v2?
--- | ||
name: Broken link report | ||
about: Automated issue template for reporting link checker fails | ||
title: Failing link check ({{ date | date('dddd, MMMM Do') }}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this should follow v2 title template: fix(docs): ...
@@ -0,0 +1,87 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you explain the logic behind this file for review?
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: