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

Document Reorganization #382

Open
xusine opened this issue Sep 20, 2022 · 0 comments
Open

Document Reorganization #382

xusine opened this issue Sep 20, 2022 · 0 comments

Comments

@xusine
Copy link
Contributor

xusine commented Sep 20, 2022

This is the suggestion from Mark.

It would be good to divide the documentation into a README file which describes simply how to run the benchmark, and a more detailed document (perhaps a PDF) with the architecture of the load generator, how to run an experiment, and how to set various parameters to create certain scenarios. This would give more structure to each file (i.e., the README which is visible by default just explains the architecture of the benchmark and how to run it, and then more details are available for those who are curious to tune it).

Maybe a better way for organizing all the document is to have a standalone web site subordinated by the cloudsuite.ch. We can use the same template used by the Linux kernel documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant