Adding broken links check using github actions

[VachaShah]

Signed-off-by: Vacha Shah vachshah@amazon.com

Description

This PR adds a github action for checking broken links in the markdown files. This check is triggered on PRs and push.

###Testing
I tested this action on a dummy repo https://github.com/VachaShah/TestGithubActions/actions by adding a broken link in some text files, the action failed with the broken link. Also, I have verified by creating a PR with some broken links in files.

Issues Resolved

#29

Check List

• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[saratvemulapalli]

Thanks @VachaShah for the change. I see this only runs a checker for Markdown files.
Is there a solution which checks all the files i.e including code, .md etc ?

This works for opensearch-plugins repo, but we would want to standardize this for all the plugins and OpenSearch repo's.

[VachaShah]

Thanks @VachaShah for the change. I see this only runs a checker for Markdown files.
Is there a solution which checks all the files i.e including code, .md etc ?

This works for opensearch-plugins repo, but we would want to standardize this for all the plugins and OpenSearch repo's.

@saratvemulapalli This checker only checks the md files, I can look for something that runs a check for all files.

[VachaShah]

@saratvemulapalli I added another github action which can check for all kinds of text files. It has run on this PR as well. I also ran it on my test repo on a push and also created a PR against main which had a broken link. LMK if this works for our use case.

[saratvemulapalli]

Thanks @VachaShah for this. This is great.

Can you add a doc in this repo on how plugins and other repositories can use it?
You can take a look at https://github.com/opensearch-project/opensearch-plugins/blob/main/RELEASE_NOTES.md#automation

[VachaShah]

Thank you @saratvemulapalli. I have added the documentation to this PR.

[saratvemulapalli]

Thanks @VachaShah for adding the documentation.
Having this under Release notes and its automation will mask the problem its solving, because it helps beyond release notes and all documentation within the repo.

I would rather have it in https://github.com/opensearch-project/opensearch-plugins/blob/main/CONVENTIONS.md with a new top level section called Plugins Standards.
Or Have a new document for Plugin standards called STANDARDS.md and link it to the main Readme.

I am leaning towards the latter, as I see most of the items in #41 will go in here.
What do you guys think @VachaShah @dblock ?

[dblock]

I'm with @saratvemulapalli on the fact that if we put this in release notes, it gets read too late.

[dblock]

Capitalize Broken Links to match other titles.

[VachaShah]

@saratvemulapalli @dblock I have added a new STANDARDS.md and linked it to the main README.md.

[saratvemulapalli]

Just a minor comment. Everything looks good to me.

[saratvemulapalli]

This should go under OpenSearch Plugins like a subsection. Just like any other topic here.
The main header is for something which talks about this repository itself.

[VachaShah]

I have updated this in the README.

[saratvemulapalli]

Thanks @VachaShah !
Just address the minor comment and merge the changes.