Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings
This repository was archived by the owner on May 10, 2021. It is now read-only.

Commit 50f112f

Browse files
lindsaylevinejlengstorfrstavchansky
committed
prepare for deprecating with README and MIGRATING.md (#177)
* prepare for deprecating with README and MIGRATING.md * fix: update capitalization Co-authored-by: rstavchansky <rachael@netlify.com> * fix: add name, formatting Co-authored-by: rstavchansky <rachael@netlify.com> * fix: plugin capitalization Co-authored-by: rstavchansky <rachael@netlify.com> * fix: formatting for brand new users section Co-authored-by: rstavchansky <rachael@netlify.com> * fix: caps + period Co-authored-by: rstavchansky <rachael@netlify.com> * fix: bullet point + formatting Co-authored-by: rstavchansky <rachael@netlify.com> * fix: second bullet point Co-authored-by: rstavchansky <rachael@netlify.com> * fix: caps build plugin Co-authored-by: Jason Lengstorf <jason.lengstorf@netlify.com> Co-authored-by: rstavchansky <rachael@netlify.com>
1 parent 8515dd7 commit 50f112f

File tree

2 files changed

+21
-14
lines changed

2 files changed

+21
-14
lines changed

‎MIGRATING.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Migrating to Essential Next.js Plugin
2+
3+
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).
4+
5+
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`.
6+
7+
### Existing NoN users
8+
9+
1. [Uninstall](https://docs.npmjs.com/uninstalling-packages-and-dependencies) `next-on-netlify`.
10+
2. Remove the `"postbuild": "next-on-netlify"` script from your `package.json`.
11+
3. Get the Essential Next.js plugin.
12+
- 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.
13+
- 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.
14+
15+
### Brand New Users
16+
17+
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.

‎README.md‎

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,13 @@
1717

1818
`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.
1919

20-
- Build plugin [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs)
21-
- [Plugin npm package](https://www.npmjs.com/package/@netlify/plugin-nextjs)
22-
23-
## Next on Netlify Roadmap
24-
25-
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`.
20+
## Deprecating next-on-netlify
2621

27-
The plugin relies on `next-on-netlify` but offers a smoother experience, including:
22+
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/next-on-netlify/blob/main/MIGRATING.md) for assistance migrating to the plugin.
2823

29-
1. one-click, zero-config installation
30-
2. allowing custom functions and publish directories
31-
32-
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.
33-
34-
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.
24+
- Build Plugin [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs)
25+
- [Plugin npm package](https://www.npmjs.com/package/@netlify/plugin-nextjs)
3526

36-
The plugin can be found on [npm here](https://www.npmjs.com/package/@netlify/plugin-nextjs).
3727

3828
## Table of Contents
3929

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /