Skip to content

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

License

Notifications You must be signed in to change notification settings

jed326/documentation-website

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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, 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.

License

This project is licensed under the Apache 2.0 License.

Copyright

Copyright OpenSearch contributors.

About

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 60.7%
  • SCSS 20.5%
  • CSS 7.4%
  • JavaScript 6.7%
  • Ruby 2.9%
  • Shell 1.7%
  • Smarty 0.1%