Skip to content

Commit

Permalink
docs: improve migration guide for running db migrations
Browse files Browse the repository at this point in the history
  • Loading branch information
denolfe committed Nov 20, 2024
1 parent 568e1a2 commit ff0386f
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions docs/migration-guide/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,14 @@ For more details, see the [Documentation](https://payloadcms.com/docs/getting-st
pnpm remove express nodemon @payloadcms/bundler-webpack @payloadcms/bundler-vite
```

1. For Payload Cloud users, the plugin has changed.
1. Database Adapter Migrations

_If you have existing data_ and are using the MongoDB or Postgres adapters, you will need to run the database migrations to ensure your database schema is up-to-date.

- [postgres](https://github.com/payloadcms/payload/releases/tag/v3.0.0-beta.39)
- [mongodb](https://github.com/payloadcms/payload/releases/tag/v3.0.0-beta.131)

2. For Payload Cloud users, the plugin has changed.

Uninstall the old package:

Expand Down Expand Up @@ -94,7 +101,7 @@ For more details, see the [Documentation](https://payloadcms.com/docs/getting-st
})
```
1. **Optional** sharp dependency
3. **Optional** sharp dependency
If you have upload enabled collections that use `formatOptions`, `imageSizes`, or `resizeOptions`—payload expects to have `sharp` installed. In 2.0 this was a dependency was installed for you. Now it is only installed if needed. If you have any of these options set, you will need to install `sharp` and add it to your payload.config.ts:
Expand All @@ -111,10 +118,6 @@ For more details, see the [Documentation](https://payloadcms.com/docs/getting-st
})
```
1. Database Adapter Migrations
If you have existing data and are using the MongoDB or Postgres adapters, you will need to run the database migrations to ensure your database schema is up-to-date. Follow the instructions from the release notes for [postgres](https://github.com/payloadcms/payload/releases/tag/v3.0.0-beta.39) or [mongodb](https://github.com/payloadcms/payload/releases/tag/v3.0.0-beta.131) depending on your chosen adapter.
## Breaking Changes
1. Delete the `admin.bundler` property from your Payload Config. Payload no longer bundles the Admin Panel. Instead, we rely directly on Next.js for bundling.
Expand Down Expand Up @@ -979,7 +982,7 @@ export default buildConfig({
- If you have created a custom adapter, the type must now provide a `name` property.
| Service | Package |
| -------------------- |------------------------------------------------------------------------------|
| -------------------- | ---------------------------------------------------------------------------- |
| Vercel Blob | https://github.com/payloadcms/payload/tree/main/packages/storage-vercel-blob |
| AWS S3 | https://github.com/payloadcms/payload/tree/main/packages/storage-s3 |
| Azure | https://github.com/payloadcms/payload/tree/main/packages/storage-azure |
Expand Down

0 comments on commit ff0386f

Please sign in to comment.