ci: enable lint comments in pull requests (#2910)

saucelabs · Aug 27, 2024 · 520c631 · 520c631
1 parent bd45c13
commit 520c631
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git 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
@@ -18,4 +17,4 @@ jobs:
         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 }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1 +1 @@
-Please see our Contributing Guidelines published on our site: https://docs.saucelabs.com/contributing
+See our [Contributing Guidelines](https://docs.saucelabs.com/contributing).
diff --git a/README.md b/README.md
@@ -15,7 +15,9 @@
     <img src="https://app.saucelabs.com/browser-matrix/saucy-docs.svg?auth=495eb49379a16a1e211eb5d27444fa76" alt= "Sauce Labs Browser Matrix"/>
 </p>
 
-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**
 
@@ -34,8 +36,7 @@ Welcome to the `sauce-docs` repository. This website contains all technical docu
 ## 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
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Please see our Contributing Guidelines published on our site: https://docs.saucelabs.com/contributing
		See our [Contributing Guidelines](https://docs.saucelabs.com/contributing).