48 lines
2.2 KiB
Markdown
48 lines
2.2 KiB
Markdown
<img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px">
|
|
|
|
# About the OpenSearch documentation repo
|
|
|
|
The `documentation-website` repository contains the user documentation for OpenSearch. You can find the rendered documentation at [opensearch.org/docs](https://opensearch.org/docs).
|
|
|
|
|
|
## Contributing
|
|
|
|
Community contributions remain essential to keeping the documentation comprehensive, useful, well organized, and up to date. If you are interested in submitting an issue or contributing content, see [CONTRIBUTING](CONTRIBUTING.md).
|
|
|
|
The following resources provide important guidance regarding contributions to the documentation:
|
|
|
|
- [OpenSearch Project Style Guidelines](STYLE_GUIDE.md) -- The style guide covers the style standards to be observed when creating OpenSearch Project content.
|
|
- [OpenSearch terms](TERMS.md) -- The terms list contains key OpenSearch terms and tips on how and when to use them.
|
|
- [API Style Guide](API_STYLE_GUIDE.md) -- The API Style Guide provides the basic structure for creating OpenSearch API documentation.
|
|
- [Formatting Guide](FORMATTING_GUIDE.md) -- The OpenSearch documentation uses a modified version of the [just-the-docs](https://github.com/pmarsceill/just-the-docs) Jekyll theme. The Formatting Guide provides an overview of the commonly used formatting elements and how to add a page to the website.
|
|
|
|
|
|
## Points of contact
|
|
|
|
If you encounter problems or have questions when contributing to the documentation, these people can help:
|
|
|
|
- [hdhalter](https://github.com/hdhalter)
|
|
- [kolchfa-aws](https://github.com/kolchfa-aws)
|
|
- [Naarcha-AWS](https://github.com/Naarcha-AWS)
|
|
- [vagimeli](https://github.com/vagimeli)
|
|
|
|
|
|
## Code of conduct
|
|
|
|
This project has adopted an [Open Source Code of Conduct](https://opensearch.org/codeofconduct.html).
|
|
|
|
|
|
## Security
|
|
|
|
If you discover a potential security issue in this project, we ask that you notify AWS/Amazon Security using our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Do **not** create a public GitHub issue.
|
|
|
|
|
|
## License
|
|
|
|
This project is licensed under the [Apache 2.0 License](LICENSE).
|
|
|
|
|
|
## Copyright
|
|
|
|
Copyright OpenSearch contributors.
|