move cloud service documentation to the options page (#3909)

* move cloud service documentation to the options page * add minor note
webdriverio · May 1, 2019 · 4359ebd · 4359ebd
1 parent dcd876f
commit 4359ebd
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 24 deletions.
diff --git a/docs/Options.md b/docs/Options.md
@@ -197,11 +197,43 @@ reporters: [
 ```
 
 ### execArgv
-Node arguments to specify when launching child processes
+Node arguments to specify when launching child processes.
 
 Type: `String[]`
 Default: `null`
 
+### user
+Your cloud service username (only works for [Sauce Labs](https://saucelabs.com/), [Browserstack](https://www.browserstack.com/) or [TestingBot](https://testingbot.com/) accounts). If set, WebdriverIO will automatically set connection options for you.
+
+Type: `String`
+Default: `null`
+
+### key
+Your cloud service access key or secret key (only works for [Sauce Labs](https://saucelabs.com/), [Browserstack](https://www.browserstack.com/) or [TestingBot](https://testingbot.com/) accounts). If set, WebdriverIO will automatically set connection options for you.
+
+Type: `String`
+Default: `null`
+
+### region
+If running on Saue Labs you can choose to run tests between different datacenters: US or EU. To change your region to EU add `region: 'eu'` to your config.
+
+__Note:__ This only has an effect if you provide `user` and `key` options that are connected to your Sauce Labs account.
+
+Type: `String`<br>
+Default: `us`
+
+*(only for vm and or em/simulators)*
+
+### headless
+Sauce Labs provides an [headless offering](https://saucelabs.com/products/web-testing/sauce-headless-testing) that allows you to run Chrome and Firefox tests headless.
+
+__Note:__ This only has an effect if you provide `user` and `key` options that are connected to your Sauce Labs account.
+
+Type: `Boolean`<br>
+Default: `false`
+
+*(only for vm and or em/simulators)*
+
 ## Hooks
 
 WebdriverIO allows you to set hooks to interfere into the test lifecycle in order to e.g. take screenshot if a test fails. Every hook has as parameter specific information about the lifecycle (e.g. information about the test suite or test). The following hooks are available: `onPrepare`, `beforeSession`, `before`, `beforeSuite`, `beforeHook`, `afterHook`, `beforeTest`, `beforeCommand`, `afterCommand`, `afterTest`, `afterSuite`, `after`, `afterSession`, `onComplete`, `onReload`, `beforeFeature`, `beforeScenario`, `beforeStep`, `afterStep`, `afterScenario`, `afterFeature`.

diff --git a/packages/wdio-sauce-service/README.md b/packages/wdio-sauce-service/README.md
@@ -60,21 +60,7 @@ capabilities = [
 ]
 ```
 
-## Options
-
-### user
-Your Sauce Labs username.
-
-Type: `String`
-
-*(only for vm and or em/simulators)*
-
-### key
-Your Sauce Labs access key.
-
-Type: `String`
-
-*(only for vm and or em/simulators)*
+## Sauce Service Options
 
 ### sauceConnect
 If true it runs Sauce Connect and opens a secure connection between a Sauce Labs virtual machine running your browser tests.
@@ -84,14 +70,6 @@ Default: `false`
 
 *(only for vm and or em/simulators)*
 
-### region
-Currently there is 2 Sauce Labs regions to choose: US and EU. To change your region to EU add `region:'eu'` to Sauce Labs config.
-
-Type: `String`<br>
-Default: `us`
-
-*(only for vm and or em/simulators)*
-
 ### sauceConnectOpts
 Apply Sauce Connect options (e.g. to change port number or logFile settings). See [this list](https://github.com/bermi/sauce-connect-launcher#advanced-usage) for more information.