clarify version requirements for Node.js

prisma · Nov 28, 2024 · d78cc9c · d78cc9c
1 parent 1b9e2fe
commit d78cc9c
Show file tree

Hide file tree

Showing 28 changed files with 36 additions and 39 deletions.
diff --git a/content/100-getting-started/01-quickstart-prismaPostgres.mdx b/content/100-getting-started/01-quickstart-prismaPostgres.mdx
@@ -20,7 +20,7 @@ In this Quickstart guide, you'll learn how to get started from scratch with Pris
 
 To successfully complete this tutorial, you need:
 - a [Prisma Data Platform](https://console.prisma.io/) (PDP) account
-- Node.js 18.18.0 / 20.9.0 / 22.11.0 or higher (learn more about [system requirements](/orm/reference/system-requirements))
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 
 ## 1. Set up a Prisma Postgres database in the Platform Console
 

diff --git a/...tup-prisma/100-start-from-scratch/110-relational-databases-node-cockroachdb.mdx b/...tup-prisma/100-start-from-scratch/110-relational-databases-node-cockroachdb.mdx
@@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [CockroachDB](https://www.cockroachlabs.com/) database server running
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/.../02-setup-prisma/100-start-from-scratch/110-relational-databases-node-mysql.mdx b/.../02-setup-prisma/100-start-from-scratch/110-relational-databases-node-mysql.mdx
@@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [MySQL](https://www.mysql.com/) database server running
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...tup-prisma/100-start-from-scratch/110-relational-databases-node-planetscale.mdx b/...tup-prisma/100-start-from-scratch/110-relational-databases-node-planetscale.mdx
@@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [PlanetScale](https://planetscale.com/) database server running
 
 <Admonition type="warning">

diff --git a/...etup-prisma/100-start-from-scratch/110-relational-databases-node-postgresql.mdx b/...etup-prisma/100-start-from-scratch/110-relational-databases-node-postgresql.mdx
@@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [PostgreSQL](https://www.postgresql.org/) database server running
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...setup-prisma/100-start-from-scratch/110-relational-databases-node-sqlserver.mdx b/...setup-prisma/100-start-from-scratch/110-relational-databases-node-sqlserver.mdx
@@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - A [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) database
   - [Microsoft SQL Server on Linux for Docker](/orm/overview/databases/sql-server/sql-server-docker)
   - [Microsoft SQL Server on Windows (local)](/orm/overview/databases/sql-server/sql-server-local)

diff --git a/...isma/100-start-from-scratch/110-relational-databases-typescript-cockroachdb.mdx b/...isma/100-start-from-scratch/110-relational-databases-typescript-cockroachdb.mdx
@@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [CockroachDB](https://www.cockroachlabs.com/) database server running
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...tup-prisma/100-start-from-scratch/110-relational-databases-typescript-mysql.mdx b/...tup-prisma/100-start-from-scratch/110-relational-databases-typescript-mysql.mdx
@@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [MySQL](https://www.mysql.com/) database server running
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...isma/100-start-from-scratch/110-relational-databases-typescript-planetscale.mdx b/...isma/100-start-from-scratch/110-relational-databases-typescript-planetscale.mdx
@@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [PlanetScale](https://planetscale.com/) database server running
 
 <Admonition type="warning">

diff --git a/...risma/100-start-from-scratch/110-relational-databases-typescript-postgresql.mdx b/...risma/100-start-from-scratch/110-relational-databases-typescript-postgresql.mdx
@@ -16,7 +16,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [PostgreSQL](https://www.postgresql.org/) database server running
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...a/100-start-from-scratch/110-relational-databases-typescript-prismaPostgres.mdx b/...a/100-start-from-scratch/110-relational-databases-typescript-prismaPostgres.mdx
@@ -23,7 +23,7 @@ Learn how to create a new TypeScript project with a Prisma Postgres database fro
 
 To successfully complete this tutorial, you need:
 - a [Prisma Data Platform](https://console.prisma.io/) (PDP) account
-- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions) (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 
 ## Create project setup
 

diff --git a/...prisma/100-start-from-scratch/110-relational-databases-typescript-sqlserver.mdx b/...prisma/100-start-from-scratch/110-relational-databases-typescript-sqlserver.mdx
@@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - A [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) database
   - [Microsoft SQL Server on Linux for Docker](/orm/overview/databases/sql-server/sql-server-docker)
   - [Microsoft SQL Server on Windows (local)](/orm/overview/databases/sql-server/sql-server-local)

diff --git a/...ing-started/02-setup-prisma/100-start-from-scratch/120-mongodb-node-mongodb.mdx b/...ing-started/02-setup-prisma/100-start-from-scratch/120-mongodb-node-mongodb.mdx
@@ -17,7 +17,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - Access to a MongoDB 4.2+ server with a replica set deployment. We recommend using [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
 
   <Admonition type="warning">

diff --git a/...arted/02-setup-prisma/100-start-from-scratch/120-mongodb-typescript-mongodb.mdx b/...arted/02-setup-prisma/100-start-from-scratch/120-mongodb-typescript-mongodb.mdx
@@ -16,7 +16,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - Access to a MongoDB 4.2+ server with a replica set deployment. We recommend using [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
 
   <Admonition type="warning">

diff --git a/...risma/200-add-to-existing-project/110-relational-databases-node-cockroachdb.mdx b/...risma/200-add-to-existing-project/110-relational-databases-node-cockroachdb.mdx
@@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 In order to successfully complete this guide, you need:
 
 - an existing Node.js project with a `package.json`
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [CockroachDB](https://www.cockroachlabs.com) database server running and a database with at least one table
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...etup-prisma/200-add-to-existing-project/110-relational-databases-node-mysql.mdx b/...etup-prisma/200-add-to-existing-project/110-relational-databases-node-mysql.mdx
@@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 In order to successfully complete this guide, you need:
 
 - an existing Node.js project with a `package.json`
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [MySQL](https://www.mysql.com/) database server running and a database with at least one table
 
 

diff --git a/...risma/200-add-to-existing-project/110-relational-databases-node-planetscale.mdx b/...risma/200-add-to-existing-project/110-relational-databases-node-planetscale.mdx
@@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 In order to successfully complete this guide, you need:
 
 - an existing Node.js project with a `package.json`
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [PlanetScale](https://planetscale.com/) database server running and a database with at least one table
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...prisma/200-add-to-existing-project/110-relational-databases-node-postgresql.mdx b/...prisma/200-add-to-existing-project/110-relational-databases-node-postgresql.mdx
@@ -29,7 +29,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 In order to successfully complete this guide, you need:
 
 - an existing Node.js project with a `package.json`
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [PostgreSQL](https://www.postgresql.org/) database server running and a database with at least one table
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...-prisma/200-add-to-existing-project/110-relational-databases-node-sqlserver.mdx b/...-prisma/200-add-to-existing-project/110-relational-databases-node-sqlserver.mdx
@@ -27,7 +27,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - A [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) database
   - [Microsoft SQL Server on Linux for Docker](/orm/overview/databases/sql-server/sql-server-docker)
   - [Microsoft SQL Server on Windows (local)](/orm/overview/databases/sql-server/sql-server-local)

diff --git a/...200-add-to-existing-project/110-relational-databases-typescript-cockroachdb.mdx b/...200-add-to-existing-project/110-relational-databases-typescript-cockroachdb.mdx
@@ -29,7 +29,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 In order to successfully complete this guide, you need:
 
 - an existing Node.js project with a `package.json`
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [CockroachDB](https://www.cockroachlabs.com) database server running and a database with at least one table
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...risma/200-add-to-existing-project/110-relational-databases-typescript-mysql.mdx b/...risma/200-add-to-existing-project/110-relational-databases-typescript-mysql.mdx
@@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 In order to successfully complete this guide, you need:
 
 - an existing Node.js project with a `package.json`
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [MySQL](https://www.mysql.com/) database server running and a database with at least one table
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...200-add-to-existing-project/110-relational-databases-typescript-planetscale.mdx b/...200-add-to-existing-project/110-relational-databases-typescript-planetscale.mdx
@@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 In order to successfully complete this guide, you need:
 
 - an existing Node.js project with a `package.json`
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [PlanetScale](https://planetscale.com/) database server running and a database with at least one table
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/.../200-add-to-existing-project/110-relational-databases-typescript-postgresql.mdx b/.../200-add-to-existing-project/110-relational-databases-typescript-postgresql.mdx
@@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 In order to successfully complete this guide, you need:
 
 - an existing Node.js project with a `package.json`
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - a [PostgreSQL](https://www.postgresql.org/) database server running and a database with at least one table
 
 > See [System requirements](/orm/reference/system-requirements) for exact version requirements.

diff --git a/...a/200-add-to-existing-project/110-relational-databases-typescript-sqlserver.mdx b/...a/200-add-to-existing-project/110-relational-databases-typescript-sqlserver.mdx
@@ -27,7 +27,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - A [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) database
   - [Microsoft SQL Server on Linux for Docker](/orm/overview/databases/sql-server/sql-server-docker)
   - [Microsoft SQL Server on Windows (local)](/orm/overview/databases/sql-server/sql-server-local)

diff --git a/...tarted/02-setup-prisma/200-add-to-existing-project/120-mongodb-node-mongodb.mdx b/...tarted/02-setup-prisma/200-add-to-existing-project/120-mongodb-node-mongodb.mdx
@@ -23,7 +23,7 @@ If you're migrating to Prisma ORM from Mongoose, see our [Migrate from Mongoose
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - Access to a MongoDB 4.2+ server with a replica set deployment. We recommend using [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
 
   <Admonition type="warning">

diff --git a/.../02-setup-prisma/200-add-to-existing-project/120-mongodb-typescript-mongodb.mdx b/.../02-setup-prisma/200-add-to-existing-project/120-mongodb-typescript-mongodb.mdx
@@ -23,7 +23,7 @@ If you're migrating to Prisma ORM from Mongoose, see our [Migrate from Mongoose
 
 In order to successfully complete this guide, you need:
 
-- [Node.js](https://nodejs.org/en/) installed on your machine
+- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
 - Access to a MongoDB 4.2+ server with a replica set deployment. We recommend using [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
 
   <Admonition type="warning">

diff --git a/content/200-orm/500-reference/400-system-requirements.mdx b/content/200-orm/500-reference/400-system-requirements.mdx
@@ -1,16 +1,12 @@
 ---
-title: 'System requirements'
-metaTitle: 'System requirements (Reference)'
-metaDescription: 'System requirements for running Prisma ORM'
+title: "System requirements"
+metaTitle: "System requirements (Reference)"
+metaDescription: "System requirements for running Prisma ORM"
 tocDepth: 3
 ---
 
-<TopBlock>
-
 This page provides an overview of the system requirements for Prisma ORM.
 
-</TopBlock>
-
 ## System requirements
 
 This section lists the software that Prisma ORM requires and the supported operating systems, along with runtime dependency requirements for specific operating systems.
@@ -19,13 +15,14 @@ This section lists the software that Prisma ORM requires and the supported opera
 
 The latest version of Prisma ORM requires the following software:
 
-|                       | Minimum required version |
+| Tool                  | Minimum required version |
 | :-------------------- | :----------------------- |
 | Node.js               | 18.8 / 20.9 / 22.11      |
 | TypeScript (optional) | 5.1.X                    |
 | Yarn (optional)       | 1.19.2                   |
 
-Notes:
+
+
 
 - Prisma ORM supports and tests all _Active LTS_ and _Maintenance LTS_ **Node.js** releases. [Releases that are not in these states like _Current_, and also odd-numbered versions](https://nodejs.org/en/about/releases/) probably also work, but are not recommended for production use.
 - **TypeScript** is only required for TypeScript users.
@@ -50,7 +47,7 @@ Prisma ORM v5 requires the following software:
 
 ### Operating systems
 
-Prisma ORM is supported on MacOS, Windows and most Linux distributions.
+Prisma ORM is supported on macOS, Windows and most Linux distributions.
 
 #### Linux runtime dependencies
 

diff --git a/content/200-orm/800-more/100-under-the-hood/100-engines.mdx b/content/200-orm/800-more/100-under-the-hood/100-engines.mdx
@@ -62,7 +62,7 @@ Add the environment variable to the [`.env` file](/orm/more/development-environm
 
 <TabbedContent code>
 
-<TabItem value="Linux, Unix, MacOS">
+<TabItem value="Linux, Unix, macOs">
 
 ```
 PRISMA_QUERY_ENGINE_BINARY=custom/my-query-engine-unix
@@ -86,7 +86,7 @@ Run the following command to set the environment variable globally (in this exam
 
 <TabbedContent code terminal>
 
-   <TabItem value="Linux, Unix, MacOS">
+   <TabItem value="Linux, Unix, macOs">
 
 ```terminal
 export PRISMA_QUERY_ENGINE_BINARY=/custom/my-query-engine-unix
@@ -116,7 +116,7 @@ The output shows that the query engine path comes from the `PRISMA_QUERY_ENGINE_
 
 <TabbedContent code terminal>
 
-   <TabItem value="Linux, Unix, MacOS">
+   <TabItem value="Linux, Unix, macOs">
 ```terminal highlight=2;normal
 Current platform     : darwin
 Query Engine         : query-engine d6ff7119649922b84e413b3b69660e2f49e2ddf3 (at /custom/my-query-engine-unix)