search

godaddy / timings

NodeJS/Express API to assert performance results during functional testing
MIT License
45 stars 11 forks source link

Quick Starting guide and Documentation is missing #56

Open pligor opened 5 years ago

pligor commented 5 years ago

Dear GoDaddy team As you can imagine there is not much capacity in Story Points for innovation per scrum sprint. We need to go from zero to hero within a couple of days on every investigation/innovation jira ticket. The documentation you have provided is a thorough one but it is useful only for advanced users. Could you provide a couple of scenarios that are common and useful as ready and then we can delve-in to more details ? For example a quick-start guide of how to assert the timing of all the API calls of a certain page is a good use-case. And please add info of why you are using the parameters you are using etc. Another good example is measuring the case study where you measure the navigation time of the entire page and you just assert against a single number. You might be able to think of more useful case-studies to include.

Unfortunately we don't have time to learn all the specifics the performance api but we want to use it and improve our performance. Could you help by providing quick start guide either on README.md or in a blog post ?

Many thanks

mverkerk-godaddy commented 5 years ago

Great recommendation @pligor! I will have a look at what/when i can do to add some quick-start scenarios that are easier to follow. I agree that the current README is rather lengthy. I wanted to make sure that everything was covered and it grew to something that is a bit too long ... i also thought about shortening the main README and link to sub-documents with more detail ... thx again!

mverkerk-godaddy commented 4 years ago

Hi @pligor - i have started adding some pages to the Wiki and I'm curious if you think this is going in the right direction. Please have a look at https://github.com/godaddy/timings/wiki and let me know what you think! There is a lot more that i can add but it will take some time ... Thanks!

pligor commented 4 years ago

@Verkurkie many thanks for taking the time to write the Wiki The examples are useful for a deeper understanding as a next step. The use cases Asserting Pageload time are exactly what a beginner needs, a play button, a step by step guide to get up and running Let's hope this is an easy integration. I'll let you know when we devote time to deal with it.

Basically the test is like so: Give the wiki to a software engineer who has never dealt with responses time in the past and see if he can follow the steps without issues to assert the page load time locally and deploy it in server. Then you know you have given the community this stepping stone to start using this repo and getting more stars at the repo is also a way to evaluate it.

Again thanks for helping