Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[META] Create documentation for OpenSearch-Benchmark #101

Closed
achitojha opened this issue Jan 6, 2022 · 6 comments
Closed

[META] Create documentation for OpenSearch-Benchmark #101

achitojha opened this issue Jan 6, 2022 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@achitojha
Copy link
Contributor

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

@LuluNwenyi
Copy link

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
Copy link
Contributor Author

achitojha commented Jan 10, 2022

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 :

@sharp-pixel
Copy link
Contributor

Any update on this issue?

@bbarani
Copy link
Member

bbarani commented Feb 8, 2023

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.

@bbarani bbarani changed the title Documentation [META] Improve documentation for OpenSearch-Benchmark Feb 10, 2023
@bbarani bbarani added the documentation Improvements or additions to documentation label Feb 10, 2023
@bbarani bbarani moved this from Not started to In Progress in OpenSearch Engineering Effectiveness Feb 28, 2023
@gkamat gkamat self-assigned this Apr 18, 2023
@IanHoang IanHoang self-assigned this May 2, 2023
@gkamat
Copy link
Collaborator

gkamat commented Jun 5, 2023

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

@gkamat gkamat moved this from 🆕 New to 🏗 In progress in Engineering Effectiveness Board Aug 2, 2024
@IanHoang IanHoang closed this as completed Aug 6, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Engineering Effectiveness Board Aug 6, 2024
@IanHoang
Copy link
Collaborator

IanHoang commented Aug 6, 2024

Documentation enhancements are being tracked in this META issue now: #611

@IanHoang IanHoang changed the title [META] Improve documentation for OpenSearch-Benchmark [META] Create documentation for OpenSearch-Benchmark Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

No branches or pull requests

6 participants