sitespeedio / sitespeedio/sitespeed.io

Documentation Issue - Continuous Testing - Docker - Bare Minimum Config settings

Open
#2,708 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
5k
Forks
624
Avg merge
4h 8m
Merged PRs (30d)
2

Description

Continuous Testing - Docker - For a Newbie.
The issue was first raised on Slack and I was requested to log an issue to address the documentation.

  • I am quite new to sitespeed.io generally but I have been able to get things going very easily (up to a point) thanks to the wonderful dockers which are available
  • I can run tests manually and everything appears as expected in the dashboards and now I want to move to continuous testing and have read the documentation many times and still feel totally confused.
  • The documentation in this areas seems to be written more like a record of how the solution is being used internally for the sitespeed.io team rather than a guide for how to get up and running - and I am finding it difficult to connect the dots.
  • I have forked the repository, I have updated the test URLs and I know that I want to mainly focus on simple emulated mobile on 4g (and possibly desktop) testing.
  • Where I think it becomes really confusing is regarding the configuration. Would it be possible to extend the documentation for probably a lot of people who are running the dockers on a local Linux server and explain what exactly needs to be done with the config files.
  • Perhaps most people are running on AWS and want call backs to Slack but for the "up and running in 5 minutes" people who just want to loop the current testing - it feels like a huge jump
  • What is the bare minimum I need to change to get this working. What can I / should I remove - I can guess but it would be helpful with guidance
  • Are other people running continuous testing from the dockers on a local linux server - can you share your config files (minus any secrets)- and anything else you needed to adjust

https://sitespeedio.slack.com/archives/C03DHTPSA/p1571386495051800

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the continuous testing Docker documentation and its configuration examples, focusing on the local Linux-server setup described in the issue. Identify the minimum settings for emulated mobile 4G testing and explain which optional settings can be omitted. Done means a newcomer can follow the guide from a local Docker installation to a repeating test run without Slack, AWS, or undocumented configuration changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.