Skip to content

Commit eb9bd17

Browse files
author
Alex Plischke
authored
fix: anchors (#2932)
* fix: apif anchors * fix: account management anchors * fix: jenkins anchors * fix: sso anchors * fix: sauce connect anchors * fix: error message anchors * fix: glossary anchors * fix: test configuration anchors * fix: error reporting anchors * fix: automated testing anchors * fix: visual testing anchors * fix: test fairy anchors * fix: sauce connect anchors * fix: performance anchors * fix: absolute links
1 parent 27ff36d commit eb9bd17

File tree

66 files changed

+330
-190
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+330
-190
lines changed

docs/api-testing/composer/other-components.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Here are some other components that you can add to a test using the Composer. Th
2222

2323
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.
2424

25-
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.
25+
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.
2626

2727
<details>
2828
<summary><strong>Parameters</strong></summary>
@@ -317,7 +317,7 @@ This component allows you to pause or stop a test entirely.
317317

318318
#### Examples
319319

320-
This component is especially useful when combined with the [`If` component](#if). See the examples below:
320+
This component is especially useful when combined with the [`If` component](/api-testing/composer/logical-components/#if). See the examples below:
321321

322322
<img src={useBaseUrl('img/api-testing/flow_stop.png')} alt="flow_stop.png"/>
323323

docs/api-testing/integrations/apifctl-cicd-integration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ Identifies the ID of the event you want to see. For use with the **[`event`](#ev
489489

490490
<p><small>| STRING |</small></p>
491491

492-
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).
492+
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).
493493

494494
```bash
495495
-b build-12345

docs/api-testing/load-testing.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,10 @@ Load test reports include the following details:
103103
- **Virtual Users** - The number of virtual users for the execution of the test.
104104
- **Failed Tests** - The number of load test execution failures. This will only be visible if there were failures.
105105

106-
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).
106+
The **Footprint** dropdown shows all the endpoints the test is calling, which
107+
you can use to filter to a specific endpoint. The default value shows the data
108+
for All the endpoints. For best results, set up footprints to ensure the report
109+
is readable. For more information, see [Improving Metrics](/api-testing/use-cases/working-with-headers/#improving-metrics).
107110

108111
<img src={useBaseUrl('/img/api-testing/load-test-footprint.png')} alt="The Footprint dropdown" width="200"/>
109112

docs/api-testing/on-prem/api/using-the-api.md

-12
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,6 @@ https://mastiff.apifortress.com/app/api/rest/v3/34d8mm70-c03e-267a-9fa1-90b9flsb
3939
>
4040
> This is useful for later.
4141
42-
**Jump to a Section**
43-
44-
- [Unauthenticated Endpoints](#unauthenticated-endpoints)
45-
- [Run Tests](#test-run)
46-
- [Insights (Data & Information)](#insights-data--information)
47-
- [Authenticated endpoints](#authenticated-endpoints)
48-
- [Authentication](#authentication)
49-
- [Insights (Data & Information)](#insights)
50-
- [Update Tests](#update-tests)
51-
- [Creating Tests Outside of API Fortress](#creating-tests-outside-of-api-fortress)
52-
- [Converting to JUnit Format](#converting-to-junit-format)
53-
5442
# Unauthenticated Endpoints
5543

5644
## Test Run

docs/api-testing/use-cases/saving-token-kv.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ To use the Key/Value Store in other tests in the same Organization, you have to
135135
- Key - for example `token`
136136
- Variable - for example `my_token`
137137

138-
`token` is the **Key** you assigned in the [first step](/#saving-a-token-in-a-keyvalue-store) of the previous example.
138+
`token` is the **Key** you assigned in the [first step](#saving-a-token-in-a-keyvalue-store) of the previous example.
139139
`my_token` is the variable name you will use inside the test for referencing it.
140140

141141
## Refreshing the Token

docs/api-testing/use-cases/use-drive.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Next, consider a scenario where the .csv file contains more columns and you have
139139
140140
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.
141141
142-
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).
142+
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).
143143
144144
This time, we are using _users.csv_ file that contains a list of user details as shown:
145145

docs/basics/acct-team-mgmt/adding-deactivating-users.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,12 @@ If you invite a user by email, you will need to wait until they accept your invi
5050

5151
### SSO Considerations
5252

53-
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.
53+
If SSO and the **Require Single Sign-On** option is enabled for your
54+
organization (see [Single Sign-On Settings](/basics/acct-team-mgmt/org-settings/#sso-advanced-options)),
55+
new users will be outside your IdP. This means they will not be able to log in
56+
to Sauce Labs using the credentials you provided when you created their account
57+
(they will be able to run test automation, however). In this situation, you
58+
should add users manually.
5459

5560
If SSO is enabled but the **Require Single Sign-On** option is not, you can add new users manually, but not via email.
5661

docs/basics/acct-team-mgmt/managing-user-info.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,12 @@ For more information on Sauce Connect and IPSec settings available to Organizati
108108

109109
## User Settings
110110

111-
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).
111+
The User Settings screen allows you to view and change your password and email
112+
address. You can also regenerate an access key, as well as copy a driver string
113+
(for more information, see [Regenerating Access Keys](/basics/acct-team-mgmt/managing-user-info/#regenerating-access-keys)
114+
and [Create a Remote Session](/web-apps/automated-testing/selenium/#step-1-create-a-remote-session)).
115+
If you are an admin and want to change the settings for users in your org, see
116+
[Updating User Information](/basics/acct-team-mgmt/managing-user-info/#updating-user-information).
112117

113118
To access the User Settings screen, on Sauce Labs, click **ACCOUNT** and then click **User settings**.
114119
<img src={useBaseUrl('img/team-mgmt/user-settings-nav.png')} alt="User Settings navigation" width="350"/>

docs/basics/acct-team-mgmt/viewing-exporting-usage-data.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,14 @@ The USAGE widget provides a quick look at the device usage, by test session, for
6363

6464
## Minutes Used vs. Concurrency
6565

66-
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.
66+
One way to tell if you're getting the most efficient use out of your Sauce Labs
67+
plan is to compare the minutes used with the number of concurrent tests run
68+
during the same period. If the ratio of minutes to concurrency is low, for
69+
example, 2:1 (100 minutes:50 concurrent tests), then you are using a lot of
70+
minutes to run very few tests. You should redesign your tests to take greater
71+
advantage of concurrency. See [Scaling Tests](/web-apps/automated-testing/selenium/#scaling-tests)
72+
and [Managing Concurrency](/basics/acct-team-mgmt/concurrency/managing-concurrency)
73+
for more information.
6774

6875
## Exporting Usage Data
6976

docs/basics/integrations/jenkins.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,8 @@ node('mac') {
385385
386386
### Creating the Sauce Publisher Snippet
387387
388-
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).
388+
The `{saucePublisher}` function lets you send test result data to Sauce Labs.
389+
See [Publishing Test Status to Sauce Labs](#publish-test-status-to-sauce-labs).
389390
390391
1. Enable the **Snippet Generator** in Jenkins Pipeline.
391392
1. Select **saucePublisher: Run Sauce Labs Test Publisher** and **Generate Groovy**.

docs/basics/sso/setting-up-sso.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ Sauce Labs supports the following features:
3030
## Special Cases
3131

3232
- 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).
33-
- 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).
33+
- If your company has multiple organizations at Sauce Labs to be integrated with
34+
SAML SSO, and you want to use the same [email domain](#email-domains) across
35+
multiple organizations, please refer to [this section](/basics/sso/setting-up-sso-special-cases/#multiple-organizations-with-the-same-email-domain-at-sauce-labs).
3436

3537
## Setup Overview
3638

docs/dev/cli/sauce-connect-5.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ Use "sc <command> --help" for more information about a given command.
8282
## Additional Resources
8383
8484
- [Sauce Connect Proxy Basic Setup](/secure-connections/sauce-connect-5/installation/).
85-
- [Sauce Connect Proxy Environment Variables](/secure-connections/sauce-connect-5/operation/configuration/#environment-variables/).
85+
- [Sauce Connect Proxy Environment Variables](/secure-connections/sauce-connect-5/operation/configuration/#environment-variables).

docs/dev/cli/sauce-connect-proxy.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ You can view the entire list of CLI options by running the `--help` flag.
109109

110110
**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.
111111

112-
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).<br/>
112+
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).<br/>
113113
**Environment variable**: `SAUCE_TUNNEL_IDENTIFIER`<br/>
114114
**Shorthand**: `-i`
115115

@@ -129,7 +129,7 @@ This flag is deprecated and will be removed in future versions. It is replaced b
129129

130130
**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.
131131

132-
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).<br/>
132+
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).<br/>
133133
**Environment variable**: `SAUCE_TUNNEL_NAME`<br/>
134134
**Shorthand**: `-i`
135135

@@ -389,7 +389,9 @@ Use `--logfile -` to print your log to the console window (stdout) instead of th
389389

390390
<p><small>| OPTIONAL | STRING | <span className="sauceGreen">4.8.x</span> <span className="sauceGreen">4.9.x</span> | </small></p>
391391

392-
**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.<br/>
392+
**Description**: Use this option to define the host:port for the internal web
393+
server used to expose the Sauce Connect Proxy runtime info. See [Sauce Connect Proxy Monitoring](/secure-connections/sauce-connect/proxy-tunnels/#monitoring-tunnels)
394+
for more info. Disabled by default.<br/>
393395
**Environment variable**: `SAUCE_STATUS_ADDRESS`<br/>
394396
**Shorthand**: n/a
395397

docs/dev/error-messages.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,9 @@ Our device pool is available to all subscribed Sauce users and (as you might ima
278278
Instead of passing a specific `deviceName`:
279279

280280
- 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.
281-
- 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.
281+
- If you are looking for a specific OS version instead of a specific make and
282+
model, you can use the [`appium:platformVersion`](/dev/test-configuration-options#appiumplatformversion)
283+
option to fetch a device with that OS regardless of make and model.
282284

283285
```java
284286
// specific deviceId

0 commit comments

Comments
 (0)