Skip to content

Conversation

@TJ5
Copy link
Collaborator

@TJ5 TJ5 commented Oct 24, 2025

Description

The documentation is somewhat hard to navigate as it is, this PR addresses this.

What type of PR is this?

/kind Docs

Changes Made in this PR

  • Trim down README.md, remove metrics explanation and add an installation section
  • Remove Examples page since all of the content was already in the user guide
  • Update Command Guidelines to much more thoroughly cover relevant arguments
image Caption: screenshot of command guidelines page, detailing relevant command line arguments for benchmark command
  • Move traffic scenario and concurrency information from the "Monitor a benchmark" heading, which was a poor description.
  • Update the explanations for concurrency and traffic scenarios in the run benchmark page
  • Minor tweaks on the run benchmark page. Added a blurb explaining datasets better, reorganized distributed benchmark section, added a note on concurrencies which were not really explained before.
  • Move API Reference from the pane to the Development page since with the updated Command Guidelines page it was mostly targeted at contributers
  • Update API Reference to detail the relevant project components
  • Reorganize the content detailing how to add certain components into a new page under the Development category
  • Get rid of the old contributing.md page and merge the unique content there with the development page, since there was already a lot of overlap
image Caption: screenshot of the page organization of the development section. New pages 'Adding New Features' and 'API Reference' have been added. Old 'Contributing' page is deleted. Also present is the navigation bar, which no longer has the old Examples and API Reference pages.

How Has This Been Tested?

View changes with make docs-serve

Checklist

  • I have rebased my branch on top of the latest main branch (git pull origin main)
  • I have run make check to ensure code is properly formatted and passes all lint checks
  • I have run make test or make test_changed to verify test coverage (~90% required)
  • I have added tests that fail without my code changes (for bug fixes)
  • I have added tests covering variants of new features (for new features)

Additional Information

Add any other context, screenshots, or information about the PR here.

@TJ5 TJ5 marked this pull request as ready for review October 24, 2025 18:27
Copy link
Collaborator

@CatherineSue CatherineSue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should consider removing the metrics section. Replace with an easy installation command, and a tl;dr command that makes users easy to understand how they can launch a benchmark.

Which file covers this part?

@@ -1,98 +0,0 @@
# API Reference
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't we move api-reference to this folder?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if I'm answering your question here, but I felt that the API Reference was better suited under the Development folder. This is especially true where we already have the command guidelines page (newly updated) to inform users about the command line args, which leaves the API reference to focus on documenting the project for contributors.

@@ -1,92 +0,0 @@
# Examples
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the whole folder removed or just this file?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be whole folder but git doesnt track empty folders.

- Traffic Scenarios: user-guide/scenario-definition.md
- Multi-Cloud Authentication: user-guide/multi-cloud-auth-storage.md
- Quick Reference: user-guide/multi-cloud-quick-reference.md
- Multi-Cloud Quick Reference: user-guide/multi-cloud-quick-reference.md
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have a quick reference for multi-cloud and an authentication?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The quick reference is more concise and is filled with very easy to use examples, while the multi-cloud auth page is much more thorough and much longer We could combine these in theory but I think the resulting page would be incredibly long and a bit hard to navigate. I didn't make any content changes to those pages, I just renamed the page from 'Quick Reference' to Multi-Cloud Quick Reference in the navigation bar since calling it Quick Reference was misleading for what the page showed.

@CatherineSue
Copy link
Collaborator

Can we have a more detailed PR description and some highlights on the changes?

@CatherineSue CatherineSue added documentation Improvements or additions to documentation feature and removed feature labels Oct 24, 2025
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

None yet

Development

Successfully merging this pull request may close these issues.

2 participants