From c677c9a4b46c75366d82dec2b44ae3f0b6a09018 Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Tue, 27 Aug 2024 13:14:10 -0700 Subject: [PATCH 1/6] docs: remove version specific link --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 67549e9aeb..2a0a9c54a1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ Sauce Labs Browser Matrix

-Welcome to the `sauce-docs` repository. This website contains all technical documentation about Sauce Labs and its products. This website uses [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. +Welcome to the `sauce-docs` repository. This website contains all technical +documentation about Sauce Labs and its products and is built on top of +[Docusaurus](https://docusaurus.io/), a modern static website generator. **Table of Contents** From 0d9876a8ed886161b2295f19327000d1e003aebe Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Tue, 27 Aug 2024 13:16:47 -0700 Subject: [PATCH 2/6] docs: remove yarn --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 2a0a9c54a1..fb8ea4e975 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,7 @@ documentation about Sauce Labs and its products and is built on top of ## Prerequisites - [`git`](https://git-scm.com/downloads) -- [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 -- [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. +- [Node.js](https://nodejs.org/en/download/) `version >= 18` or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed - [Docker](https://docs.docker.com/get-docker/) (optional if you want to deploy locally via a container or to test before you deploy) ## Installation From 17aa9a70dc28fad44e0b6c3e7f6d299aceeabf85 Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Tue, 27 Aug 2024 13:47:59 -0700 Subject: [PATCH 3/6] ci: enable lint checks in diffs --- .github/workflows/vale-linter.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/vale-linter.yml b/.github/workflows/vale-linter.yml index e61426ad3c..79c2230277 100644 --- a/.github/workflows/vale-linter.yml +++ b/.github/workflows/vale-linter.yml @@ -3,7 +3,6 @@ on: [pull_request] jobs: vale: - name: runner / vale runs-on: ubuntu-latest steps: - name: Checkout @@ -12,10 +11,10 @@ jobs: - name: Lint uses: errata-ai/vale-action@reviewdog with: - reporter: github-pr-review + reporter: github-pr-check level: error fail_on_error: false env: # Required, set by GitHub actions automatically: # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 3b4bfd29ad8b57d9aa08fd55b66dd396c8ec2d61 Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Tue, 27 Aug 2024 14:05:11 -0700 Subject: [PATCH 4/6] docs: convert to link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c882dd2cb2..ea9f7f0a4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1 @@ -Please see our Contributing Guidelines published on our site: https://docs.saucelabs.com/contributing +Please see our [Contributing Guidelines](https://docs.saucelabs.com/contributing). From 03650876ed2ceaaba424b87e7a4ee0ec838eb79f Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Tue, 27 Aug 2024 14:42:14 -0700 Subject: [PATCH 5/6] try PR comments instead --- .github/workflows/vale-linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale-linter.yml b/.github/workflows/vale-linter.yml index 79c2230277..420a29b513 100644 --- a/.github/workflows/vale-linter.yml +++ b/.github/workflows/vale-linter.yml @@ -11,7 +11,7 @@ jobs: - name: Lint uses: errata-ai/vale-action@reviewdog with: - reporter: github-pr-check + reporter: github-pr-review level: error fail_on_error: false env: From aecca726f82a4db6d5537e0623a54288c2306c32 Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Tue, 27 Aug 2024 14:55:34 -0700 Subject: [PATCH 6/6] docs: lint --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea9f7f0a4a..cc0e8adf19 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1 @@ -Please see our [Contributing Guidelines](https://docs.saucelabs.com/contributing). +See our [Contributing Guidelines](https://docs.saucelabs.com/contributing).