-
Notifications
You must be signed in to change notification settings - Fork 203
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
Fix the arewefastyet desgin documentation #1263
Conversation
Signed-off-by: Florent Poinsard <[email protected]>
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
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.
LGTM!
@@ -10,21 +10,25 @@ With the codebase of Vitess becoming larger and complex changes getting merged, | |||
|
|||
## Benchmarking Tool | |||
|
|||
To solve the aforementioned issue, we use a tool named arewefastyet that automatically tests the performance of Vitess. The performance are measured through a set of benchmarks divided into two categories: `micro` and `macro`, the former focuses on unit-level functions, and the latter targets system-wide performance changes. Those benchmarks are run every night if there are new commits, release or pull request needing benchmarks. | |||
To solve the aforementioned issue, we use a tool named arewefastyet that automatically tests the performance of Vitess. The performance are measured through a set of benchmarks divided into two categories: `micro` and `macro`, the former focuses on unit-level functions, and the latter targets system-wide performance changes. | |||
|
|||
The GitHub repository where lies all of arewefastyet's code can be found on [vitessio/arewefastyet](https://github.com/vitessio/arewefastyet). |
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.
fount 'at'/ fount 'here' instead of found 'on'??
### Pull Request needing benchmarks | ||
|
||
When a pull request affect the performance of Vitess, one might wish to benchmark it before merging it. The latter can be done by setting the `Benchmark me` label to your pull request. Each night, at midnight central european time, the head commit of your pull request will be benchmarked and compared against the pull request's base. | ||
When a pull request affect the performance of Vitess, one might wish to benchmark it before merging it. The latter can be done by setting the `Benchmark me` label to your pull request. Following the Pull Request CRON schedule, the head commit of your pull request will be benchmarked and compared against the pull request's base. |
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 latter can be done
This can be done ..
### Pull Request needing benchmarks | ||
|
||
When a pull request affect the performance of Vitess, one might wish to benchmark it before merging it. The latter can be done by setting the `Benchmark me` label to your pull request. Each night, at midnight central european time, the head commit of your pull request will be benchmarked and compared against the pull request's base. | ||
When a pull request affect the performance of Vitess, one might wish to benchmark it before merging it. The latter can be done by setting the `Benchmark me` label to your pull request. Following the Pull Request CRON schedule, the head commit of your pull request will be benchmarked and compared against the pull request's base. |
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.
trying to understand , what is meant by 'Following the Pull Request CRON schedule' ,
is it
'after the PR, the subsequent scheduled call for CRON job will benchmark the head commit of pull request and compare it against the pull request's base.
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.
Correct
@rsajwani I opened a new PR to adresse your comments. |
This PR fixes #1260. And is part of the parent issue: #1222