Skip to content

Commit

Permalink
Merge pull request #61 from opensearch-project/ci-public-docs
Browse files Browse the repository at this point in the history
Adding guidance for Public docs and CI workflows for plugins
  • Loading branch information
saratvemulapalli authored Jun 24, 2021
2 parents 6d76b90 + 793f21c commit fe5720b
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions STANDARDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,33 @@ This document lists down the standards for OpenSearch plugins which can be used

- [Plugin Standards](#plugin-standards)
- [Broken Links Checker](#broken-links-checker)
- [Plugin Release Notes](#plugin-release-notes)
- [CI Workflows](#ci-workflows)
- [License Headers](#license-headers)
- [Public Documentation](#public-documentation)
- [Release Notes](#release-notes)

## 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
## CI Workflows

Release notes for plugins are located at [RELEASE_NOTES.md](RELEASE_NOTES.md).
CI Workflows should be setup to run and verify plugin unit and integration tests.
Workflows should run on main and release branches including pull requests merging into them.

_Example_: See CI Workflow in [anomaly-detection](https://github.com/opensearch-project/anomaly-detection/blob/main/.github/workflows/CI.yml).

## License Headers

License Header details are located at [HEADERS.md](HEADERS.md).
License Header details can be found at [HEADERS.md](HEADERS.md).

## Public Documentation

For all new features and functionality changes for every release should update the documentation via [documentation-website](https://github.com/opensearch-project/documentation-website).
Public documentation can be found at [docs-beta](https://docs-beta.opensearch.org/).

## Release Notes

Release notes for plugins can be found at [RELEASE_NOTES.md](RELEASE_NOTES.md).

0 comments on commit fe5720b

Please sign in to comment.