Skip to content

Commit

Permalink
"runtime" -> "adapter"
Browse files Browse the repository at this point in the history
  • Loading branch information
seancdavis committed Oct 23, 2024
1 parent 8dc5596 commit 20052a8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion pages/netlify/forms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To prevent silent failures of form detection or submission, we now trigger an in

This failure is triggered when both of the following conditions are met:

- The runtime has found usage of `netlify` or `data-netlify` form attributes in your React code (which have no effect).
- The adapter has found usage of `netlify` or `data-netlify` form attributes in your React code (which have no effect).
- No static HTML file was found in your `public` directory having form attributes (thus marking that you’ve implemented the approach laid out above).

### Skip the check
Expand Down
28 changes: 14 additions & 14 deletions pages/netlify/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ import { Callout } from "nextra/components";
width="185"
height="25"
style={{ borderRadius: 0, marginTop: "1rem" }}
alt="Netlify Next.js runtime v5 test status"
alt="Netlify Next.js adapter v5 test status"
/>
</a>

Netlify's Next.js runtime automatically configures Netlify sites with key functionality, including cache control, on-demand revalidation, and image optimization.
Netlify's Next.js adapter automatically configures Netlify sites with key functionality, including cache control, on-demand revalidation, and image optimization.

The runtime provisions serverless and edge functions as appropriate to handle your site’s server-side functionality (such as SSR, ISR and PPR pages, API endpoints, Server Actions, Edge Middleware, etc.), ensuring that functionality works out-of-the-box.
The adapter provisions serverless and edge functions as appropriate to handle your site’s server-side functionality (such as SSR, ISR and PPR pages, API endpoints, Server Actions, Edge Middleware, etc.), ensuring that functionality works out-of-the-box.

We automatically verify compatibility with the latest stable version of Next.js, using the comprehensive end-to-end tests of the framework itself. To access up-to-date test results, use the badge above.

Expand All @@ -35,21 +35,21 @@ The easiest way to get started is to deploy our Next.js platform starter templat

- **App Router:** Netlify fully supports the Next.js App Router, which supports more powerful nested layouts and React’s latest features, such as Server Components and Streaming.

- **Automatic fine-grained caching:** Next.js Runtime v5 uses fine-grained caching on Netlify to support the Next.js Full Route Cache and Data Cache. This means that static page responses are automatically cached at the edge and can be revalidated by path or by tag.
- **Automatic fine-grained caching:** thehe adapter uses fine-grained caching on Netlify to support the Next.js Full Route Cache and Data Cache. This means that static page responses are automatically cached at the edge and can be revalidated by path or by tag.

- **On-demand and time-based revalidation:** Both the App Router and Pages Router support on-demand and time-based revalidation, allowing you to revalidate and regenerate content at any time after a deploy.
- **On-demand and time-based revalidation:** both the App Router and Pages Router support on-demand and time-based revalidation, allowing you to revalidate and regenerate content at any time after a deploy.

- **Image optimization:** The `next/image` component uses [Netlify Image CDN](https://docs.netlify.com/image-cdn/overview/) by default to ensure your images are optimized and served in the most efficient format.
- **Image optimization:** the `next/image` component uses [Netlify Image CDN](https://docs.netlify.com/image-cdn/overview/) by default to ensure your images are optimized and served in the most efficient format.

Note that while we also generally support experimental features (for example, Partial Prerendering) from their early stages, such features are not considered stable yet at the framework level.

## Automatic runtime detection
## Automatic framework detection

Netlify automatically detects that you're using Next.js and provisions your site with the most up-to-date runtime.
Netlify automatically detects that you're using Next.js and provisions your site with the most up-to-date adapter.

### Pin a specific runtime version
### Pin a specific adapter version

To pin the Netlify Next.js runtime to a specific version, read [the Netlify docs](https://docs.netlify.com/frameworks/next-js/overview/).
To pin the Netlify Next.js adapter to a specific version, read [the Netlify docs](https://docs.netlify.com/frameworks/next-js/overview/).

### Suggested configuration values

Expand All @@ -63,13 +63,13 @@ For manual configuration, check out the [typical build settings](https://docs.ne

## Limitations

Currently, Netlify's Next.js runtime has the following limitations:
Currently, Netlify's Next.js adapter has the following limitations:

- **SSR pages set to the `edge` runtime will run in your [functions region](https://docs.netlify.com/functions/optional-configuration/#region).** If edge-level performance is critical, we advise that you use static pages with edge functions instead. They are rendered at the origin, but are then cached at the edge and can be revalidated on demand.

- **Rewrites in your Next.js configuration can’t point to static files in the `public` directory.** If you create `beforeFiles` rewrites in your `next.config.js`, they can’t point to static files in your site’s `public` directory. You can use middleware rewrites as an alternative.

- **Netlify Forms compatibility:** Using Netlify Forms with the current runtime [requires a workaround](/netlify/forms).
- **Netlify Forms compatibility:** Using Netlify Forms with the current adapter [requires a workaround](/netlify/forms).

### pnpm support

Expand All @@ -86,9 +86,9 @@ Learn more about using [pnpm on Netlify](https://docs.netlify.com/configure-buil

## Troubleshooting

The OpenNext docs are specifically about using Netlify's Next.js runtime v5.8 and later. For older versions of the runtime, refer to the [Netlify docs](https://docs.netlify.com/frameworks/next-js/overview/).
The OpenNext docs are specifically about using Netlify's Next.js adapter v5.9 and later. For older versions of the adapter, refer to the [Netlify docs](https://docs.netlify.com/frameworks/next-js/overview/).
If you need help with any version of the runtime, visit [our support page](https://www.netlify.com/support) for various methods of finding answers and getting help.
If you need help with any version of the adapter, visit [our support page](https://www.netlify.com/support) for various methods of finding answers and getting help.
### More resources
Expand Down

0 comments on commit 20052a8

Please sign in to comment.