Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: anchors #2932

Merged
merged 16 commits into from
Sep 10, 2024
4 changes: 2 additions & 2 deletions docs/api-testing/composer/other-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

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.

Check warning on line 25 in docs/api-testing/composer/other-components.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api-testing/composer/other-components.md#L25

[sauce.UnclearAntecedent] Instead of 'This is', try starting this sentence with a specific subject and verb.
Raw output
{"message": "[sauce.UnclearAntecedent] Instead of 'This is', try starting this sentence with a specific subject and verb.", "location": {"path": "docs/api-testing/composer/other-components.md", "range": {"start": {"line": 25, "column": 1}}}, "severity": "WARNING"}

<details>
<summary><strong>Parameters</strong></summary>
Expand Down Expand Up @@ -317,7 +317,7 @@

#### 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:

Check warning on line 320 in docs/api-testing/composer/other-components.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api-testing/composer/other-components.md#L320

[sauce.Simplicity] Remove 'useful'. Be precise instead of subjective.
Raw output
{"message": "[sauce.Simplicity] Remove 'useful'. Be precise instead of subjective.", "location": {"path": "docs/api-testing/composer/other-components.md", "range": {"start": {"line": 320, "column": 30}}}, "severity": "WARNING"}

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

Expand Down
2 changes: 1 addition & 1 deletion docs/api-testing/integrations/apifctl-cicd-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ Identifies the ID of the event you want to see. For use with the **[`event`](#ev

<p><small>| STRING |</small></p>

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
Expand Down
5 changes: 4 additions & 1 deletion docs/api-testing/load-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,10 @@
- **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

Check warning on line 106 in docs/api-testing/load-testing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api-testing/load-testing.md#L106

[sauce.Dropdown] Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'
Raw output
{"message": "[sauce.Dropdown] Use 'dropdown list' to refer to the UI element. Do not use dropdown without list after it. Do not use drop-down (hyphenated), dropdown menu, or other variants. For example: 'From the Visibility dropdown list, select Public.'", "location": {"path": "docs/api-testing/load-testing.md", "range": {"start": {"line": 106, "column": 19}}}, "severity": "WARNING"}
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).

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

Expand Down
12 changes: 0 additions & 12 deletions docs/api-testing/on-prem/api/using-the-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/api-testing/use-cases/saving-token-kv.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/api-testing/use-cases/use-drive.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
7 changes: 6 additions & 1 deletion docs/basics/acct-team-mgmt/adding-deactivating-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 6 additions & 1 deletion docs/basics/acct-team-mgmt/managing-user-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
<img src={useBaseUrl('img/team-mgmt/user-settings-nav.png')} alt="User Settings navigation" width="350"/>
Expand Down
9 changes: 8 additions & 1 deletion docs/basics/acct-team-mgmt/viewing-exporting-usage-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion docs/basics/integrations/jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down
4 changes: 3 additions & 1 deletion docs/basics/sso/setting-up-sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@
## 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

Check warning on line 34 in docs/basics/sso/setting-up-sso.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/basics/sso/setting-up-sso.md#L34

[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/basics/sso/setting-up-sso.md", "range": {"start": {"line": 34, "column": 77}}}, "severity": "WARNING"}
multiple organizations, please refer to [this section](/basics/sso/setting-up-sso-special-cases/#multiple-organizations-with-the-same-email-domain-at-sauce-labs).

Check notice on line 35 in docs/basics/sso/setting-up-sso.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/basics/sso/setting-up-sso.md#L35

[sauce.WordsToAvoid] Avoid usage of 'please'.
Raw output
{"message": "[sauce.WordsToAvoid] Avoid usage of 'please'.", "location": {"path": "docs/basics/sso/setting-up-sso.md", "range": {"start": {"line": 35, "column": 25}}}, "severity": "INFO"}

## Setup Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/cli/sauce-connect-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ Use "sc <command> --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).
8 changes: 5 additions & 3 deletions docs/dev/cli/sauce-connect-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).<br/>
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/>
**Environment variable**: `SAUCE_TUNNEL_IDENTIFIER`<br/>
**Shorthand**: `-i`

Expand All @@ -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).<br/>
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/>
**Environment variable**: `SAUCE_TUNNEL_NAME`<br/>
**Shorthand**: `-i`

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

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

**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/>
**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.<br/>
**Environment variable**: `SAUCE_STATUS_ADDRESS`<br/>
**Shorthand**: n/a

Expand Down
4 changes: 3 additions & 1 deletion docs/dev/error-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading