Skip to content

Commit

Permalink
Adding a plugin standards file including broken link checker
Browse files Browse the repository at this point in the history
Signed-off-by: Vacha Shah <vachshah@amazon.com>
  • Loading branch information
VachaShah committed Jun 22, 2021
1 parent ad91ca8 commit 370f0cc
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions STANDARDS.md
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).

0 comments on commit 370f0cc

Please sign in to comment.