Merge branch 'documentation'

This commit is contained in:
Alexandre Bodin 2020-10-07 14:53:27 +02:00
commit 755d216fbe
4 changed files with 43 additions and 10 deletions

View File

@ -266,8 +266,8 @@ Only select entries matching the publication state provided.
Handled states are:
- `live`: Return only published values (default)
- `preview`: Return both draft & published entries
- `live`: Return only published entries (default)
- `preview`: Return both draft entries & published entries
### Example

View File

@ -1,15 +1,25 @@
# Migrations guides
Please also refer to the following [documentation](../guides/update-version.md) for a better understanding of how to update your project
Please also refer to the following [documentation](../guides/update-version.md) for a better understanding of how to update your project.
## Guides
## Instructions
When upgrading you will need to follow every migration guide between your current version and the one you are upgrading to.
**Example**
If you were upgrading from the `3.0.0-beta.19.5` to `3.2.0`, here are the following guides you would have to follow:
- Migration guide from beta.19.4+ to beta.20.
- Migration guide from beta.20+ to 3.0.0.
- Migration guide from 3.0.x to 3.1.x.
- Migration guide from 3.1.x to 3.2.x.
## V3 guides
- [Migration guide from 3.1.x to 3.2.x](migration-guide-3.1.x-to-3.2.x.md)
- [Migration guide from 3.0.x to 3.1.x](migration-guide-3.0.x-to-3.1.x.md)
## Migrating from Beta ?
Read the [Migration guide from beta.20+ to stable](migration-guide-beta.20-to-3.0.0.md).
## Beta guides
- [Migration guide from beta.15 to beta.16](migration-guide-beta.15-to-beta.16.md)

View File

@ -0,0 +1,23 @@
# Migration guide from 3.1.x to 3.2.x
**Make sure your server is not running until the end of the migration**
:::warning
If you are using **extensions** to create custom code or modifying existing code, you will need to update your code and compare your version to the new changes on the repository.
<br>
Not updating your **extensions** can break your app in unexpected ways that we cannot predict.
:::
## Disclaimer
This version requires some migration in the following cases:
- You are using a `published_at` field in some of your models.
- You followed the [Scheduled publication guide](../guides/scheduled-publication.md) and used a `published_at` field.
Otherwise you can follow the basic [version update guide](../guides/update-version.md).
## Migration
The new **Draft & Publish** feature will add a `published_at` field to your **content types** if you enable the feature.
If you have been using this field name on your **content types** you will need to first rename or delete it before being able to use the feature on those **content types**.

View File

@ -240,8 +240,8 @@ You can also apply different parameters to the query to make more complex querie
Handled states are:
- `LIVE`: Return only published values (default)
- `PREVIEW`: Return both draft & published entries
- `live`: Return only published entries (default)
- `preview`: Return both draft entries & published entries
- `<field>:asc` or `<field>:desc`
- `where` (object): Define the filters to apply in the query.