sitespeedio / sitespeedio/sitespeed.io
Make the tutorial (especially on the sitespeed.io frontpage) more newbie-friendly
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 5k
- Forks
- 624
- Avg merge
- 4h 8m
- Merged PRs (30d)
- 2
Description
Instead of just this line with little explanation:
docker run --rm -v "$(pwd):/sitespeed.io" sitespeedio/sitespeed.io:19.1.0 https://www.sitespeed.io/
It would be great to have an example page that isn't sitespeed.io, like
docker run --rm -v "$(pwd):/sitespeed.io" sitespeedio/sitespeed.io:19.1.0 https://www.sitetobetested.com/
And also a line about where the test result ends up on the harddrive. I didn't understand at all how to use this tool, but just a minute of watching https://www.youtube.com/watch?v=0xAdxCUX2Po&ab_channel=sitespeed.io cleared it up for me.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the tutorial on the sitespeed.io front page and locate the existing Docker command. Replace the self-referential URL with a generic example and explain where the test results are saved on the hard drive. Done means a newcomer can run the example and find its output without relying on the linked video.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100