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] Enhance OpenSearch Benchmark Documentation #611

Closed
IanHoang opened this issue Aug 6, 2024 · 4 comments
Closed

[META] Enhance OpenSearch Benchmark Documentation #611

IanHoang opened this issue Aug 6, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@IanHoang
Copy link
Collaborator

IanHoang commented Aug 6, 2024

The OSB documentation debuted in 2023 and has been improved on over the course of the last year. As new users join the community and OSB continues to grow, the documentation should be continuously refined. This META issue is dedicated to making enhancements towards the documentation.

Below is a table of planned enhancements to the documentation:

Page Title / Task Which Section to Add in PRs Status
OSB 2.0.0 & Migration Steps User Guide & Reference opensearch-project/documentation-website#7888 Doc-Review
Enhance Operations Reference User Guide & Reference https://github.com/opensearch-project/documentation-website/pull/7974/files Doc-Review
Glossary Reference In Progress
Flesh out Telemetry Devices in User Guide Reference Not Started
Reorganize User Guide into Sub Sections Reference Not Started
Build Custom Components Tutorials Not Started
Create Workload Enhancements User Guide Not Started
Performance Testing Best Practices User Guide Not Started
How to Duplicate the Nightly Runs Setup Tutorials Not Started
Enhance Developer Documentation User Guide Not Started
Tutorial: Setup OSB in a VPC / non-VPC Tutorials Not Started
@IanHoang IanHoang added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 6, 2024
@IanHoang IanHoang removed the untriaged label Aug 6, 2024
@IanHoang IanHoang moved this from 🆕 New to 🏗 In progress in Engineering Effectiveness Board Aug 6, 2024
@IanHoang IanHoang self-assigned this Aug 6, 2024
@Naarcha-AWS
Copy link
Contributor

Enhance Operations Reference is In-Progress. We'll start the Glossary this week as well.

@IanHoang
Copy link
Collaborator Author

IanHoang commented Aug 26, 2024

OSB 2.0.0 document is ready and will be converted to draft until we are ready to release OSB 2.0.0

@IanHoang
Copy link
Collaborator Author

IanHoang commented Oct 1, 2024

Let's convert this to a board and convert them items into issues

@IanHoang
Copy link
Collaborator Author

IanHoang commented Oct 3, 2024

Closing this as we can now use the board https://github.com/orgs/opensearch-project/projects/228/views/1

@IanHoang IanHoang closed this as completed Oct 3, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Engineering Effectiveness Board Oct 3, 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 enhancement New feature or request
Projects
Status: ✅ Done
Status: This Quarter
Development

No branches or pull requests

2 participants