Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 3.89 KB

README.md

File metadata and controls

101 lines (68 loc) · 3.89 KB
Raw

Sauce Labs Docs

QA Sauce Bot

Twitter Follow PRs Welcome Gitpod Ready-to-Code Sauce Pipeline Browser Tests Sauce Test Status

Sauce Browser Matrix

Welcome to the sauce-docs, this website contains all technical documentation about Sauce Labs and its products. This site uses Docusaurus 2, a modern static website generator.

Table of Contents

  1. Prerequisites
  2. Installation
  3. Local Development
    1. Building the Website
  4. Contributing

Prerequisites

  • git
  • Node.js 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
  • Yarn 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.
  • Docker (optional if you want to deploy locally via a container or to test before you deploy)

Installation

  • Pull down this repo:

     git clone https://github.com/saucelabs/sauce-docs.git

  • Change directory to sauce-docs:

    cd sauce-docs

  • Install the dependencies:

     npm install

Local Development

  • Serve the website locally (without Algolia API Key):

    npm run dev

    This command builds the site and serves it on your machine's host (http://localhost:3000) and requires no Algolia API key.

  • Start the website locally (with Algolia API Key):

     npm run start

    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.

Building the Website

  • Build the website:

     npm run build

    This command gathers the static content and places them in a build directory; which is compatible with most static content hosting services.

  • Serve the website:

     npm run serve

    This command builds the site and serves it on your machine's host (http://localhost:3000).

Contributing

Before you edit the docs, review the style guide to see how to get the most out of your markdown and to ensure you are following our conventions. Also, before submitting an issue or PR in GitHub, please review the code of conduct and or contribution guide for further details.