[META] Improve documentation for OpenSearch-Benchmark

[achitojha]

Create documentation for OpenSearch Benchmark. This should help users understand various nuances inside OpenSearch Benchmark

[LuluNwenyi]

Hello, @achitojha I would love to get my hands on this. However, I'd like to know more about this project so I can understand what needs to be documented.

[achitojha]

Hi @LuluNwenyi

Thanks for showing interest in contributing to this project. We're working towards coming up with more concrete and smaller scope issues which could be completed with a few PRs. This issue will be tracking all the work across all of the issues. We will soon put out these issues and you can start contributing.

Here's some resources you can use to get familiar with OpenSearch Benchmark :

• Developer Guide
• Readme document

[sharp-pixel]

Any update on this issue?

[bbarani]

Overall documentation including developer guide and readme.md needs to be updated to reflect the current status. We will be working on closing these gaps soon.

[gkamat]

First release of the documentation is now online. This will continue to be updated and enhanced going forward.

[IanHoang]

Documentation enhancements are being tracked in this META issue now: https://github.com/opensearch-project/opensearch-benchmark/issues/611