From a3e20d9150abe92146fa07b149fd1c51b0091862 Mon Sep 17 00:00:00 2001 From: Lindsay Levine Date: Fri, 5 Mar 2021 00:08:51 -0500 Subject: [PATCH 1/9] prepare for deprecating with README and MIGRATING.md --- MIGRATING.md | 17 +++++++++++++++++ README.md | 18 ++++-------------- 2 files changed, 21 insertions(+), 14 deletions(-) create mode 100644 MIGRATING.md diff --git a/MIGRATING.md b/MIGRATING.md new file mode 100644 index 0000000..0d0a8f2 --- /dev/null +++ b/MIGRATING.md @@ -0,0 +1,17 @@ +## Migrating to Essential Next.js Plugin + +This guide is to assist `next-on-netlify` users in their migration to Netlify's [Essential Next.js build plugin](https://github.com/netlify/netlify-plugin-nextjs). + +Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) to ask questions about migrating and/or the deprecation of `next-on-netlify`. + +### Existing NoN users + +1. Uninstall `next-on-netlify` +2. Remove the `"postbuild": "next-on-netlify"` script from your package.json +3. Get the plugin + 1. For new Next.js sites on Netlify, the plugin will be automatically installed. You can opt out of the plugin by visiting the Plugins tab for your site in the Netlify UI. + 2. For existing sites on Netlify, follow the manual installation instructions in the [plugin README](https://github.com/netlify/netlify-plugin-nextjs#installation-and-configuration), which explains UI-based and file-based installation. + +### Brand New Users + +1. Deploy a new Next.js site to Netlify! Your site will automatically build with the plugin. You can opt of the plugin by visiting the Plugins tab for your site in the Netlify UI. diff --git a/README.md b/README.md index c5f690e..92c5ede 100644 --- a/README.md +++ b/README.md @@ -17,23 +17,13 @@ `next-on-netlify` is a utility for enabling server-side rendering in Next.js on Netlify. It wraps your application in a tiny compatibility layer, so that pages can use Netlify Functions to be server-side rendered. -- Build plugin [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs) -- [Plugin npm package](https://www.npmjs.com/package/@netlify/plugin-nextjs) - -## Next on Netlify Roadmap - -The future of Next.js on Netlify is growing beyond `next-on-netlify`. The recommended path forward is to install [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs) - a build plugin released and supported by the team behind `next-on-netlify`. +## Deprecating next-on-netlify -The plugin relies on `next-on-netlify` but offers a smoother experience, including: +We are deprecating `next-on-netlify` in favor of Netlify's [Essential Next.js build plugin](https://github.com/netlify/netlify-plugin-nextjs). Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) to learn more about the deprecation of `next-on-netlify` and ask any questions. You can also visit our simple [Migration doc](https://github.com/netlify/netlify-plugin-nextjs/blob/main/MIGRATING.md) for assistance migrating to the plugin. -1. one-click, zero-config installation -2. allowing custom functions and publish directories - -See the [plugin's README](https://github.com/netlify/netlify-plugin-nextjs#readme) for more information. Our team's end goal is to make the Next.js on Netlify experience as seamless as possible. - -Note: since `next-on-netlify` will remain the primary source of logic for Next.js on Netlify, the existing `next-on-netlify` setup will continue to work for users who prefer manual installation and configuration. +- Build plugin [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs) +- [Plugin npm package](https://www.npmjs.com/package/@netlify/plugin-nextjs) -The plugin can be found on [npm here](https://www.npmjs.com/package/@netlify/plugin-nextjs). ## Table of Contents From 1a691a124577c5f75ffd5786034682bf069ea6cb Mon Sep 17 00:00:00 2001 From: Jason Lengstorf Date: Fri, 5 Mar 2021 13:13:27 -0800 Subject: [PATCH 2/9] fix: update capitalization Co-authored-by: rstavchansky --- MIGRATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MIGRATING.md b/MIGRATING.md index 0d0a8f2..05a9553 100644 --- a/MIGRATING.md +++ b/MIGRATING.md @@ -1,6 +1,6 @@ ## Migrating to Essential Next.js Plugin -This guide is to assist `next-on-netlify` users in their migration to Netlify's [Essential Next.js build plugin](https://github.com/netlify/netlify-plugin-nextjs). +This guide is to assist `next-on-netlify` users in their migration to Netlify's [Essential Next.js Build Plugin](https://github.com/netlify/netlify-plugin-nextjs). Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) to ask questions about migrating and/or the deprecation of `next-on-netlify`. From ca40d5f9e52e9bbacfae58265080feeb380273b1 Mon Sep 17 00:00:00 2001 From: Jason Lengstorf Date: Fri, 5 Mar 2021 13:13:52 -0800 Subject: [PATCH 3/9] fix: add name, formatting Co-authored-by: rstavchansky --- MIGRATING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/MIGRATING.md b/MIGRATING.md index 05a9553..f3a1369 100644 --- a/MIGRATING.md +++ b/MIGRATING.md @@ -7,8 +7,8 @@ Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) ### Existing NoN users 1. Uninstall `next-on-netlify` -2. Remove the `"postbuild": "next-on-netlify"` script from your package.json -3. Get the plugin +2. Remove the `"postbuild": "next-on-netlify"` script from your `package.json`. +3. Get the Essential Next.js plugin. 1. For new Next.js sites on Netlify, the plugin will be automatically installed. You can opt out of the plugin by visiting the Plugins tab for your site in the Netlify UI. 2. For existing sites on Netlify, follow the manual installation instructions in the [plugin README](https://github.com/netlify/netlify-plugin-nextjs#installation-and-configuration), which explains UI-based and file-based installation. From bce10603b72b45b1a83b3c806e65e32e94fa991b Mon Sep 17 00:00:00 2001 From: lindsaylevine <57350178+lindsaylevine@users.noreply.github.com> Date: Fri, 5 Mar 2021 19:42:52 -0800 Subject: [PATCH 4/9] fix: plugin capitalization Co-authored-by: rstavchansky --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 92c5ede..29d5e9a 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ We are deprecating `next-on-netlify` in favor of Netlify's [Essential Next.js build plugin](https://github.com/netlify/netlify-plugin-nextjs). Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) to learn more about the deprecation of `next-on-netlify` and ask any questions. You can also visit our simple [Migration doc](https://github.com/netlify/netlify-plugin-nextjs/blob/main/MIGRATING.md) for assistance migrating to the plugin. -- Build plugin [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs) +- Build Plugin [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs) - [Plugin npm package](https://www.npmjs.com/package/@netlify/plugin-nextjs) From d6bf16d9865d1054cc25e1a26d5368ffde2a2f86 Mon Sep 17 00:00:00 2001 From: lindsaylevine <57350178+lindsaylevine@users.noreply.github.com> Date: Fri, 5 Mar 2021 19:43:24 -0800 Subject: [PATCH 5/9] fix: formatting for brand new users section Co-authored-by: rstavchansky --- MIGRATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MIGRATING.md b/MIGRATING.md index f3a1369..8f7356f 100644 --- a/MIGRATING.md +++ b/MIGRATING.md @@ -14,4 +14,4 @@ Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) ### Brand New Users -1. Deploy a new Next.js site to Netlify! Your site will automatically build with the plugin. You can opt of the plugin by visiting the Plugins tab for your site in the Netlify UI. +Deploy a new Next.js site to Netlify! Your site will automatically build with the plugin. You can [opt out of the plugin](https://docs.netlify.com/configure-builds/build-plugins/#remove-a-plugin) by visiting the **Plugins** tab for your site in the Netlify UI. From 8c9410eb24b856443e004d5164e865ff318b02b6 Mon Sep 17 00:00:00 2001 From: lindsaylevine <57350178+lindsaylevine@users.noreply.github.com> Date: Fri, 5 Mar 2021 19:44:10 -0800 Subject: [PATCH 6/9] fix: caps + period Co-authored-by: rstavchansky --- MIGRATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MIGRATING.md b/MIGRATING.md index 8f7356f..baebd0a 100644 --- a/MIGRATING.md +++ b/MIGRATING.md @@ -6,7 +6,7 @@ Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) ### Existing NoN users -1. Uninstall `next-on-netlify` +1. [Uninstall](https://docs.npmjs.com/uninstalling-packages-and-dependencies) `next-on-netlify`. 2. Remove the `"postbuild": "next-on-netlify"` script from your `package.json`. 3. Get the Essential Next.js plugin. 1. For new Next.js sites on Netlify, the plugin will be automatically installed. You can opt out of the plugin by visiting the Plugins tab for your site in the Netlify UI. From ac9b251e6df7b50a5b3e09359bc3466589fc8aaf Mon Sep 17 00:00:00 2001 From: lindsaylevine <57350178+lindsaylevine@users.noreply.github.com> Date: Fri, 5 Mar 2021 19:44:23 -0800 Subject: [PATCH 7/9] fix: bullet point + formatting Co-authored-by: rstavchansky --- MIGRATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MIGRATING.md b/MIGRATING.md index baebd0a..bf620f8 100644 --- a/MIGRATING.md +++ b/MIGRATING.md @@ -9,7 +9,7 @@ Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) 1. [Uninstall](https://docs.npmjs.com/uninstalling-packages-and-dependencies) `next-on-netlify`. 2. Remove the `"postbuild": "next-on-netlify"` script from your `package.json`. 3. Get the Essential Next.js plugin. - 1. For new Next.js sites on Netlify, the plugin will be automatically installed. You can opt out of the plugin by visiting the Plugins tab for your site in the Netlify UI. + - For new Next.js sites on Netlify, the plugin will be automatically installed. You can [opt out of the plugin](https://docs.netlify.com/configure-builds/build-plugins/#remove-a-plugin) by visiting the **Plugins** tab for your site in the Netlify UI. 2. For existing sites on Netlify, follow the manual installation instructions in the [plugin README](https://github.com/netlify/netlify-plugin-nextjs#installation-and-configuration), which explains UI-based and file-based installation. ### Brand New Users From 0cab8f3e60632f844e0b698b92bb0a75cba471e2 Mon Sep 17 00:00:00 2001 From: lindsaylevine <57350178+lindsaylevine@users.noreply.github.com> Date: Fri, 5 Mar 2021 19:44:39 -0800 Subject: [PATCH 8/9] fix: second bullet point Co-authored-by: rstavchansky --- MIGRATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MIGRATING.md b/MIGRATING.md index bf620f8..0e6806e 100644 --- a/MIGRATING.md +++ b/MIGRATING.md @@ -10,7 +10,7 @@ Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) 2. Remove the `"postbuild": "next-on-netlify"` script from your `package.json`. 3. Get the Essential Next.js plugin. - For new Next.js sites on Netlify, the plugin will be automatically installed. You can [opt out of the plugin](https://docs.netlify.com/configure-builds/build-plugins/#remove-a-plugin) by visiting the **Plugins** tab for your site in the Netlify UI. - 2. For existing sites on Netlify, follow the manual installation instructions in the [plugin README](https://github.com/netlify/netlify-plugin-nextjs#installation-and-configuration), which explains UI-based and file-based installation. + - For existing sites on Netlify, follow the manual installation instructions in the [plugin README](https://github.com/netlify/netlify-plugin-nextjs#installation-and-configuration), which explains UI-based and file-based installation. ### Brand New Users From 1f42ec46f687a5d1378604f9f7ecb146b326588c Mon Sep 17 00:00:00 2001 From: lindsaylevine <57350178+lindsaylevine@users.noreply.github.com> Date: Fri, 5 Mar 2021 19:47:01 -0800 Subject: [PATCH 9/9] fix: caps build plugin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 29d5e9a..6b33008 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ ## Deprecating next-on-netlify -We are deprecating `next-on-netlify` in favor of Netlify's [Essential Next.js build plugin](https://github.com/netlify/netlify-plugin-nextjs). Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) to learn more about the deprecation of `next-on-netlify` and ask any questions. You can also visit our simple [Migration doc](https://github.com/netlify/netlify-plugin-nextjs/blob/main/MIGRATING.md) for assistance migrating to the plugin. +We are deprecating `next-on-netlify` in favor of Netlify's [Essential Next.js Build Plugin](https://github.com/netlify/netlify-plugin-nextjs). Please visit [this issue](https://github.com/netlify/next-on-netlify/issues/176) to learn more about the deprecation of `next-on-netlify` and ask any questions. You can also visit our simple [Migration doc](https://github.com/netlify/netlify-plugin-nextjs/blob/main/MIGRATING.md) for assistance migrating to the plugin. - Build Plugin [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs) - [Plugin npm package](https://www.npmjs.com/package/@netlify/plugin-nextjs)