shotor / documentation-website Goto Github PK

View Code? Open in Web Editor NEW

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.

License: Apache License 2.0

Shell 3.24% JavaScript 12.52% Ruby 5.30% CSS 13.86% HTML 33.02% Smarty 0.28% SCSS 31.79%

documentation-website's Introduction

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.