From de4f3b8cca33c0204e47695a4a257c3643ec128d Mon Sep 17 00:00:00 2001 From: Dario Piotrowicz Date: Mon, 13 Jan 2025 11:20:12 +0000 Subject: [PATCH 1/2] add warnings in the aws and cloudflare docs regarding the limited windows support --- pages/aws/index.mdx | 15 +++++++++++++++ pages/cloudflare/index.mdx | 11 +++++++++++ 2 files changed, 26 insertions(+) diff --git a/pages/aws/index.mdx b/pages/aws/index.mdx index 6b741e8..b3a029a 100644 --- a/pages/aws/index.mdx +++ b/pages/aws/index.mdx @@ -44,4 +44,19 @@ OpenNext aims to support all Next.js 14 features. Some features are work in prog --- + + +OpenNext can be used on Windows systems but Windows full support is not guaranteed because: + - historically the Next.js tooling itself has had Windows support issues + (and OpenNext is built on these tools) + - the OpenNext team has limited capacity and fully supporting Windows (given the point above) + has been determined to be a lower priority, thus the effort and testing on Windows is limited + +Given the above, you can develop your application under Windows at your own risk. If you don't have an alternative we +recommend running OpenNext using [WSL2](https://learn.microsoft.com/en-us/windows/wsl/) or in a Linux Virtual Machine. + + + +--- + [Get started](/aws/get_started) with deploying your app with OpenNext and your favorite framework. diff --git a/pages/cloudflare/index.mdx b/pages/cloudflare/index.mdx index 00e8aa1..413fecd 100644 --- a/pages/cloudflare/index.mdx +++ b/pages/cloudflare/index.mdx @@ -57,6 +57,17 @@ We will update the list as we progress towards releasing 1.0. We welcome both contributions and feedback! +### Windows support + +The OpenNext Cloudflare can be used on Windows systems but Windows full support is not guaranteed because: + - historically the Next.js tooling itself has had Windows support issues + (and OpenNext is built on these tools) + - the OpenNext team has limited capacity and fully supporting Windows (given the point above) + has been determined to be a lower priority, thus the effort and testing on Windows is limited + +Given the above, you can develop your application under Windows at your own risk. If you don't have an alternative we +recommend running OpenNext using [WSL2](https://learn.microsoft.com/en-us/windows/wsl/) or in a Linux Virtual Machine. + ### How @opennextjs/cloudflare Works The OpenNext Cloudflare adapter works by taking the Next.js build output and transforming it, so that it can run in Cloudflare Workers. From ba0dcd32998f22079c36517a37caf55d30a9cc38 Mon Sep 17 00:00:00 2001 From: Dario Piotrowicz Date: Mon, 13 Jan 2025 14:35:38 +0000 Subject: [PATCH 2/2] create a shared `WindowsSupport.mdx` and mention CI/CD solution --- pages/aws/index.mdx | 12 ++---------- pages/cloudflare/index.mdx | 10 ++-------- shared/WindowsSupport.mdx | 12 ++++++++++++ 3 files changed, 16 insertions(+), 18 deletions(-) create mode 100644 shared/WindowsSupport.mdx diff --git a/pages/aws/index.mdx b/pages/aws/index.mdx index b3a029a..3290d80 100644 --- a/pages/aws/index.mdx +++ b/pages/aws/index.mdx @@ -1,5 +1,6 @@ import { SITE } from '../../config'; import { Callout } from 'nextra/components'; +import WindowsSupport from '../../shared/WindowsSupport.mdx'; This docs is for the V3 of OpenNext. If you are looking for the V2 docs, you can find them [here](/aws/v2). @@ -45,16 +46,7 @@ OpenNext aims to support all Next.js 14 features. Some features are work in prog --- - -OpenNext can be used on Windows systems but Windows full support is not guaranteed because: - - historically the Next.js tooling itself has had Windows support issues - (and OpenNext is built on these tools) - - the OpenNext team has limited capacity and fully supporting Windows (given the point above) - has been determined to be a lower priority, thus the effort and testing on Windows is limited - -Given the above, you can develop your application under Windows at your own risk. If you don't have an alternative we -recommend running OpenNext using [WSL2](https://learn.microsoft.com/en-us/windows/wsl/) or in a Linux Virtual Machine. - + --- diff --git a/pages/cloudflare/index.mdx b/pages/cloudflare/index.mdx index 413fecd..58a42ae 100644 --- a/pages/cloudflare/index.mdx +++ b/pages/cloudflare/index.mdx @@ -1,5 +1,6 @@ import { SITE } from '../../config'; import { Callout } from 'nextra/components'; +import WindowsSupport from '../../shared/WindowsSupport.mdx'; ## Cloudflare @@ -59,14 +60,7 @@ We welcome both contributions and feedback! ### Windows support -The OpenNext Cloudflare can be used on Windows systems but Windows full support is not guaranteed because: - - historically the Next.js tooling itself has had Windows support issues - (and OpenNext is built on these tools) - - the OpenNext team has limited capacity and fully supporting Windows (given the point above) - has been determined to be a lower priority, thus the effort and testing on Windows is limited - -Given the above, you can develop your application under Windows at your own risk. If you don't have an alternative we -recommend running OpenNext using [WSL2](https://learn.microsoft.com/en-us/windows/wsl/) or in a Linux Virtual Machine. + ### How @opennextjs/cloudflare Works diff --git a/shared/WindowsSupport.mdx b/shared/WindowsSupport.mdx new file mode 100644 index 0000000..647b7d1 --- /dev/null +++ b/shared/WindowsSupport.mdx @@ -0,0 +1,12 @@ +OpenNext can be used on Windows systems but Windows full support is not guaranteed because: + - historically the Next.js tooling itself has had Windows support issues + (and OpenNext is built on these tools) + - the OpenNext team has limited capacity and fully supporting Windows (given the point above) + has been determined to be a lower priority, thus the effort and testing on Windows is limited + +Given the above, you can develop your application under Windows at your own risk. If you don't have an alternative we +recommend either: + - running OpenNext using [WSL2](https://learn.microsoft.com/en-us/windows/wsl/), + - in a Linux Virtual Machine or + - develop your application using the standard Next.js tooling and deploy it using OpenNext in CI/CD systems such + as [GitHub Actions](https://github.com/features/actions) that run linux/MacOS environments \ No newline at end of file