-
Notifications
You must be signed in to change notification settings - Fork 27
[Docs] Update documentation to be more readable #96
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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 | |||
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 | |||
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
|
Can we have a more detailed PR description and some highlights on the changes? |
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
How Has This Been Tested?
View changes with make docs-serve
Checklist
git pull origin main)make checkto ensure code is properly formatted and passes all lint checksmake testormake test_changedto verify test coverage (~90% required)Additional Information
Add any other context, screenshots, or information about the PR here.