diff --git a/docs/api-testing/composer/other-components.md b/docs/api-testing/composer/other-components.md index 62dfe2a726..e0d14417b2 100644 --- a/docs/api-testing/composer/other-components.md +++ b/docs/api-testing/composer/other-components.md @@ -22,7 +22,7 @@ Here are some other components that you can add to a test using the Composer. Th The Tag component within the Composer enables you to dynamically tag the resulting document of a test execution. You can add different tags based on dynamic events happening during the test execution, such as a certain value retrieved in the payload. You can assign multiple tags to each test by adding more 'tag' components to it. -This is different from the tags applied when you first [create the test](/api-testing/composer/#create-a-composer-test). That feature enables you to search for that tag(s) filter in your Project **Tests** tab or [**Dashboard**](/api-testing/project-dashboard) tab. +This is different from the tags applied when you first [create the test](/api-testing/composer/#create-a-test). That feature enables you to search for that tag(s) filter in your Project **Tests** tab or [**Dashboard**](/api-testing/project-dashboard) tab.
Parameters @@ -317,7 +317,7 @@ This component allows you to pause or stop a test entirely. #### Examples -This component is especially useful when combined with the [`If` component](#if). See the examples below: +This component is especially useful when combined with the [`If` component](/api-testing/composer/logical-components/#if). See the examples below: flow_stop.png diff --git a/docs/api-testing/integrations/apifctl-cicd-integration.md b/docs/api-testing/integrations/apifctl-cicd-integration.md index fe9be74d3a..500d479cf6 100644 --- a/docs/api-testing/integrations/apifctl-cicd-integration.md +++ b/docs/api-testing/integrations/apifctl-cicd-integration.md @@ -489,7 +489,7 @@ Identifies the ID of the event you want to see. For use with the **[`event`](#ev

| STRING |

-Adding this parameter allows you to specify the build ID you want to run your tests against. For use with the **[`run`](#run)**, **[`run-all`](#run-all)**, **[`run-tag`](#run-tag)**, and **[`exec`](#exec)** commands. For more information, see [Test Builds](/api-testing/project-dashboard/#test-builds). +Adding this parameter allows you to specify the build ID you want to run your tests against. For use with the **[`run`](#run)**, **[`run-all`](#run-all)**, **[`run-tag`](#run-tag)**, and **[`exec`](#exec)** commands. For more information, see [Test Builds](/api-testing/project-dashboard/#test-build-reports). ```bash -b build-12345 diff --git a/docs/api-testing/load-testing.md b/docs/api-testing/load-testing.md index d1f5905ff7..2ed3f7ef8f 100644 --- a/docs/api-testing/load-testing.md +++ b/docs/api-testing/load-testing.md @@ -103,7 +103,10 @@ Load test reports include the following details: - **Virtual Users** - The number of virtual users for the execution of the test. - **Failed Tests** - The number of load test execution failures. This will only be visible if there were failures. -The **Footprint** dropdown shows all the endpoints the test is calling, which you can use to filter to a specific endpoint. The default value shows the data for All the endpoints. For best results, set up footprints to ensure the report is readable. For more information, see [Improving Metrics](/api-testing/composer#improving-metrics). +The **Footprint** dropdown shows all the endpoints the test is calling, which +you can use to filter to a specific endpoint. The default value shows the data +for All the endpoints. For best results, set up footprints to ensure the report +is readable. For more information, see [Improving Metrics](/api-testing/use-cases/working-with-headers/#improving-metrics). The Footprint dropdown diff --git a/docs/api-testing/on-prem/api/using-the-api.md b/docs/api-testing/on-prem/api/using-the-api.md index b767f6f27a..ec0cbe5372 100644 --- a/docs/api-testing/on-prem/api/using-the-api.md +++ b/docs/api-testing/on-prem/api/using-the-api.md @@ -39,18 +39,6 @@ https://mastiff.apifortress.com/app/api/rest/v3/34d8mm70-c03e-267a-9fa1-90b9flsb > > This is useful for later. -**Jump to a Section** - -- [Unauthenticated Endpoints](#unauthenticated-endpoints) - - [Run Tests](#test-run) - - [Insights (Data & Information)](#insights-data--information) -- [Authenticated endpoints](#authenticated-endpoints) - - [Authentication](#authentication) - - [Insights (Data & Information)](#insights) - - [Update Tests](#update-tests) - - [Creating Tests Outside of API Fortress](#creating-tests-outside-of-api-fortress) - - [Converting to JUnit Format](#converting-to-junit-format) - # Unauthenticated Endpoints ## Test Run diff --git a/docs/api-testing/use-cases/saving-token-kv.md b/docs/api-testing/use-cases/saving-token-kv.md index f91f631984..6eeb545ec5 100644 --- a/docs/api-testing/use-cases/saving-token-kv.md +++ b/docs/api-testing/use-cases/saving-token-kv.md @@ -135,7 +135,7 @@ To use the Key/Value Store in other tests in the same Organization, you have to - Key - for example `token` - Variable - for example `my_token` -`token` is the **Key** you assigned in the [first step](/#saving-a-token-in-a-keyvalue-store) of the previous example. +`token` is the **Key** you assigned in the [first step](#saving-a-token-in-a-keyvalue-store) of the previous example. `my_token` is the variable name you will use inside the test for referencing it. ## Refreshing the Token diff --git a/docs/api-testing/use-cases/use-drive.md b/docs/api-testing/use-cases/use-drive.md index 63c1f6e73f..bc885f4a82 100644 --- a/docs/api-testing/use-cases/use-drive.md +++ b/docs/api-testing/use-cases/use-drive.md @@ -139,7 +139,7 @@ Next, consider a scenario where the .csv file contains more columns and you have For this new example, consider a scenario where you have to create an account and you need to provide personal data as a request body. In a scenario like this, especially in a development phase, it is common to have a file with some data allowed by the system. -As with the previous example, the first step is [uploading your file to the Vault Drive](/api-testing/use-cases/use-drive/#step-1-uploading-the-file-in-the-vault-drive). +As with the previous example, the first step is [uploading your file to the Vault Drive](/api-testing/use-cases/use-drive/#step-1-uploading-the-file-in-vault-drive). This time, we are using _users.csv_ file that contains a list of user details as shown: diff --git a/docs/basics/acct-team-mgmt/adding-deactivating-users.md b/docs/basics/acct-team-mgmt/adding-deactivating-users.md index 03944de5cb..52581d9497 100644 --- a/docs/basics/acct-team-mgmt/adding-deactivating-users.md +++ b/docs/basics/acct-team-mgmt/adding-deactivating-users.md @@ -50,7 +50,12 @@ If you invite a user by email, you will need to wait until they accept your invi ### SSO Considerations -If SSO and the **Require Single Sign-On** option are enabled for your organization (see [Single Sign-On Settings](/basics/acct-team-mgmt/org-settings/#single-sign-on-settings)), new users will be outside your IdP. This means they will not be able to log in to Sauce Labs using the credentials you provided when you created their account (they will be able to run test automation, however). In this situation, you should add users manually. +If SSO and the **Require Single Sign-On** option is enabled for your +organization (see [Single Sign-On Settings](/basics/acct-team-mgmt/org-settings/#sso-advanced-options)), +new users will be outside your IdP. This means they will not be able to log in +to Sauce Labs using the credentials you provided when you created their account +(they will be able to run test automation, however). In this situation, you +should add users manually. If SSO is enabled but the **Require Single Sign-On** option is not, you can add new users manually, but not via email. diff --git a/docs/basics/acct-team-mgmt/managing-user-info.md b/docs/basics/acct-team-mgmt/managing-user-info.md index a9ee5f320d..84ea307d82 100644 --- a/docs/basics/acct-team-mgmt/managing-user-info.md +++ b/docs/basics/acct-team-mgmt/managing-user-info.md @@ -108,7 +108,12 @@ For more information on Sauce Connect and IPSec settings available to Organizati ## User Settings -The User Settings screen allows you to view and change your password and email address. You can also regenerate an access key, as well as copy a driver string (for more information, see [Regenerating Access Keys](/basics/acct-team-mgmt/managing-user-info/#regenerating-access-keys) and [Create a RemoteWebDriver Instance](/web-apps/automated-testing/selenium/#step-1-create-a-remotewebdriver-instance)). If you are an admin and want to change the settings for users in your org, see [Updating User Information](/basics/acct-team-mgmt/managing-user-info/#updating-user-information). +The User Settings screen allows you to view and change your password and email +address. You can also regenerate an access key, as well as copy a driver string +(for more information, see [Regenerating Access Keys](/basics/acct-team-mgmt/managing-user-info/#regenerating-access-keys) +and [Create a Remote Session](/web-apps/automated-testing/selenium/#step-1-create-a-remote-session)). +If you are an admin and want to change the settings for users in your org, see +[Updating User Information](/basics/acct-team-mgmt/managing-user-info/#updating-user-information). To access the User Settings screen, on Sauce Labs, click **ACCOUNT** and then click **User settings**. User Settings navigation diff --git a/docs/basics/acct-team-mgmt/viewing-exporting-usage-data.md b/docs/basics/acct-team-mgmt/viewing-exporting-usage-data.md index 4d4b5fcccd..066e740802 100644 --- a/docs/basics/acct-team-mgmt/viewing-exporting-usage-data.md +++ b/docs/basics/acct-team-mgmt/viewing-exporting-usage-data.md @@ -63,7 +63,14 @@ The USAGE widget provides a quick look at the device usage, by test session, for ## Minutes Used vs. Concurrency -One way to tell if you're getting the most efficient use out of your Sauce Labs plan is to compare the minutes used with the number of concurrent tests run during the same period. If the ratio of minutes to concurrency is low, for example, 2:1 (100 minutes:50 concurrent tests), then you are using a lot of minutes to run very few tests. You should redesign your tests to take greater advantage of concurrency. See [Using Frameworks to Run Tests in Parallel](/web-apps/automated-testing/selenium#using-frameworks-to-run-tests-in-parallel) and [Managing Concurrency](/basics/acct-team-mgmt/concurrency/managing-concurrency) for more information. +One way to tell if you're getting the most efficient use out of your Sauce Labs +plan is to compare the minutes used with the number of concurrent tests run +during the same period. If the ratio of minutes to concurrency is low, for +example, 2:1 (100 minutes:50 concurrent tests), then you are using a lot of +minutes to run very few tests. You should redesign your tests to take greater +advantage of concurrency. See [Scaling Tests](/web-apps/automated-testing/selenium/#scaling-tests) +and [Managing Concurrency](/basics/acct-team-mgmt/concurrency/managing-concurrency) +for more information. ## Exporting Usage Data diff --git a/docs/basics/integrations/jenkins.md b/docs/basics/integrations/jenkins.md index 31aba33696..7566babdbd 100644 --- a/docs/basics/integrations/jenkins.md +++ b/docs/basics/integrations/jenkins.md @@ -385,7 +385,8 @@ node('mac') { ### Creating the Sauce Publisher Snippet -The `{saucePublisher}` function lets you send test result data to Sauce Labs. See [Publishing Test Status to Sauce Labs](#publishing-test-status-to-sauce-labs). +The `{saucePublisher}` function lets you send test result data to Sauce Labs. +See [Publishing Test Status to Sauce Labs](#publish-test-status-to-sauce-labs). 1. Enable the **Snippet Generator** in Jenkins Pipeline. 1. Select **saucePublisher: Run Sauce Labs Test Publisher** and **Generate Groovy**. diff --git a/docs/basics/sso/setting-up-sso.md b/docs/basics/sso/setting-up-sso.md index 1e02f53d67..231f19193f 100644 --- a/docs/basics/sso/setting-up-sso.md +++ b/docs/basics/sso/setting-up-sso.md @@ -30,7 +30,9 @@ Sauce Labs supports the following features: ## Special Cases - If your company has more than one organization at Sauce Labs to be integrated with SAML SSO and your Identity Provider requires a unique entity ID for Service Providers, [see these special setup steps](/basics/sso/setting-up-sso-special-cases#single-identity-provider-and-multiple-organizations-at-sauce-labs). -- If your company has multiple organizations at Sauce Labs to be integrated with SAML SSO, and you want to use the same [email domain](#email-domains) across multiple organizations, please refer to [this section](/basics/sso/setting-up-sso-special-cases#the-same-email-domain-is-used-in-multiple-organizations-at-sauce-labs). +- If your company has multiple organizations at Sauce Labs to be integrated with +SAML SSO, and you want to use the same [email domain](#email-domains) across +multiple organizations, please refer to [this section](/basics/sso/setting-up-sso-special-cases/#multiple-organizations-with-the-same-email-domain-at-sauce-labs). ## Setup Overview diff --git a/docs/dev/cli/sauce-connect-5.md b/docs/dev/cli/sauce-connect-5.md index 897accde46..854e3eb8d7 100644 --- a/docs/dev/cli/sauce-connect-5.md +++ b/docs/dev/cli/sauce-connect-5.md @@ -82,4 +82,4 @@ Use "sc --help" for more information about a given command. ## Additional Resources - [Sauce Connect Proxy Basic Setup](/secure-connections/sauce-connect-5/installation/). -- [Sauce Connect Proxy Environment Variables](/secure-connections/sauce-connect-5/operation/configuration/#environment-variables/). +- [Sauce Connect Proxy Environment Variables](/secure-connections/sauce-connect-5/operation/configuration/#environment-variables). diff --git a/docs/dev/cli/sauce-connect-proxy.md b/docs/dev/cli/sauce-connect-proxy.md index f52bbd7a5e..b6972ea2e1 100644 --- a/docs/dev/cli/sauce-connect-proxy.md +++ b/docs/dev/cli/sauce-connect-proxy.md @@ -109,7 +109,7 @@ You can view the entire list of CLI options by running the `--help` flag. **Description**: Assigns a name to a Sauce Connect Proxy tunnel. It can also assign a name to a group of tunnels in the same [High Availability pool](/secure-connections/sauce-connect/setup-configuration/high-availability), when used with [`--tunnel-pool`](#--tunnel-pool). Must be in ASCII format. -You can run tests using this tunnel by specifying the [`tunnelName`](/dev/test-configuration-options/#tunnelname) in your test capabilities. To learn about the syntax for setting this as a capability, see [Test Configuration Options](/dev/test-configuration-options).
+You can run tests using this tunnel by specifying the [`tunnelName`](/dev/test-configuration-options#tunnelname) in your test capabilities. To learn about the syntax for setting this as a capability, see [Test Configuration Options](/dev/test-configuration-options).
**Environment variable**: `SAUCE_TUNNEL_IDENTIFIER`
**Shorthand**: `-i` @@ -129,7 +129,7 @@ This flag is deprecated and will be removed in future versions. It is replaced b **Description**: Assigns a name to a Sauce Connect Proxy tunnel. It can also assign a name to a group of tunnels in the same [High Availability pool](/secure-connections/sauce-connect/setup-configuration/high-availability), when used with [`--tunnel-pool`](#--tunnel-pool). Must be in ASCII format. -You can run tests using this tunnel by specifying the [`tunnelName`](/dev/test-configuration-options/#tunnelname) in your test capabilities. To learn about the syntax for setting this as a capability, see [Test Configuration Options](/dev/test-configuration-options).
+You can run tests using this tunnel by specifying the [`tunnelName`](/dev/test-configuration-options#tunnelname) in your test capabilities. To learn about the syntax for setting this as a capability, see [Test Configuration Options](/dev/test-configuration-options).
**Environment variable**: `SAUCE_TUNNEL_NAME`
**Shorthand**: `-i` @@ -389,7 +389,9 @@ Use `--logfile -` to print your log to the console window (stdout) instead of th

| OPTIONAL | STRING | 4.8.x 4.9.x |

-**Description**: Use this option to define the host:port for the internal web server used to expose the Sauce Connect Proxy runtime info. See the [Sauce Connect Proxy Monitoring](/secure-connections/sauce-connect/proxy-tunnels/#sauce-connect-proxy-monitoring) for more info. Disabled by default.
+**Description**: Use this option to define the host:port for the internal web +server used to expose the Sauce Connect Proxy runtime info. See [Sauce Connect Proxy Monitoring](/secure-connections/sauce-connect/proxy-tunnels/#monitoring-tunnels) +for more info. Disabled by default.
**Environment variable**: `SAUCE_STATUS_ADDRESS`
**Shorthand**: n/a diff --git a/docs/dev/error-messages.md b/docs/dev/error-messages.md index ad302a716f..5c58a471d5 100644 --- a/docs/dev/error-messages.md +++ b/docs/dev/error-messages.md @@ -278,7 +278,9 @@ Our device pool is available to all subscribed Sauce users and (as you might ima Instead of passing a specific `deviceName`: - When you select a device from the pool, use `appium:deviceName` to [select the device dynamically](/mobile-apps/supported-devices/#dynamic-device-allocation). This way you can specify the type of device (make, model, OS) instead of a specific device, which increases the likelihood of finding an appropriate device that is available for your test to run on. -- If you are looking for a specific OS version instead of a specific make and model, you can use the [`appium:platformVersion`](/dev/test-configuration-options/#appium) option to fetch a device with that OS regardless of make and model. +- If you are looking for a specific OS version instead of a specific make and +model, you can use the [`appium:platformVersion`](/dev/test-configuration-options#appiumplatformversion) +option to fetch a device with that OS regardless of make and model. ```java // specific deviceId diff --git a/docs/dev/glossary.md b/docs/dev/glossary.md index 23a02b02a7..c565d3679a 100644 --- a/docs/dev/glossary.md +++ b/docs/dev/glossary.md @@ -145,7 +145,7 @@ See also: _[CI/CD pipeline](#cicd-pipeline)_. ### Continuous Testing Benchmark -See: _[Sauce Labs Continuous Testing Benchmark](#sauce-continuous-testing-benchmark)_. +See: _[Continuous Testing Benchmark](#continuous-testing-benchmark)_. ### Cross-Browser Compatibility @@ -338,7 +338,7 @@ See: _[enterprise customer](#enterprise)_. ### Manual Testing -See:[live testing](#live-testing). +See:[live testing](#live-testing-lt). ### MMORPG @@ -380,7 +380,7 @@ See: _[Playtest](#playtest)_. The Sauce Labs account admin role that can manage permissions levels for all users, oversee Sauce Labs test settings and activity for their organization, create Teams and Team Admins, designate other Organization Admins, and set concurrency allocations among different Teams. More information: [Account and Organization Management](/basics/acct-team-mgmt-hub). -See also: _[team admin](#team-admin), [team management](#team-management)_. +See also: _[team admin](#team-admin)_. ## **P** @@ -388,7 +388,7 @@ See also: _[team admin](#team-admin), [team management](#team-management)_. 1. The practice of running multiple tests simultaneously. -2. When signing up for a self-service license, this is equivalent to your account's concurrency settings. More information: [System and Network Requirements for Sauce Connect Proxy](/secure-connections/sauce-connect/system-requirements), [Using Frameworks to Run Tests in Parallel](/web-apps/automated-testing/selenium/#using-frameworks-to-run-tests-in-parallel). +2. When signing up for a self-service license, this is equivalent to your account's concurrency settings. More information: [System and Network Requirements for Sauce Connect Proxy](/secure-connections/sauce-connect/system-requirements), [Using Frameworks to Run Tests in Parallel](/web-apps/automated-testing/selenium/#scaling-tests). See also: _[concurrency limit](#concurrency-limit)_. @@ -396,10 +396,6 @@ See also: _[team admin](#team-admin), [team management](#team-management)_. See: _[parallel testing](#parallel-testing)_. -### Performance Metrics - -The data that developers and QA teams use to capture and address performance regressions early in the development cycle. More information: [Sauce Connect Proxy Performance Metrics](/secure-connections/sauce-connect/proxy-tunnels#performance-metrics). - ### Performance Testing A type of non-functional software testing that ensures your software responds as expected on the front end and meets your requirements under expected workload. Sauce Labs supports front-end performance testing; see front-end performance testing for more information. @@ -412,7 +408,13 @@ A persistent online world that supports hundreds or thousands of players simulta ### pidfile -A text file generated by Sauce Connect Proxy that records your tunnel's process identification number (PID). Unless otherwise specified, the file will be cleaned up on exit or overwritten at startup. If needed, you can terminate a tunnel any time by sending a kill signal to the PID recorded in pidfile. More information: [How to Start and Stop Sauce Connect Tunnels (Startup and Teardown)](/secure-connections/sauce-connect/proxy-tunnels#starting-and-stopping-tunnels), [Sauce Connect Proxy Command-Line Quick Reference Guide](/dev/cli/sauce-connect-proxy). +A text file generated by Sauce Connect Proxy that records your tunnel's process +identification number (PID). Unless otherwise specified, the file will be +cleaned up on exit or overwritten at startup. If needed, you can terminate a +tunnel any time by sending a kill signal to the PID recorded in pidfile. +More information: +[How to Start and Stop Sauce Connect Tunnels (Startup and Teardown)](/secure-connections/sauce-connect-5/quickstart), +[Sauce Connect Proxy Command-Line Quick Reference Guide](/dev/cli/sauce-connect-5). ### Piestry @@ -424,7 +426,7 @@ See [API Mocking](#api-mocking) to learn more about the concept. A Sauce Labs tool where you can select your capabilities and generate code snippets to copy and paste into your automated testing scripts. More information: [Platform Configurator](https://saucelabs.com/platform/platform-configurator#/). -See also: _[capabilities](#capabilities)_. +See also: _[capabilities](#capabilities-caps)_. ### Platform-dependent @@ -475,7 +477,7 @@ See also: _[rdc on sauce](#rdc-on-sauce)._ An automated web or mobile app test performed on real, physical devices hosted on the Sauce Labs Real Device Cloud. Real device tests yield accurate results on user interactions and display how your app will appear in real life. More information: [Real Device Testing Admin Guide](/mobile-apps/supported-devices), [Sauce Connect Proxy Setup for Real Device Cloud](/secure-connections/sauce-connect/setup-configuration/specialized-environments#real-device-cloud-setup), [Sauce Labs website: Real Device Cloud](https://saucelabs.com/platform/real-device-cloud). -See also: _[real device cloud](#real-device-cloud)_. +See also: _[real device cloud](#real-device-cloud-rdc)_. ### Real-time Strategy (RTS) @@ -590,13 +592,13 @@ See also: _[unmanaged customer](#unmanaged-customer)_. A virtual machine environment used to mimic the overall behavior (i.e., software variables, configurations) of the iOS mobile app you're testing in Sauce Labs. -See also: _[Emulator](#emulator), [real device testing](#real-device-test)_. +See also: _[Emulator](#emulator), [real device testing](#real-device-testing)_. ### Site Under Test (SUT) A website in the test phase of the development cycle, following the planning, coding, and building phases. When testing in Sauce Connect Proxy, the Site Under Test will be on the same local network as the Sauce Connect Host machine. -See also: _[app under test](#app-under-test), [CI/CD pipeline](#cicd-pipeline)_. +See also: _[app under test](#app-under-test-aut), [CI/CD pipeline](#cicd-pipeline)_. ### Software Development Lifecycle (SDLC) @@ -645,13 +647,13 @@ See also: _[organization admin](#organization-admin), [team admin](#team-admin), A Sauce Labs user with permission to edit their own user info, run tests, and view tests run by teammates. Depending on their Organization Admin's Team Job Sharing settings, they can also view jobs that were run by members of other teams. -See also: _[organization admin](#organization-admin), [team admin](#team-admin), [team management](#team-management)_. +See also: _[organization admin](#organization-admin), [team admin](#team-admin)_. ### Test Runner A library or tool for writing and/or executing code for automated tests; often part of a UI test framework. -See also: _[framework](#Framework), [UI automation library](#ui-automation-library)_. +See also: _[framework](#framework), [UI automation library](#ui-automation-library)_. ### Testing Annotation @@ -745,11 +747,11 @@ Also known as game developers, are responsible for designing and developing vide A Sauce Labs cloud service that provides an infrastructure to virtually test your desktop websites and mobile device apps on thousands of browser, operating system, and device combinations. More information: [Sauce Labs Pricing](https://saucelabs.com/pricing). -See also:_ [real device cloud](#real-device-cloud)_. +See also:_ [real device cloud](#real-device-cloud-rdc)_. ### Virtual Cloud -See: _[virtual device cloud](#virtual-device-cloud)_. +See: _[virtual device cloud](#virtual-device-cloud-vdc)_. ### Virtual USB (vUSB) @@ -782,7 +784,7 @@ Supports all major browsers and programming languages. Look here for [Examples of Test Libraries](/web-apps/automated-testing/selenium/#scaling-tests) that implement WebDriver. -See also: _[appium](#appium), [UI automation library](#ui-automation-library), [webdriverIO](#webdriverIO)_. +See also: _[appium](#appium), [UI automation library](#ui-automation-library), [webdriverIO](#webdriverio)_. ### WebdriverIO diff --git a/docs/dev/test-configuration-options.md b/docs/dev/test-configuration-options.md index 8dbdbdddd5..45638ed1c1 100644 --- a/docs/dev/test-configuration-options.md +++ b/docs/dev/test-configuration-options.md @@ -49,7 +49,10 @@ Use the latest version of the Selenium library in your code for the most up-to-d

| STRING |

-Identifies the user agent. See the [WebDriver W3C Specification](https://w3c.github.io/webdriver/#dfn-browser-name) for more information. This setting also applies to emulators, simulators and real devices when automating with a mobile browser. It must be set when [App Name](#app) is not set. +Identifies the user agent. See the [WebDriver W3C Specification](https://w3c.github.io/webdriver/#dfn-browser-name) for more +information. This setting also applies to emulators, simulators and real devices +when automating with a mobile browser. It must be set when [App Name](#appiumapp) +is not set. - For Android v5 and below, the value needs to be `"Browser"`, v6 and above, it is `"Chrome"`. - For iOS, the value needs to be `"Safari"`. @@ -1372,10 +1375,10 @@ Keeps the device allocated to you between test sessions and bypasses the device :::note **For Android:** -If [`noReset`](#noreset) is also set to `true`, the app under test and its data will remain as-is on the device. +If [`noReset`](#appiumnoreset) is also set to `true`, the app under test and its data will remain as-is on the device. **For iOS** -Changing [`noReset`](#noreset) has no impact here. The app will not be removed, will stay on the phone/tablet and will keep it's state. This is caused by the re-signing process of the app. +Changing [`noReset`](#appiumnoreset) has no impact here. The app will not be removed, will stay on the phone/tablet and will keep it's state. This is caused by the re-signing process of the app. ::: If you are running multiple test suites in parallel, the values for `cacheId` should be unique for each suite (to avoid mixing up the devices), and the value for `cacheId` must be the same for all test methods that you want to run on the cached device. The value itself can be any (random) string. In addition, the app and project ID used for the tests must remain the same, along with the values for these capabilities: diff --git a/docs/error-reporting/language-integrations/electron.md b/docs/error-reporting/language-integrations/electron.md index e4a963d7c8..dd58e10d0b 100644 --- a/docs/error-reporting/language-integrations/electron.md +++ b/docs/error-reporting/language-integrations/electron.md @@ -476,8 +476,8 @@ The following options are available for the BacktraceClientOptions passed when i ### Manually send an error -There are several ways to send an error to Backtrace. For more details on the definition of `client.send()` see -[Methods](#methods) below. +There are several ways to send an error to Backtrace. For more details on the +definition of `client.send()` see methods below. ```ts // send as a string diff --git a/docs/error-reporting/language-integrations/nestjs.md b/docs/error-reporting/language-integrations/nestjs.md index e421fe7931..eae23699f0 100644 --- a/docs/error-reporting/language-integrations/nestjs.md +++ b/docs/error-reporting/language-integrations/nestjs.md @@ -459,8 +459,8 @@ The following options are available for the BacktraceClientOptions passed when i ### Manually send an error -There are several ways to send an error to Backtrace. For more details on the definition of `client.send()` see -[Methods](#methods) below. +There are several ways to send an error to Backtrace. For more details on the +definition of `client.send()` see methods below. ```ts // send as a string diff --git a/docs/error-reporting/language-integrations/node.md b/docs/error-reporting/language-integrations/node.md index 77d8182b73..12bd14ee68 100644 --- a/docs/error-reporting/language-integrations/node.md +++ b/docs/error-reporting/language-integrations/node.md @@ -414,8 +414,8 @@ The following options are available for the BacktraceClientOptions passed when i ### Manually send an error -There are several ways to send an error to Backtrace. For more details on the definition of `client.send()` see -[Methods](#methods) below. +There are several ways to send an error to Backtrace. For more details on the +definition of `client.send()` see methods below. ```ts // send as a string diff --git a/docs/error-reporting/language-integrations/react-native.md b/docs/error-reporting/language-integrations/react-native.md index 05cd22a709..5b3653995c 100644 --- a/docs/error-reporting/language-integrations/react-native.md +++ b/docs/error-reporting/language-integrations/react-native.md @@ -402,8 +402,8 @@ The following options are available for the BacktraceClientOptions passed when i ### Manually send an error -There are several ways to send an error to Backtrace. For more details on the definition of `client.send()` see -[Methods](#methods) below. +There are several ways to send an error to Backtrace. For more details on the +definition of `client.send()` see methods below. ```ts // send as a string diff --git a/docs/error-reporting/language-integrations/react.md b/docs/error-reporting/language-integrations/react.md index b5633dc3f5..d5d0ad53f4 100644 --- a/docs/error-reporting/language-integrations/react.md +++ b/docs/error-reporting/language-integrations/react.md @@ -358,8 +358,8 @@ The following options are available for the BacktraceClientOptions passed when i ### Manually send an error -There are several ways to send an error to Backtrace. For more details on the definition of `client.send()` see -[Methods](#methods) below. +There are several ways to send an error to Backtrace. For more details on the +definition of `client.send()` see methods below. ```ts // send as a string diff --git a/docs/error-reporting/platform-integrations/ios/setup.md b/docs/error-reporting/platform-integrations/ios/setup.md index 167f1ed160..01ab203419 100644 --- a/docs/error-reporting/platform-integrations/ios/setup.md +++ b/docs/error-reporting/platform-integrations/ios/setup.md @@ -103,7 +103,7 @@ BacktraceCredentials *backtraceCredentials = [[BacktraceCredentials alloc] initW After compiling your application with the new backtrace-cocoa library, make sure symbol files are generated in dSYM format and are uploaded to Backtrace to symbolicate incoming crashes. -For information on how to upload debug symbols, see [Symbol Formats and Upload Methods](/error-reporting/project-setup/symbolication/#symbol-formats-and-upload-methods). +For information on how to upload debug symbols, see [Symbol Formats and Upload Methods](/error-reporting/project-setup/symbolication). ### Set Debug Symbol Format diff --git a/docs/error-reporting/troubleshooting.md b/docs/error-reporting/troubleshooting.md index 078c5d3711..ce8955bfa1 100644 --- a/docs/error-reporting/troubleshooting.md +++ b/docs/error-reporting/troubleshooting.md @@ -40,7 +40,7 @@ The following example focuses on an unsymbolicated Electron crash: 1. To upload the symbol, it is best practice to add it to an active zip or tar archive. You can then use curl or the webUI to upload the archive containing the symbol(s). The following support documents provide guidance for both processes: - - [HTTP API](/error-reporting/project-setup/symbolication/#http-api) + - [HTTP API](/error-reporting/project-setup/symbolication/#api) - [Missing Symbols](#missing-symbols) 1. All crash data present in a project before uploading the symbols must be reprocessed to account for the newly added symbols. Subsequent reports are processed with the newly added symbols. For more information, see [Object Reprocessing](/error-reporting/project-setup/object-reprocessing/). diff --git a/docs/mobile-apps/app-storage.md b/docs/mobile-apps/app-storage.md index 300f4b8e30..0091af2c71 100644 --- a/docs/mobile-apps/app-storage.md +++ b/docs/mobile-apps/app-storage.md @@ -360,7 +360,10 @@ Dependent apps inherit the configuration of the main app under test for [`Device ### Appium Capability -For [Appium](/dev/test-configuration-options#mobile-app-capabilities-sauce-specific--optional) tests, you can specify up to seven apps that have already been uploaded to App Storage using one of the previously described methods by setting the `otherApps` desired capability and referencing the app's storage ID or filename. +For [Appium](/dev/test-configuration-options/#appiumotherapps) +tests, you can specify up to seven apps that have already been uploaded to App +Storage using one of the previously described methods by setting the `otherApps` +desired capability and referencing the app's storage ID or filename. ``` caps.setCapability("otherApps", "storage:filename=") diff --git a/docs/mobile-apps/automated-testing.md b/docs/mobile-apps/automated-testing.md index 6220673f58..d82850d0f8 100644 --- a/docs/mobile-apps/automated-testing.md +++ b/docs/mobile-apps/automated-testing.md @@ -57,5 +57,12 @@ Within the high level process described above, there are many nuances that can a By default, automated tests that are running on real devices in the Sauce Labs data centers can run for up to **60 minutes**. However, that duration can be affected by other factors: -- If the test is idle (not actively interacting with the device) for more than 60 seconds, the test will timeout and end the session, so consider writing tests that do not include waits that may trigger this timeout. For Appium tests, you have the option to increase the idle timeout value to a maximum of 90 seconds using the [`newCommandTimeout`](/dev/test-configuration-options/#newCommandTimeout) capability. -- If you are running multiple Appium tests concurrently on the same device, consider setting the [cache ID](/dev/test-configuration-options/#cacheId) to bypass the default device cleaning process and session exit between tests. +- If the test is idle (not actively interacting with the device) for more than +60 seconds, the test will timeout and end the session, so consider writing tests +that do not include waits that may trigger this timeout. For Appium tests, you +have the option to increase the idle timeout value to a maximum of 90 seconds +using the [`newCommandTimeout`](/dev/test-configuration-options/#appiumnewcommandtimeout) +capability. +- If you are running multiple Appium tests concurrently on the same device, +consider setting the [cache ID](/dev/test-configuration-options/#cacheid) to +bypass the default device cleaning process and session exit between tests. diff --git a/docs/mobile-apps/automated-testing/appium/appium-flutter-integration-driver.md b/docs/mobile-apps/automated-testing/appium/appium-flutter-integration-driver.md index 0bb2463353..864446e702 100644 --- a/docs/mobile-apps/automated-testing/appium/appium-flutter-integration-driver.md +++ b/docs/mobile-apps/automated-testing/appium/appium-flutter-integration-driver.md @@ -137,7 +137,8 @@ More information on how to write Appium tests for Flutter apps can be found in t :::info APPIUM FLUTTER INTEGRATION DRIVER SUPPORT : [appium-flutter-integration-driver](https://github.com/AppiumTestDistribution/appium-flutter-integration-driver). This driver will now be included by default with Appium version latest and all subsequent versions released after July 1st. -More information regarding the available [appium versions](/mobile-apps/automated-testing/appium/appium-versions/#Real-Devices) we support at Sauce Sabs. +More information regarding the available [appium versions](/mobile-apps/automated-testing/appium/appium-versions/#real-devices) +we support at Sauce Labs. ::: ### Real Devices diff --git a/docs/mobile-apps/automated-testing/appium/real-devices.md b/docs/mobile-apps/automated-testing/appium/real-devices.md index 0f3ccdc594..3d86d00c1e 100644 --- a/docs/mobile-apps/automated-testing/appium/real-devices.md +++ b/docs/mobile-apps/automated-testing/appium/real-devices.md @@ -42,7 +42,7 @@ If your Appium tests are intended to test a native mobile app on real devices, t The following app file types are supported for real device tests: - \*.apk or \*.aab for Android app files -- \*.ipa for iOS app files (See [Create .ipa Files for Appium](/mobile-apps/automated-testing/ipa-files/#real-devices)) +- \*.ipa for iOS app files (See [Create .ipa Files for Appium](/mobile-apps/automated-testing/ipa-files/#creating-ipa-files-for-appium-testing)) See [Appium Versions](./appium-versions.md) for information about Appium versions supported for real device testing. diff --git a/docs/mobile-apps/automated-testing/appium/virtual-devices.md b/docs/mobile-apps/automated-testing/appium/virtual-devices.md index 09ca728957..a3bb35d8b4 100644 --- a/docs/mobile-apps/automated-testing/appium/virtual-devices.md +++ b/docs/mobile-apps/automated-testing/appium/virtual-devices.md @@ -28,7 +28,7 @@ Sauce Labs does not support Android Emulators with Play Store integration. For m To begin, upload your app to a publicly available source. Accepted file types are \*.zip iOS package files for Simulators and \*.apk or \*.aab Android package files for Emulators. There are two ways you can upload your app for automated testing: - Upload a local file using the [App Storage REST API](/dev/api/storage/#upload-file-to-app-storage) -- Provide a URL to install from a [Remote Location](/mobile-apps/automated-testing/appium/real-devices/#uploading-mobile-apps-from-a-remote-location) +- Provide a URL to install from a [Remote Location](/mobile-apps/automated-testing/appium/virtual-devices/#set-the-location-of-your-mobile-app) ## Set Your Test Credentials @@ -349,7 +349,7 @@ where you'll find demo scripts for a variety of use cases to get you started wit ## Additional Test Configuration Options -- [Implement timeouts to control text execution times](/dev/test-configuration-options/#virtual-device-capabilities-sauce-specific--optional) +- [Implement timeouts to control text execution times](/dev/test-configuration-options/#mobile-appium-timeout-capabilities) - [Annotating Tests with the Sauce Labs REST API](/basics/test-config-annotation/test-annotation/#sauce-labs-rest-api) - [Annotating Tests with Selenium's JavaScript Executor](/basics/test-config-annotation/test-annotation/#selenium-javascript-executor) - [Setting Test Status to Pass or Fail](/test-results/test-status) diff --git a/docs/mobile-apps/automated-testing/espresso-xcuitest/espresso.md b/docs/mobile-apps/automated-testing/espresso-xcuitest/espresso.md index 23677fcc5c..45da6ee3f9 100644 --- a/docs/mobile-apps/automated-testing/espresso-xcuitest/espresso.md +++ b/docs/mobile-apps/automated-testing/espresso-xcuitest/espresso.md @@ -177,7 +177,8 @@ saucectl run --ccy 5

| OPTIONAL | INTEGER |

-Sets the number of times to retry a failed suite. For more settings, you can refer to [passThreshold](#passThreshold). +Sets the number of times to retry a failed suite. For more settings, you can +refer to [passThreshold](#passthreshold). ```yaml retries: 1 diff --git a/docs/mobile-apps/automated-testing/espresso-xcuitest/xcuitest.md b/docs/mobile-apps/automated-testing/espresso-xcuitest/xcuitest.md index 4959ae3ae2..4f2332943f 100644 --- a/docs/mobile-apps/automated-testing/espresso-xcuitest/xcuitest.md +++ b/docs/mobile-apps/automated-testing/espresso-xcuitest/xcuitest.md @@ -185,7 +185,8 @@ saucectl run --ccy 5

| OPTIONAL | INTEGER |

-Sets the number of times to retry a failed suite. For more settings, you can refer to [passThreshold](#passThreshold). +Sets the number of times to retry a failed suite. For more settings, you can +refer to [passThreshold](#passthreshold). ```yaml sauce: diff --git a/docs/orchestrate/saucectl-configuration.md b/docs/orchestrate/saucectl-configuration.md index 9afe558ce4..ba7f410658 100644 --- a/docs/orchestrate/saucectl-configuration.md +++ b/docs/orchestrate/saucectl-configuration.md @@ -144,7 +144,8 @@ sauce:

| REQUIRED | OBJECT |

-The set of properties providing details about the test suites to run. May contain multiple suite definitions. See the full [example config](#example-configuration) for an illustration of multiple suite definitions. +The set of properties providing details about the test suites to run. May +contain multiple suite definitions. --- @@ -581,4 +582,4 @@ Supported commands: Stop a running Sauce Orchestrate container. - \ No newline at end of file + diff --git a/docs/performance/motion.md b/docs/performance/motion.md index 4ea36c4dd0..6c6133e115 100644 --- a/docs/performance/motion.md +++ b/docs/performance/motion.md @@ -18,7 +18,9 @@ In addition to testing the efficiency of your app rendering, Sauce Labs also pro ### What You'll Need - Google Chrome (no older than 3 versions from latest) -- Test configuration must have performance enabled. See [Set Performance Capabilities](/performance/transitions#set-performance-capabilities) for instructions. +- Test configuration must have performance enabled. + See [Set Performance Capabilities](/performance/transitions/#setting-performance-capabilities) + for instructions. ## What is Jankiness? diff --git a/docs/performance/transitions.md b/docs/performance/transitions.md index 10ea7a10fa..ad1826ba52 100644 --- a/docs/performance/transitions.md +++ b/docs/performance/transitions.md @@ -100,7 +100,13 @@ options = {browser_name: browser_name, ## Implementing the Performance Command Assertion -The custom `sauce:performance` command measures the performance output against a baseline of previously accepted performance values. If no baseline has been set, the Performance test will create one by measuring performance output 10 times to get an aggregate baseline. The command returns `pass` when the current results are within the baseline allowances or `fail` when the results fall outside the baseline. A fail result gives you the option to handle [regressions](#handle-regressions). +The custom `sauce:performance` command measures the performance output against +a baseline of previously accepted performance values. If no baseline has been +set, the Performance test will create one by measuring performance output 10 +times to get an aggregate baseline. The command returns `pass` when the current +results are within the baseline allowances or `fail` when the results fall +outside the baseline. A fail result gives you the option to handle +[regressions](#handling-regressions). :::caution Enabling performance capturing can add up to 60 seconds per URL change in a test. We, therefore, advise separating your performance tests from your functional tests. See our [Performance Requirements and Recommendations](https://docs.saucelabs.com/performance/about/#sauce-performance-requirements-and-recommendations) for more advice on optimizing your performance test results. @@ -268,7 +274,14 @@ performanceLogs[metric] < value`metric ${metric} is over the performance budget` ## Handling Regressions -When one or more metric evaluations fail because the result falls outside the established baseline, it is considered a regression and the tester has an option to either troubleshoot and resolve the source of the regression to get the test back into the baseline range or [update the baseline](/performance/analyze#reset-baselines-for-a-failed-test) with the new performance values. If new baselines are accepted, the command will measure performance against those new values until another regression is detected, when you will again have the option to troubleshoot or update the baselines. +When one or more metric evaluations fail because the result falls outside the +established baseline, it is considered a regression and the tester has an option +to either troubleshoot and resolve the source of the regression to get the test +back into the baseline range or [update the baseline](/performance/analyze/#resetting-baselines-for-a-failed-test) +with the new performance values. If new baselines are accepted, the command will +measure performance against those new values until another regression is +detected, when you will again have the option to troubleshoot or update the +baselines. Since the command can be called throughout the test script, create tests that check for performance regressions across core business flows and screens. For example, evaluate pages that load following a successful login event or require multiple steps to trigger. diff --git a/docs/secure-connections/ipsec-vpn.md b/docs/secure-connections/ipsec-vpn.md index 39693d8a5d..adfb878ee0 100644 --- a/docs/secure-connections/ipsec-vpn.md +++ b/docs/secure-connections/ipsec-vpn.md @@ -123,7 +123,7 @@ Depending on the type of framework you're using and the device you're testing on In your test script, you'll need to: 1. Specify the [data center endpoint](/basics/data-center-endpoints) location of the device you're testing on. See the [Sauce Labs Training Repo](https://github.com/saucelabs-training) for examples in JavaScript, Java, Python, Ruby, and C#. -2. Use the [`tunnelName`](/dev/test-configuration-options#tunnelName) capability to specify the name of your organization's Sauce IPSec Proxy tunnel, and then set the [`tunnelOwner`](/dev/test-configuration-options#tunnelOwner) capability to the Sauce Labs username of your organization admin. +2. Use the [`tunnelName`](/dev/test-configuration-options#tunnelname) capability to specify the name of your organization's Sauce IPSec Proxy tunnel, and then set the [`tunnelOwner`](/dev/test-configuration-options#tunnelowner) capability to the Sauce Labs username of your organization admin. ```java title="Java example" MutableCapabilities caps = new MutableCapabilities(); diff --git a/docs/secure-connections/sauce-connect-5.md b/docs/secure-connections/sauce-connect-5.md index cdd07f2b23..d27aa4dbc5 100644 --- a/docs/secure-connections/sauce-connect-5.md +++ b/docs/secure-connections/sauce-connect-5.md @@ -34,15 +34,23 @@ An [`sc legacy`](/dev/cli/sauce-connect-5/legacy/) command is introduced to help Sauce Connect Proxy 5 major changes are listed below. -- Tunnels must be named, the [`--tunnel-name`](/dev/cli/sauce-connect-5/run/#--tunnel-name) flag is no longer optional. It's done to improve security and usability - tests that use Sauce Connect must explicitly specify the [tunnel name](/dev/test-configuration-options/#tunnelname). -- There is no default Sauce Labs region value, [`--region`](/dev/cli/sauce-connect-5/run/#--region) is required to ensure that the correct region is explicitly specified. +- Tunnels must be named, the [`--tunnel-name`](/dev/cli/sauce-connect-5/run/#tunnel-name) +flag is no longer optional. It's done to improve security and usability—tests +that use Sauce Connect must explicitly specify the [tunnel name](/dev/test-configuration-options#tunnelname). +- There is no default Sauce Labs region value, [`--region`](/dev/cli/sauce-connect-5/run/#region) is required to ensure that the correct region is explicitly specified. - [SSL Certificate Bumping](/secure-connections/sauce-connect/security-authentication#ssl-certificate-bumping) is not enabled for all domains, by default. - [SSL Certificate Bumping](/secure-connections/sauce-connect/security-authentication#ssl-certificate-bumping) is fully supported and additional flags are added to fine-tune the configuration. -- Proxy auto-detection is not supported, all proxies must be specified with explicit flags - [`--proxy`](/dev/cli/sauce-connect-5/run/#--proxy) or [`--pac`](/dev/cli/sauce-connect-5/run/#--pac) for SUT requests and [`--proxy-sauce`](/dev/cli/sauce-connect-5/run/#--proxy-sauce) for Sauce Labs REST API and tunnel connections. -- Domain flags ([`--tunnel-domains`](/dev/cli/sauce-connect-5/run/#--tunnel-domains), [`--direct-domains`](/dev/cli/sauce-connect-5/run/#--direct-domains), etc) accept regular expressions only. -- [Subcommands](/dev/cli/sauce-connect-5/) are introduced to support multiple CLI changes and future capabilities. +- Proxy auto-detection is not supported, all proxies must be specified with +explicit flags — [`--proxy`](/dev/cli/sauce-connect-5/run/#proxy) or [`--pac`](/dev/cli/sauce-connect-5/run/#pac) +for SUT requests and [`--proxy-sauce`](/dev/cli/sauce-connect-5/run/#proxy-sauce) +for Sauce Labs REST API and tunnel connections. +- Domain flags ([`--tunnel-domains`](/dev/cli/sauce-connect-5/run/#tunnel-domains), [`--direct-domains`](/dev/cli/sauce-connect-5/run/#direct-domains), etc.) +accept regular expressions only. +- [Subcommands](/dev/cli/sauce-connect-5/) are introduced to support multiple CLI changes and future +capabilities. - The [Selenium Relay](/secure-connections/sauce-connect/proxy-tunnels/#using-the-selenium-relay) feature is not supported. -- Log administration capabilities (such as log-rotate) are not supported. Log management is better left to specialized tools. +- Log administration capabilities (such as log-rotate) are not supported. Log +management is better left to specialized tools. ## Getting Started With Sauce Connect Proxy 5 diff --git a/docs/secure-connections/sauce-connect-5/advanced/architecture.md b/docs/secure-connections/sauce-connect-5/advanced/architecture.md index 95f199992c..b829f23230 100644 --- a/docs/secure-connections/sauce-connect-5/advanced/architecture.md +++ b/docs/secure-connections/sauce-connect-5/advanced/architecture.md @@ -29,7 +29,9 @@ Here is an overview of how these components interact with the user environment: ### Sauce Connect Proxy Client components -The [client (also known as SC)](/secure-connections/sauce-connect-5/installation/#download-latest-version) is distributed as a single binary that contains several distinct components. These include: +The [client (also known as SC)](/secure-connections/sauce-connect-5/installation) +is distributed as a single binary that contains several distinct components. +These include: - SC Client controller: the “brain” of the SC client. It issues requests to the Sauce Labs REST API, starts all the other included components and ensures that everything is working as expected. - API Server: this is an HTTP server providing an API to query the SC Client controller and exposing the client-side metrics diff --git a/docs/secure-connections/sauce-connect-5/migrating.md b/docs/secure-connections/sauce-connect-5/migrating.md index 7676838ac8..33ce8e9472 100644 --- a/docs/secure-connections/sauce-connect-5/migrating.md +++ b/docs/secure-connections/sauce-connect-5/migrating.md @@ -181,13 +181,17 @@ SC5 leaves log management to third party tools such as journald. It can log to s Sauce Connect 5 no longer uses the `HTTP(S)_PROXY` and `NO_PROXY` environment variables. -To send REST API (ie, starting or stopping a tunnel) traffic through the proxy, use the [--proxy-sauce](/dev/cli/sauce-connect-proxy#--proxy-sauce) option. +To send REST API (ie, starting or stopping a tunnel) traffic through the proxy, +use the [--proxy-sauce](/dev/cli/sauce-connect-5/run/#proxy-sauce) option. -To send tunnel (site under test) traffic through a proxy, use the [--proxy](/dev/cli/sauce-connect-proxy#--proxy) option. +To send tunnel (site under test) traffic through a proxy, use the [--proxy](/dev/cli/sauce-connect-5/run/#proxy) +option. Most proxy combinations can be controlled with these two options. -However, if you were using the `NO_PROXY` option to exclude various sites under test from using a parent proxy, you will likely need to use a [PAC file](/dev/cli/sauce-connect-proxy#--pac) instead. -The endpoints listed in the `NO_PROXY` option would use a 'DIRECT' mode in the PAC, and the default would be the proxy. +However, if you were using the `NO_PROXY` option to exclude various sites under +test from using a parent proxy, you will likely need to use a [PAC file](/dev/cli/sauce-connect-5/run/#pac) +instead. The endpoints listed in the `NO_PROXY` option would use a 'DIRECT' mode +in the PAC, and the default would be the proxy. For example, if you wanted [https://example.com](https://example.com) to skip the proxy, and everything else to go through the proxy, you would use the following PAC file: diff --git a/docs/secure-connections/sauce-connect-5/monitoring.md b/docs/secure-connections/sauce-connect-5/monitoring.md index 8114446f0d..61dc2a54c4 100644 --- a/docs/secure-connections/sauce-connect-5/monitoring.md +++ b/docs/secure-connections/sauce-connect-5/monitoring.md @@ -13,15 +13,15 @@ Sauce Connect Proxy provides server-side monitoring via the REST API and the Sau You can manage and monitor all Sauce Connect Proxy tunnel activity from the Sauce Labs [**Tunnels**](https://app.saucelabs.com/tunnels) page, which displays useful information, such as the number of active tunnels, tunnel status, and specific attributes for each tunnel. You can also check the health of an individual tunnel by running a test on it. -| Column | Description | -| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | -| Type | The icon shows whether the tunnel is a Sauce Connect Proxy, or an IPSec Proxy. | -| State | The icon shows whether the tunnel is running or stopped. | -| Tunnel Name | The name of the tunnel. This is the [`--tunnel-name`](/dev/cli/sauce-connect-5/run/#--tunnel-name) used when starting the Sauce Connect tunnel. | -| Client Hostname | The name of the machine where the Sauce Connect Proxy client is running. | -| Owner | The name of the account that is running the tunnel. | -| Sharing | Indicates whether or not the tunnel is shared. | -| Duration | The amount of time the tunnel has been running. | +| Column | Description | +| :-------------- |:----------------------------------------------------------------------------------------------------------------------------------------------| +| Type | The icon shows whether the tunnel is a Sauce Connect Proxy, or an IPSec Proxy. | +| State | The icon shows whether the tunnel is running or stopped. | +| Tunnel Name | The name of the tunnel. This is the [`--tunnel-name`](/dev/cli/sauce-connect-5/run/#tunnel-name) used when starting the Sauce Connect tunnel. | +| Client Hostname | The name of the machine where the Sauce Connect Proxy client is running. | +| Owner | The name of the account that is running the tunnel. | +| Sharing | Indicates whether or not the tunnel is shared. | +| Duration | The amount of time the tunnel has been running. | ## Grafana Dashboard diff --git a/docs/secure-connections/sauce-connect-5/operation/api-server.md b/docs/secure-connections/sauce-connect-5/operation/api-server.md index 66c6f13d0e..ef5d46cbe7 100644 --- a/docs/secure-connections/sauce-connect-5/operation/api-server.md +++ b/docs/secure-connections/sauce-connect-5/operation/api-server.md @@ -9,7 +9,8 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; Sauce Connect Proxy, optionally, exposes an API server that allows to obtain information about the local Sauce Connect Proxy instance. -The API interface is configured with the [`--api-address`](/dev/cli/sauce-connect-5/run/#--api-address) flag. +The API interface is configured with the [`--api-address`](/dev/cli/sauce-connect-5/run/#api-address) +flag. ```bash --api-address :8080 # listens on all the interfaces' port 8080 @@ -35,15 +36,15 @@ docker run \ The table below summarizes available endpoints. -| Path | Description | -| :--------- | :----------------------------------------------------------------------------------------------------- | -| `/readyz` | Returns 200 response code when Sauce Connect Proxy is ready, 503 otherwise. | -| `/healthz` | Returns 200 response code when Sauce Connect Proxy is connected, 503 otherwise. | -| `/info` | Returns runtime information about the tunnel instance. | -| `/metrics` | Exposes [Prometheus](https://prometheus.io/) metrics. | -| `/configz` | Returns the configuration values. | -| `/pac` | Returns the PAC content being configured with the [`--pac`](/dev/cli/sauce-connect-5/run/#--pac) flag. | -| `/version` | Returns the Sauce Connect Proxy instance version and build info. | +| Path | Description | +| :--------- |:-----------------------------------------------------------------------------------------------------| +| `/readyz` | Returns 200 response code when Sauce Connect Proxy is ready, 503 otherwise. | +| `/healthz` | Returns 200 response code when Sauce Connect Proxy is connected, 503 otherwise. | +| `/info` | Returns runtime information about the tunnel instance. | +| `/metrics` | Exposes [Prometheus](https://prometheus.io/) metrics. | +| `/configz` | Returns the configuration values. | +| `/pac` | Returns the PAC content being configured with the [`--pac`](/dev/cli/sauce-connect-5/run/#pac) flag. | +| `/version` | Returns the Sauce Connect Proxy instance version and build info. | ### Info diff --git a/docs/secure-connections/sauce-connect-5/operation/configuration.md b/docs/secure-connections/sauce-connect-5/operation/configuration.md index 9d73c9bd75..92150f0577 100644 --- a/docs/secure-connections/sauce-connect-5/operation/configuration.md +++ b/docs/secure-connections/sauce-connect-5/operation/configuration.md @@ -18,8 +18,8 @@ If you pass the same argument through multiple methods, the order of precedence ## Config File -The Sauce Connect Proxy [config file](/dev/cli/sauce-connect-5/run/#--config-file) may contain any CLI flag. -It may also contain comments that could help make its content more readable, for example: +The Sauce Connect Proxy config file may contain any CLI flag. It may also +contain comments that could help make its content more readable, for example: ```yaml --- @@ -34,7 +34,8 @@ tunnel-name: 'my-macos' ### Config File Reference -[`sc run config-file`](/dev/cli/sauce-connect-5/run/#configuration-file) command's output below contains all the available options and their usage. +`sc run config-file` command's output below contains all the available options +and their usage.
@@ -282,7 +283,7 @@ To launch a tunnel using a **config.yml** file option. 1. Create Sauce Connect Proxy config file in any location, for example: `$HOME/sc/config.yml` (`%HOMEPATH%\sc\config.yml` for Windows). 2. Enter values for the properties you'd like to use. -3. Use the [--config-file](/dev/cli/sauce-connect-5/run/#--config-file) flag to run Sauce Connect Proxy with your configuration file. +3. Use the `--config-file` flag to run Sauce Connect Proxy with your configuration file. -5. When you see `connected`, [verify that your tunnel is active](/secure-connections/sauce-connect/quickstart/#verifying-a-tunnel). +5. When you see `connected`, [verify that your tunnel is active](/secure-connections/sauce-connect/quickstart/#verify-connection). Once you've confirmed that your network is configured for Sauce Connect Proxy, you can start new tunnels as needed. As a best practice, we recommend creating a new tunnel for each test suite or build and tearing it down at the end of your test. @@ -173,7 +173,7 @@ When launching a Sauce Connect Proxy tunnel for automated web and mobile app tes - Launch a Sauce Connect tunnel as-is, without naming it. That default, unnamed tunnel will automatically be used for all automated tests. This can be useful for small organizations with a limited number of tests. - **Recommended**: Assign a name to help distinguish tunnels in a way that is meaningful to your organization. To accomplish this: - Use the [ `--tunnel-name` flag](/dev/cli/sauce-connect-proxy/#--tunnel-name) when you launch a tunnel. - - Specify the named tunnel in your automated tests by adding the [`tunnelName`](/dev/test-configuration-options#tunnelName) capability. + - Specify the named tunnel in your automated tests by adding the [`tunnelName`](/dev/test-configuration-options#tunnelname) capability. #### Example Configurations @@ -207,7 +207,7 @@ values={[ - Ensure that your network configuration allows for communication between the `SC Host`, the Tunnel VM, and the SUT (site under test). See the basic network configuration diagram for further explanation. - Select an example from [Sauce Labs Demonstration Scripts](https://github.com/saucelabs-training) and follow the instructions to configure the test in your dev environment. -- Navigate to the desired test script and add the [`tunnelName`](/dev/test-configuration-options#tunnelName) capability to your [`sauce:options`](/dev/w3c-webdriver-capabilities). +- Navigate to the desired test script and add the [`tunnelName`](/dev/test-configuration-options#tunnelname) capability to your [`sauce:options`](/dev/w3c-webdriver-capabilities). diff --git a/docs/testfairy/sdk/ios/dsyms.md b/docs/testfairy/sdk/ios/dsyms.md index e827dcbf71..439bbec707 100644 --- a/docs/testfairy/sdk/ios/dsyms.md +++ b/docs/testfairy/sdk/ios/dsyms.md @@ -31,7 +31,8 @@ You can upload multiple dSYMs per build. Some developers have frameworks develop ## Fatal: Can't find .dSYM folder! -If while compiling you get the error `Fatal: Can't find .dSYM folder!`, your project is not configured to [generate debug symbols](#generate-symbols). +If while compiling you get the error `Fatal: Can't find .dSYM folder!`, your +project is not configured to [generate debug symbols](#generating-symbols-in-xcode). ## Handling missing DSYMs @@ -48,7 +49,7 @@ If your build is missing dSYMs, you can find them and upload them manually to Te 5. Open a command line terminal and run the following command to locate the DSYMs folder name for one of the listed required UUIDs (replace `` with the actual UUID string): `mdfind "com_apple_xcode_dsym_uuids == " | grep dSYM` 6. Create a zip file with the content of the DSYM directory (you can call the zip file any name you like) `zip -r /tmp/symbols.zip /*` -7. Proceed to upload the zip as described [here](#upload-symbols). +7. Proceed to upload the zip as described [here](#uploading-multiple-dsyms). If you can't locate your dSYMS using `mfind`, follow these instructions: @@ -56,7 +57,7 @@ If you can't locate your dSYMS using `mfind`, follow these instructions: 2. Control-Click the relevant build, and select "Show in Finder". 3. In Finder, Control-Click the archive and select "Show Package Contents". 4. The archive will contain a folder called dSYM. -5. Create a zip with the contents of the folder and proceed to upload the zip to TestFairy as explained [here](#upload-symbols). +5. Create a zip with the contents of the folder and proceed to upload the zip to TestFairy as explained [here](#uploading-multiple-dsyms). ## Locating dSYMs for Bitcode builds. @@ -65,4 +66,4 @@ If you enabled Bitcode for your build and released it to the store or submitted 1. In Xcode, open the organizer window. 2. Click on the relevant build. 3. From the right side menu, click "download dSYMs". -4. Manually upload the dSYMs to TestFairy, [as described here](#upload-symbols) \ No newline at end of file +4. Manually upload the dSYMs to TestFairy, [as described here](#uploading-multiple-dsyms) diff --git a/docs/visual-testing/integrations/csharp.md b/docs/visual-testing/integrations/csharp.md index a1bf721bc4..9e92813bfd 100644 --- a/docs/visual-testing/integrations/csharp.md +++ b/docs/visual-testing/integrations/csharp.md @@ -24,7 +24,6 @@ Sauce Visual plugin provides a library exposing a `VisualClient` class that prov - `VisualCheck`: Takes a screenshot and sends it to Sauce Visual for comparison. - `VisualResults`: Waits for all diff calculations to complete and returns a summary of results. - See [Test results summary](#test-results-summary) for more details about summary format and sample usage. ## Quickstart diff --git a/docs/visual-testing/integrations/cypress.md b/docs/visual-testing/integrations/cypress.md index 7b8b335ac4..a01850c719 100644 --- a/docs/visual-testing/integrations/cypress.md +++ b/docs/visual-testing/integrations/cypress.md @@ -22,7 +22,6 @@ Sauce Visual introduce a new Cypress command: - `cy.sauceVisualCheck()`: Takes a screenshot and send it to Sauce Visual for comparison. - `cy.sauceVisualResults()`: Waits for diff calculations to complete and returns a summary of results. - See [Test results summary](#test-results-summary) for more details about summary format and sample usage. :::note Important Running Cypress tests on Sauce Labs requires SauceCTL to be installed and configured. diff --git a/docs/visual-testing/integrations/java.md b/docs/visual-testing/integrations/java.md index 0773742388..b5b044b963 100644 --- a/docs/visual-testing/integrations/java.md +++ b/docs/visual-testing/integrations/java.md @@ -24,7 +24,6 @@ Sauce Visual plugin provides a library exposing a `VisualApi` object that provid - `visual.sauceVisualCheck()`: Takes a screenshot and send it to Sauce Visual for comparison. - `visual.sauceVisualResults()`: Waits for all diff calculations to complete and returns a summary of results. - See [Test results summary](#test-results-summary) for more details about summary format and sample usage. ## Quickstart diff --git a/docs/visual-testing/integrations/nightwatch.md b/docs/visual-testing/integrations/nightwatch.md index 9c1410dc80..4d13c926c2 100644 --- a/docs/visual-testing/integrations/nightwatch.md +++ b/docs/visual-testing/integrations/nightwatch.md @@ -24,7 +24,6 @@ Sauce Visual adds new commands to the Nightwatch's `browser` object: - `browser.sauceVisualCheck()`: Takes a screenshot and send it to Sauce Visual for comparison. - `browser.sauceVisualResults()`: Waits for diff calculations to complete and returns a summary of results. - See [Test results summary](#test-results-summary) for more details about summary format and sample usage. ## Quickstart diff --git a/docs/visual-testing/integrations/storybook.md b/docs/visual-testing/integrations/storybook.md index 1305cca4a0..d0c8133b46 100644 --- a/docs/visual-testing/integrations/storybook.md +++ b/docs/visual-testing/integrations/storybook.md @@ -15,7 +15,9 @@ An extension for [Storybook's test-runner](https://github.com/storybookjs/test-r This guide requires an existing Storybook setup.
You can alternatively take a look to our [example repository](#example). -All tests are run in a headless [browser](#different-browsers) on your local machine/in your pipeline, so you don't need to worry about setting up a browser driver. +All tests are run in a headless [browser](#different-browsers-and-devices) on +your local machine or CI pipeline, so you don't need to worry about setting up a +browser driver. ## Compatibility diff --git a/docs/visual-testing/integrations/webdriverio.md b/docs/visual-testing/integrations/webdriverio.md index 03088ce00c..261a713209 100644 --- a/docs/visual-testing/integrations/webdriverio.md +++ b/docs/visual-testing/integrations/webdriverio.md @@ -22,7 +22,6 @@ Sauce Visual adds new commands to the WebdriverIO's `browser` object: - `browser.sauceVisualCheck()`: Takes a screenshot and send it to Sauce Visual for comparison. - `browser.sauceVisualResults()`: Waits for diff calculations to complete and returns a summary of results. - See [Test results summary](#test-results-summary) for more details about summary format and sample usage. ## Quickstart diff --git a/docs/visual-testing/workflows/review.md b/docs/visual-testing/workflows/review.md index d15405152f..746d5f5349 100644 --- a/docs/visual-testing/workflows/review.md +++ b/docs/visual-testing/workflows/review.md @@ -171,8 +171,8 @@ Check our integration documentation to learn how to get started. [Cypress](../../integrations/cypress/#ignored-regions), [C#/.Net](../../integrations/csharp/#ignored-regions), [Java](../../integrations/java/#ignored-regions), [Nightwatch](../../integrations/nightwatch/#ignored-regions), -[WebdriverIO](../../integrations/webdriverio/#ignored-regions), [Python](../../integrations/python/#ignored-regions), -[Python (Robot Framework)](../../integrations/python-robot-framework/#ignored-regions) +[WebdriverIO](../../integrations/webdriverio/#ignored-regions), [Python](../../integrations/python/#ignore-regions), +[Python (Robot Framework)](../../integrations/python-robot-framework/#ignore-regions) ### UI ignored regions diff --git a/docs/visual-testing/workflows/test-execution.md b/docs/visual-testing/workflows/test-execution.md index 7d4892dee8..db6340c238 100644 --- a/docs/visual-testing/workflows/test-execution.md +++ b/docs/visual-testing/workflows/test-execution.md @@ -37,8 +37,6 @@ Sauce Visual provides integrations with different kind of frameworks: -Alternatively, [check out our examples](../../visual-testing.md#examples). - ## First Test Execution Upon executing your tests for the first time, a visual baseline is automatically created in our system. This baseline serves as the standard for all subsequent tests and matches based on the metadata as described in the [Baseline Matching](../../visual-testing.md#baseline-matching). diff --git a/docs/visual/component-testing/storybook-static.md b/docs/visual/component-testing/storybook-static.md index 7d51db2c42..e1b78ac9f6 100644 --- a/docs/visual/component-testing/storybook-static.md +++ b/docs/visual/component-testing/storybook-static.md @@ -11,7 +11,9 @@ To run Screener against a static Storybook build, instead of starting the Storyb ## What You'll Need -- If you haven't already, follow the steps under the [Quickstart](/visual/component-testing/setup/) to integrate Sauce Labs Visual Component Testing (Screener) with Storybook and [set your Sauce credentials as environment variables](/visual/component-testing/setup/#set-environment-variables). +- If you haven't already, follow the steps under the [Quickstart](/visual/component-testing/setup/) +to integrate Sauce Labs Visual Component Testing (Screener) with Storybook and +[set your Sauce credentials as environment variables](/visual/component-testing/setup/#link-your-sauce-labs-account). - An existing [Storybook project](https://storybook.js.org/basics/quick-start-guide/) with some [component stories](https://storybook.js.org/basics/writing-stories/). ## Run a Static Storybook Build diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index 787d955ad7..148abcde53 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -202,7 +202,8 @@ saucectl run --ccy 5

| OPTIONAL | INTEGER |

-Sets the number of times to retry a failed suite. For more settings, you can refer to [passThreshold](#passThreshold). +Sets the number of times to retry a failed suite. For more settings, you can +refer to [passThreshold](#passthreshold). ```yaml sauce: @@ -344,7 +345,11 @@ The order of precedence is as follows: --env flag > root-level environment varia

| REQUIRED | OBJECT |

-The directory of files that need to be bundled and uploaded for the tests to run. Ignores what is specified in `.sauceignore`. See [Tailoring Your Test File Bundle](#tailoring-your-test-file-bundle) for more details. The following examples show the different relative options for setting this value. +The directory of files that need to be bundled and uploaded for the tests to +run. Ignores what is specified in `.sauceignore`. +See [Tailoring Your Test File Bundle](/web-apps/automated-testing/cucumberjs-playwright/advanced/#tailoring-your-test-file-bundle) +for more details. The following examples show the different relative options for +setting this value. ```yaml rootDir: "./" # Use the current directory @@ -389,7 +394,9 @@ npm: This setting is supported up to Playwright 1.35.1. For newer versions, use `registries`. ::: -Specifies the location of the npm registry source. If the registry source is a private address and you are running tests on Sauce Cloud, you can provide access to the registry source using [Sauce Connect](/dev/cli/saucectl/#run-tests-on-sauce-labs-with-sauce-connect). +Specifies the location of the npm registry source. If the registry source is a +private address, and you are running tests on Sauce Cloud, you can provide +access to the registry source using [Sauce Connect](/dev/cli/saucectl/usage/use-cases/#sauce-connect). ```yaml npm: @@ -402,7 +409,9 @@ npm:

| OPTIONAL | ARRAY |

-Specifies the location of the npm registry, scope, and credentials. Only one scopeless registry is allowed. If the registry is inside a private network, you must establish a tunnel using [Sauce Connect](/dev/cli/saucectl/#run-tests-on-sauce-labs-with-sauce-connect). +Specifies the location of the npm registry, scope, and credentials. Only one +scopeless registry is allowed. If the registry is inside a private network, you +must establish a tunnel using [Sauce Connect](/dev/cli/saucectl/usage/use-cases/#sauce-connect). ```yaml npm: diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index 64271af07b..99c6941137 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -208,7 +208,8 @@ saucectl run --ccy 5

| OPTIONAL | INTEGER |

-Sets the number of times to retry a failed suite. For more settings, you can refer to [passThreshold](#passThreshold). +Sets the number of times to retry a failed suite. For more settings, you can +refer to [passThreshold](#passthreshold). ```yaml sauce: @@ -355,7 +356,11 @@ Since environment variables are provided to Cypress directly, avoid using `CYPRE

| REQUIRED | OBJECT |

-The directory of files that need to be bundled and uploaded for the tests to run. Ignores what is specified in `.sauceignore`. See [Tailoring Your Test File Bundle](#tailoring-your-test-file-bundle) for more details. The following examples show the different relative options for setting this value. +The directory of files that need to be bundled and uploaded for the tests to +run. Ignores what is specified in `.sauceignore`. +See [Tailoring Your Test File Bundle](/web-apps/automated-testing/cypress/advanced/#tailoring-your-test-file-bundle) +for more details. The following examples show the different relative options for +setting this value. ```yaml rootDir: "./" # Use the current directory @@ -399,7 +404,9 @@ npm: This setting is supported up to Cypress 12.14.0. For newer versions, use `registries`. ::: -Specifies the location of the npm registry source. If the registry source is a private address and you are running tests on Sauce Cloud, you can provide access to the registry source using [Sauce Connect](/dev/cli/saucectl/#run-tests-on-sauce-labs-with-sauce-connect). +Specifies the location of the npm registry source. If the registry source is a +private address, and you are running tests on Sauce Cloud, you can provide +access to the registry source using [Sauce Connect](/dev/cli/saucectl/usage/use-cases/#sauce-connect). ```yaml npm: @@ -412,7 +419,9 @@ npm:

| OPTIONAL | ARRAY |

-Specifies the location of the npm registry, scope, and credentials. Only one scopeless registry is allowed. If the registry is inside a private network, you must establish a tunnel using [Sauce Connect](/dev/cli/saucectl/#run-tests-on-sauce-labs-with-sauce-connect). +Specifies the location of the npm registry, scope, and credentials. Only one +scopeless registry is allowed. If the registry is inside a private network, you +must establish a tunnel using [Sauce Connect](/dev/cli/saucectl/usage/use-cases/#sauce-connect). ```yaml npm: diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md index bba81b939e..81a895a55a 100644 --- a/docs/web-apps/automated-testing/playwright/yaml.md +++ b/docs/web-apps/automated-testing/playwright/yaml.md @@ -196,7 +196,8 @@ saucectl run --ccy 5

| OPTIONAL | INTEGER |

-Sets the number of times to retry a failed suite. For more settings, you can refer to [passThreshold](#passThreshold). +Sets the number of times to retry a failed suite. For more settings, you can +refer to [passThreshold](#passthreshold). ```yaml sauce: @@ -338,7 +339,11 @@ The order of precedence is as follows: --env flag > root-level environment varia

| REQUIRED | OBJECT |

-The directory of files that need to be bundled and uploaded for the tests to run. Ignores what is specified in `.sauceignore`. See [Tailoring Your Test File Bundle](#tailoring-your-test-file-bundle) for more details. The following examples show the different relative options for setting this value. +The directory of files that need to be bundled and uploaded for the tests to +run. Ignores what is specified in `.sauceignore`. +See [Tailoring Your Test File Bundle](/web-apps/automated-testing/playwright/advanced/#tailoring-your-test-file-bundle) +for more details. The following examples show the different relative options for +setting this value. ```yaml rootDir: "./" # Use the current directory @@ -380,7 +385,9 @@ npm: This setting is supported up to Playwright 1.35.1. For newer versions, use `registries`. ::: -Specifies the location of the npm registry source. If the registry source is a private address and you are running tests on Sauce Cloud, you can provide access to the registry source using [Sauce Connect](/dev/cli/saucectl/#run-tests-on-sauce-labs-with-sauce-connect). +Specifies the location of the npm registry source. If the registry source is a +private address, and you are running tests on Sauce Cloud, you can provide +access to the registry source using [Sauce Connect](/dev/cli/saucectl/usage/use-cases/#sauce-connect). ```yaml npm: @@ -393,7 +400,9 @@ npm:

| OPTIONAL | ARRAY |

-Specifies the location of the npm registry, scope, and credentials. Only one scopeless registry is allowed. If the registry is inside a private network, you must establish a tunnel using [Sauce Connect](/dev/cli/saucectl/#run-tests-on-sauce-labs-with-sauce-connect). +Specifies the location of the npm registry, scope, and credentials. Only one +scopeless registry is allowed. If the registry is inside a private network, you +must establish a tunnel using [Sauce Connect](/dev/cli/saucectl/usage/use-cases/#sauce-connect). ```yaml npm: diff --git a/docs/web-apps/automated-testing/replay/yaml.md b/docs/web-apps/automated-testing/replay/yaml.md index a001311314..301de645c0 100644 --- a/docs/web-apps/automated-testing/replay/yaml.md +++ b/docs/web-apps/automated-testing/replay/yaml.md @@ -177,7 +177,8 @@ saucectl run --ccy 5

| OPTIONAL | INTEGER |

-Sets the number of times to retry a failed suite. For more settings, you can refer to [passThreshold](#passThreshold). +Sets the number of times to retry a failed suite. For more settings, you can +refer to [passThreshold](#passthreshold). ```yaml sauce: diff --git a/docs/web-apps/automated-testing/selenium.md b/docs/web-apps/automated-testing/selenium.md index 04b6a3afb7..7e8d887374 100644 --- a/docs/web-apps/automated-testing/selenium.md +++ b/docs/web-apps/automated-testing/selenium.md @@ -68,9 +68,9 @@ The way to define capabilities in recent versions of Selenium is with browser op - Ensure you have the session you want (e.g., browser name, browser version, operating system). - Set the behavior you want in your session. There are three types of options that set behavior: - - [Common options](/dev/test-configuration-options/#browser-w3c-capabilities--optional): + - [Common options](/dev/test-configuration-options/#w3c-webdriver-browser-capabilities--optional): these include things such as page load timeouts, and insecure certificate behavior. - - [Browser options](/dev/test-configuration-options/#browser-vendor-capabilities) + - [Browser options](/dev/test-configuration-options/#desktop-browser-capabilities-sauce-specific--optional) - Sauce Labs options: see [Test Configuration](/dev/test-configuration-options) for a complete guide to our available capabilities. diff --git a/docs/web-apps/automated-testing/testcafe/yaml.md b/docs/web-apps/automated-testing/testcafe/yaml.md index e45751a899..01e1808fa4 100644 --- a/docs/web-apps/automated-testing/testcafe/yaml.md +++ b/docs/web-apps/automated-testing/testcafe/yaml.md @@ -196,7 +196,8 @@ saucectl run --ccy 5

| OPTIONAL | INTEGER |

-Sets the number of times to retry a failed suite. For more settings, you can refer to [passThreshold](#passThreshold). +Sets the number of times to retry a failed suite. For more settings, you can +refer to [passThreshold](#passthreshold). ```yaml sauce: @@ -338,7 +339,11 @@ The order of precedence is as follows: --env flag > root-level environment varia

| REQUIRED | OBJECT |

-The directory of files that need to be bundled and uploaded for the tests to run. Ignores what is specified in `.sauceignore`. See [Tailoring Your Test File Bundle](#tailoring-your-test-file-bundle) for more details. The following examples show the different relative options for setting this value. +The directory of files that need to be bundled and uploaded for the tests to +run. Ignores what is specified in `.sauceignore`. +See [Tailoring Your Test File Bundle](/web-apps/automated-testing/testcafe/advanced/#tailoring-your-test-file-bundle) +for more details. The following examples show the different relative options for +setting this value. ```yaml rootDir: "./" # Use the current directory @@ -382,7 +387,9 @@ npm: This setting is supported up to TestCafe 2.6.2. For newer versions, use `registries`. ::: -Specifies the location of the npm registry source. If the registry source is a private address and you are running tests on Sauce Cloud, you can provide access to the registry source using [Sauce Connect](/dev/cli/saucectl/#run-tests-on-sauce-labs-with-sauce-connect). +Specifies the location of the npm registry source. If the registry source is a +private address, and you are running tests on Sauce Cloud, you can provide +access to the registry source using [Sauce Connect](/dev/cli/saucectl/usage/use-cases/#sauce-connect). ```yaml npm: @@ -395,7 +402,9 @@ npm:

| OPTIONAL | ARRAY |

-Specifies the location of the npm registry, scope, and credentials. Only one scopeless registry is allowed. If the registry is inside a private network, you must establish a tunnel using [Sauce Connect](/dev/cli/saucectl/#run-tests-on-sauce-labs-with-sauce-connect). +Specifies the location of the npm registry, scope, and credentials. Only one +scopeless registry is allowed. If the registry is inside a private network, you +must establish a tunnel using [Sauce Connect](/dev/cli/saucectl/usage/use-cases/#sauce-connect). ```yaml npm: