Skip to content

Commit faf8e64

Browse files
author
Jame Tacker
committed
fixed merge conflicts
1 parent 0a31e74 commit faf8e64

File tree

510 files changed

+20989
-18201
lines changed

Some content is hidden

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

510 files changed

+20989
-18201
lines changed

‎.husky/pre-commit

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npx eslint .
5+
npx prettier . --check

‎README.md

+36-38
Original file line numberDiff line numberDiff line change
@@ -19,78 +19,76 @@
1919

2020
Welcome to the `sauce-docs`, this website contains all technical documentation about Sauce Labs and its products. This site uses [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
2121

22-
__Table of Contents__
22+
**Table of Contents**
2323

2424
1. [Prerequisites](#prerequisites)
2525
2. [Installation](#installation)
2626
3. [Local Development](#local-development)
27-
1. [Building the Website](#building-the-website)
28-
5. [Contributing](#contributing)
27+
1. [Building the Website](#building-the-website)
28+
4. [Contributing](#contributing)
2929

3030
## Prerequisites
3131

32-
* [`git`](https://git-scm.com/downloads)
33-
* [Node.js](https://nodejs.org/en/download/) `version >= 14.15.0` or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed
34-
* [Yarn](https://yarnpkg.com/en/) `version >= 1.22.5` (which can be checked by running yarn version). Yarn is a performant package manager for JavaScript and replaces the npm client. It is not strictly necessary but highly encouraged.
35-
* [Docker](https://docs.docker.com/get-docker/) (optional if you want to deploy locally via a container or to test before you deploy)
32+
- [`git`](https://git-scm.com/downloads)
33+
- [Node.js](https://nodejs.org/en/download/) `version >= 14.15.0` or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed
34+
- [Yarn](https://yarnpkg.com/en/) `version >= 1.22.5` (which can be checked by running yarn version). Yarn is a performant package manager for JavaScript and replaces the npm client. It is not strictly necessary but highly encouraged.
35+
- [Docker](https://docs.docker.com/get-docker/) (optional if you want to deploy locally via a container or to test before you deploy)
3636

3737
## Installation
3838

39-
* Pull down this repo:
39+
- Pull down this repo:
4040

41-
```bash
42-
git clone https://github.com/saucelabs/sauce-docs.git
43-
```
41+
```bash
42+
git clone https://github.com/saucelabs/sauce-docs.git
43+
```
4444

45-
* Change directory to `sauce-docs`:
45+
- Change directory to `sauce-docs`:
4646

4747
```bash
4848
cd sauce-docs
4949
```
5050

51-
* Install the dependencies:
51+
- Install the dependencies:
5252

53-
```
54-
npm install
55-
```
53+
```
54+
npm install
55+
```
5656

5757
## Local Development
5858

59-
* Serve the website locally (without Algolia API Key):
59+
- Serve the website locally (without Algolia API Key):
6060

61-
```
62-
npm run dev
63-
```
61+
```
62+
npm run dev
63+
```
6464

65-
This command builds the site and serves it on your machine's host (http://localhost:3000) and requires no [Algolia API key](https://docusaurus.io/docs/search#connecting-algolia).
65+
This command builds the site and serves it on your machine's host (http://localhost:3000) and requires no [Algolia API key](https://docusaurus.io/docs/search#connecting-algolia).
6666
67-
* Start the website locally (with Algolia API Key):
67+
- Start the website locally (with Algolia API Key):
6868
69-
```
70-
npm run start
71-
```
69+
```
70+
npm run start
71+
```
7272
73-
This command starts a local development server and open up a browser window (http://localhost:3000). Most changes perform live updates to your server without having to restart.
73+
This command starts a local development server and open up a browser window (http://localhost:3000). Most changes perform live updates to your server without having to restart.
7474
7575
### Building the Website
7676
77-
* Build the website:
78-
79-
```
80-
npm run build
81-
```
77+
- Build the website:
8278
83-
This command gathers the static content and places them in a `build` directory; which is compatible with most static content hosting services.
84-
85-
* Serve the website:
79+
```
80+
npm run build
81+
```
8682
87-
```
88-
npm run serve
89-
```
83+
This command gathers the static content and places them in a `build` directory; which is compatible with most static content hosting services.
9084
91-
This command builds the site and serves it on your machine's host (http://localhost:3000).
85+
- Serve the website:
9286
87+
```
88+
npm run serve
89+
```
9390
91+
This command builds the site and serves it on your machine's host (http://localhost:3000).
9492

9593
## Contributing
9694

‎docs/ClientOnly.jsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
function ClientOnly({children}) {
1+
function ClientOnly({ children }) {
22
if (typeof window === 'undefined') {
33
return null;
44
}
55

66
return children;
77
}
88

9-
export default ClientOnly;
9+
export default ClientOnly;

‎docs/api-testing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ hide_table_of_contents: true
88

99
At its core, Sauce Labs API Testing allows you to use an HTTP client or a proprietary test composer to generate and edit intelligent contract or functional tests. The tests can be automated with any CI/CD tool or using the platform’s scheduler. Functional tests can then be used as load tests or scheduled as uptime monitors.
1010

11-
>**Documentation**<br/>You're viewing documentation for the API Testing and Monitoring cloud solution. To view the documentation for the on-premise solution see [API Fortress On-Prem (Legacy)](/api-testing/on-prem/quick-start/).
11+
> **Documentation**<br/>You're viewing documentation for the API Testing and Monitoring cloud solution. To view the documentation for the on-premise solution see [API Fortress On-Prem (Legacy)](/api-testing/on-prem/quick-start/).
1212
1313
<img src="/img/api-testing/API Testing Getting Started.png" width="600"/>
1414
<div className="box-wrapper" markdown="1">

‎docs/api-testing/build-from-spec.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: build-from-spec
33
title: Building an API Test from a Spec File
44
sidebar_label: Build Test from Spec File
5-
description: "Automatically generate tests from an OpenAPI spec or HAR file."
5+
description: 'Automatically generate tests from an OpenAPI spec or HAR file.'
66
---
77

88
import useBaseUrl from '@docusaurus/useBaseUrl';
@@ -11,20 +11,19 @@ Using the API Testing **HTTP Client**, you can generate tests from external endp
1111

1212
## What You'll Need
1313

14-
* A Sauce Labs account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/) or sign up for a [free trial license](https://saucelabs.com/sign-up))
15-
* An existing API Testing Project. For details on how to create one, see [API Testing Quickstart](/api-testing/quickstart/)
16-
* An OpenAPI Specification file (v3.0 or higher) or HAR (HTTP Archive) file
14+
- A Sauce Labs account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/) or sign up for a [free trial license](https://saucelabs.com/sign-up))
15+
- An existing API Testing Project. For details on how to create one, see [API Testing Quickstart](/api-testing/quickstart/)
16+
- An OpenAPI Specification file (v3.0 or higher) or HAR (HTTP Archive) file
1717

1818
:::note
1919
Looking to import from Postman? See [Importing Postman Collections](/api-testing/import-postman-collection/).
2020
:::
2121

22-
2322
## Importing Your Spec File
2423

2524
1. Log in to Sauce Labs, then click **API Testing**.
2625
2. Go into any Project.
27-
3. From within a Project, click the __HTTP Client__ tab.<br/><img src={useBaseUrl('img/api-fortress/2021/01/HTTPClient.png')} alt="HTTP Client Button" width="400"/>
26+
3. From within a Project, click the **HTTP Client** tab.<br/><img src={useBaseUrl('img/api-fortress/2021/01/HTTPClient.png')} alt="HTTP Client Button" width="400"/>
2827
4. Click the **Import OpenAPI/HAR/Postman** button, then select and upload your file from your local machine.<br/><img src={useBaseUrl('img/api-fortress/2021/01/importSpec.png')} alt="Import OpenAPI / Postman button" width="450" />
2928
5. Click on the folder in your **Snapshots** tree where you'd like to save your file.<br/><img src={useBaseUrl('img/api-fortress/2021/04/importFolder.png')} alt="Import to Snapshots folder"/>
3029
6. Click **Save**.<br/><img src={useBaseUrl('img/api-fortress/2021/04/importFolder2.png')} alt="Import file to Project"/>
@@ -36,10 +35,9 @@ Looking to import from Postman? See [Importing Postman Collections](/api-testing
3635

3736
Follow the instructions under our Quickstart doc, starting with the [Generate Test](/api-testing/quickstart/#generate-test) step.
3837

39-
4038
## More Information
4139

42-
* [Importing Sauce Labs API Tests from Postman](/api-testing/import-postman-collection/)
43-
* Features coming soon:
44-
* Support for additional spec file formats: RAML, API Blueprint, I/O Docs, SOAP, WSDL
45-
* Ability to create a test by referencing the URL that points to your spec file
40+
- [Importing Sauce Labs API Tests from Postman](/api-testing/import-postman-collection/)
41+
- Features coming soon:
42+
- Support for additional spec file formats: RAML, API Blueprint, I/O Docs, SOAP, WSDL
43+
- Ability to create a test by referencing the URL that points to your spec file

0 commit comments

Comments
 (0)