5f8ddb8060
* Rewrite Contributing and readme Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Changes to the structure Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update CONTRIBUTING.md Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Reordered sections Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Doc review changes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update CONTRIBUTING.md Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * added list of resources Signed-off-by: Heather Halter <hdhalter@amazon.com> * Moved front matter section to formatting guide and linting to contributing Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Delete word Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Minor rewording Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Change link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Implemented editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update CONTRIBUTING.md Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Heather Halter <hdhalter@amazon.com> Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2.2 KiB
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.
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.
The following resources provide important guidance regarding contributions to the documentation:
- OpenSearch Project Style Guidelines -- The style guide covers the style standards to be observed when creating OpenSearch Project content.
- OpenSearch terms -- The terms list contains key OpenSearch terms and tips on how and when to use them.
- API Style Guide -- The API Style Guide provides the basic structure for creating OpenSearch API documentation.
- Formatting Guide -- The OpenSearch documentation uses a modified version of the 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:
Code of conduct
This project has adopted an Open Source Code of Conduct.
Security
If you discover a potential security issue in this project, we ask that you notify AWS/Amazon Security using our vulnerability reporting page. Do not create a public GitHub issue.
License
This project is licensed under the Apache 2.0 License.
Copyright
Copyright OpenSearch contributors.