sauce-docs icon indicating copy to clipboard operation
sauce-docs copied to clipboard

Improve docs for SC5 Docker set-up

Open ab91 opened this issue 1 year ago • 6 comments
trafficstars

Description

  • Adds bash script with comments detailing each command.
  • Clarifies env var value assignments with clear placeholders, examples, notes
  • Minor language adjustment around specifying arguments

Motivation and Context

These changes makes Sauce Connect 5 setup a little bit easier for new Sauce Connect 5 users.

Types of Changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)
  • [x] Documentation fix (typos, incorrect content, missing content, etc.)

ab91 avatar Mar 12 '24 19:03 ab91

Just fyi @mfranzonello2

ab91 avatar Mar 12 '24 19:03 ab91

Please fix the build @ab91

mmatczuk avatar Apr 30 '24 11:04 mmatczuk

@ab91 can you please rebase.

mmatczuk avatar May 28 '24 07:05 mmatczuk

@mmatczuk would you like the revisions? If the revisions are stale or unwanted, I'll just close the PR instead of rebasing for proper merge.

ab91 avatar Jun 05 '24 18:06 ab91

Left some comments. Overall the change is legitimate.

mmatczuk avatar Jun 06 '24 08:06 mmatczuk

Thoughts @mmatczuk?

ab91 avatar Jun 11 '24 03:06 ab91

Thanks @ab91 for the contribution. I'm closing this as now we use sth like

docker run \
  -e SAUCE_USERNAME="<usename>" \
  -e SAUCE_ACCESS_KEY="<access-key>" \
  -e SAUCE_REGION="<region>" \
  -e SAUCE_TUNNEL_NAME="<tunnel-name>" \
  saucelabs/sauce-connect

mmatczuk avatar Sep 03 '24 09:09 mmatczuk