Adding broken links check using github actions

.github/workflows/links.yml

@@ -0,0 +1,23 @@
+name: Link Checker
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  linkchecker:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: lychee Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@master
+        with:
+          args: --accept=200,403,429  "**/*.html" "**/*.md" "**/*.txt" "**/*.json"
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - name: Fail if there were link errors
+        run: exit ${{ steps.lychee.outputs.exit_code }}

README.md

@@ -1,11 +1,12 @@
 - [OpenSearch Plugins](#opensearch-plugins)
-    - [Naming Conventions](#naming-conventions)
-    - [Managing OpenSearch Plugins](#managing-opensearch-plugins)
-    - [Building Plugins with OpenSearch](#building-plugins-with-opensearch)
-    - [Upgrading Plugins to work with OpenSearch](#upgrading-plugins-to-work-with-opensearch)
-    - [Installing Plugins](#installing-plugins)
-    - [Plugin Release Notes](#plugin-release-notes)
-    - [Headers](#headers)
+  - [Naming Conventions](#naming-conventions)
+  - [Managing OpenSearch Plugins](#managing-opensearch-plugins)
+  - [Building Plugins with OpenSearch](#building-plugins-with-opensearch)
+  - [Upgrading Plugins to work with OpenSearch](#upgrading-plugins-to-work-with-opensearch)
+  - [Installing Plugins](#installing-plugins)
+  - [Plugin Release Notes](#plugin-release-notes)
+  - [Headers](#headers)
+  - [Standards](#standards)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -42,6 +43,10 @@ Plugins generally use a standard format for release notes, see [RELEASE_NOTES](.
 
 See [HEADERS](HEADERS.md) for details of headers including licenses.
 
+### Standards
+
+See [STANDARDS](STANDARDS.md) for information regarding plugin standards.
+
 ## Contributing
 
 See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

STANDARDS.md

@@ -0,0 +1,22 @@
+# Plugin Standards
+
+This document lists down the standards for OpenSearch plugins which can be used by plugin authors.
+
+- [Plugin Standards](#plugin-standards)
+  - [Broken Links Checker](#broken-links-checker)
+  - [Plugin Release Notes](#plugin-release-notes)
+  - [License Headers](#license-headers)
+
+## Broken Links Checker
+
+Create a Github Actions workflow to check for broken links in text files (.md, .html, .txt, .json) on pull requests and push. See [.github/workflows/links.yml](.github/workflows/links.yml) for an example.
+
+See [lycheeverse/lychee-action](https://github.com/lycheeverse/lychee-action) for more information.
+
+## Plugin Release Notes
+
+Release notes for plugins are located at [RELEASE_NOTES.md](RELEASE_NOTES.md).
+
+## License Headers
+
+License Header details are located at [HEADERS.md](HEADERS.md).