The documentation-website repository contains the user documentation for OpenSearch. You can find the rendered documentation at opensearch.org/docs.
The markdown files in this repository are rendered into HTML pages using Jekyll. Check the DEVELOPER_GUIDE for more information about how to use Jekyll for this repository.
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.
If you encounter problems or have questions when contributing to the documentation, these people can help:
This project has adopted an Open Source Code of Conduct.
If you discover a potential security issue in this project, notify OpenSearch Security directly by emailing security@opensearch.org. To prevent any additional risk caused by the potential issue, do not create a public GitHub issue.
This project is licensed under the Apache 2.0 License.
Copyright OpenSearch contributors.
