-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding a plugin standards file including broken link checker
Signed-off-by: Vacha Shah <vachshah@amazon.com>
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |