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

[DOCUMENTATION] Streamline User Guide #663

Open
IanHoang opened this issue Oct 3, 2024 · 1 comment
Open

[DOCUMENTATION] Streamline User Guide #663

IanHoang opened this issue Oct 3, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@IanHoang
Copy link
Collaborator

IanHoang commented Oct 3, 2024

Is your feature request related to a problem? Please describe

Currently, OSB has a comprehensive User Guide section. We can streamline this to make it more digestible.

Describe the solution you'd like

Something like this might be beneficial. Open to other ideas as well.

opensearch-benchmark-documentation
├── quickstart
│   ├── run-osb
│   └── run-osb-with-your-cluster
├── user_guide
│   ├── concepts
│   │   └── target_throughput
│   ├── setup
│   │   ├── installation
│   │   └── configuration
│   ├── understanding_workloads
│   │   ├── anatomy_of_a_workload
│   │   ├── common_operations
│   │   └── choosing_a_workload
│   ├── running_workloads
│   │   └── running_distributed_workloads
│   ├── understanding_results
│   └── refine_benchmarking
│       ├── custom_workloads
│       │  ├── sharing_custom_workloads
│       │  ├── creating_custom_workloads
│       │  └── finetuning_custom_workloads
│       └── telemetry_devices
├── tutorials
│    └── sigv4_support
└─── references
    ├── metrics_reference
    │   ├── metric_records
    │   └── metric_keys
    ├── workload_reference
    │   ├── indices
    │   ├── test_procedures
    │   ├── operations
    │   └── corpora
    ├── command_reference
    │   ├── execute_test
    │   ├── command_flags
    │   ├── info
    │   ├── download
    │   ├── list
    │   └── compare
    └── telemetry_devices_reference

Describe alternatives you've considered

No response

Additional context

No response

@IanHoang IanHoang added documentation Improvements or additions to documentation enhancement New feature or request untriaged and removed untriaged labels Oct 3, 2024
@IanHoang
Copy link
Collaborator Author

IanHoang commented Oct 3, 2024

Nate put out a PR here: opensearch-project/documentation-website#8387

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
Development

No branches or pull requests

1 participant