Skip to content

Added execution and updated installation section to Readme #175

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

Merged
merged 7 commits into from
Dec 15, 2022

Conversation

markovamaria
Copy link
Collaborator

@markovamaria markovamaria commented Dec 9, 2022

Related-to:
#105
#104

@markovamaria
Copy link
Collaborator Author

Hi @filipecosta90, could you please take a look? I've added execution section and slightly updated installation section.

By the way, I see 2 installation sections - in start of readme and below (which I updated). Should they be combined to 1?

@codecov-commenter
Copy link

Codecov Report

Base: 59.35% // Head: 59.35% // No change to project coverage 👍

Coverage data is based on head (e69c196) compared to base (e5938dd).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #175   +/-   ##
=======================================
  Coverage   59.35%   59.35%           
=======================================
  Files          24       24           
  Lines        1811     1811           
=======================================
  Hits         1075     1075           
  Misses        736      736           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Collaborator

@slice4e slice4e left a comment

Choose a reason for hiding this comment

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

Maria, you are right that there are 2 "Installation" section. I would agree that we should probably keep 1 of them. I would say the second one.
Then , notice that there are 2 ways to execute this. We have the coordinator and we have the standalone runner.
I think that you could add your execution section before the section: Testing out redis-benchmarks-spec-sc-coordinator
You could name it: Testing out the redis-benchmarks-spec-runner ...
And explain the difference.

@markovamaria
Copy link
Collaborator Author

Maria, you are right that there are 2 "Installation" section. I would agree that we should probably keep 1 of them. I would say the second one. Then , notice that there are 2 ways to execute this. We have the coordinator and we have the standalone runner. I think that you could add your execution section before the section: Testing out redis-benchmarks-spec-sc-coordinator You could name it: Testing out the redis-benchmarks-spec-runner ... And explain the difference.

Hi @slice4e, I removed one extra Installation section. I moved Execution to Contribution part. As it has installation dependencies, I moved Installation section to Contribution part too.

Honestly I slightly confused that Installation and Execution (testing out) is presented in Contribution part only. What if I don't want to add new benchmarks, but want to see Redis pass rate on benchmarks-specification? O_o
I would suggest to move it or duplicate before "Contributing guidelines". Please let me know what is preferable.

Also I added Navigation in top of page for easy usage.

@markovamaria markovamaria requested a review from slice4e December 12, 2022 19:30
@markovamaria
Copy link
Collaborator Author

Hi @slice4e , @filipecosta90 , could you please look at CI falures? Seems like there is some connection issue, running tox from Readme locally gives me the same problem. How may I fix it?

Readme.md Outdated
- [Adding a continuous benchmark platform](#adding-a-continuous-benchmark-platform)
- [Installing package requirements](#installing-package-requirements)
- [Installing Redis benchmarks specification](#installing-redis-benchmarks-specification-implementations)
- [Testing out the redis-benchmarks-spec-runner](#testing-out-the-redis-benchmarks-spec-runner)
Copy link
Contributor

Choose a reason for hiding this comment

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

rename it to> redis-benchmarks-spec-client-runner

filipecosta90
filipecosta90 previously approved these changes Dec 14, 2022
@filipecosta90 filipecosta90 added the documentation Improvements or additions to documentation label Dec 15, 2022
@filipecosta90
Copy link
Contributor

Thank you @markovamaria . Approving!

@filipecosta90 filipecosta90 merged commit 216e028 into redis:main Dec 15, 2022
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.

4 participants