Skip to content

Commit

Permalink
Merge branch 'main' of github.com:strapi/documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pwizla committed Sep 20, 2024
2 parents 0c670e6 + 70180ac commit 6ea83f6
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can click on the description of any breaking change in the following tables

:::tip Tips
* To view a full list of available codemods, run the `npx @strapi/upgrade codemods ls` command in your terminal.
* To have a deeper look at the code executed by the codemods, head over to the [list of codemods](https://github.com/strapi/strapi/tree/v5/main/packages/utils/upgrade/resources/codemods/5.0.0) in the GitHub repository.
* To have a deeper look at the code executed by the codemods, head over to the [list of codemods](https://github.com/strapi/strapi/tree/develop/packages/utils/upgrade/resources/codemods/5.0.0) in the GitHub repository.
:::

## Database
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ Strapi 5 uses [`react-router-dom`](https://www.npmjs.com/package/react-router-do

### Manual procedure

This breaking change should be handled by a codemod (see the [full list of 5.0.0 codemods](https://github.com/strapi/strapi/tree/v5/main/packages/utils/upgrade/resources/codemods/5.0.0)).
This breaking change should be handled by a codemod (see the [full list of 5.0.0 codemods](https://github.com/strapi/strapi/tree/develop/packages/utils/upgrade/resources/codemods/5.0.0)).
Ensure that links added to [settings](/dev-docs/plugins/admin-panel-api#settings-api) or to the [menu](/dev-docs/plugins/admin-panel-api#menu-api) links using the Admin Panel API use relative paths.
24 changes: 12 additions & 12 deletions docusaurus/docs/dev-docs/migration/v4-to-v5/step-by-step.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,18 +57,18 @@ Strapi provides a tool to automate some parts of the upgrade to Strapi 5: the [u

| Codemod name and GitHub code link | Description |
|-----------------------------------|-------------|
| [comment-out-lifecycle-files](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/comment-out-lifecycle-files.code.ts) | Comment out lifecycles files in favor of [Document Service Middlewares](/dev-docs/migration/v4-to-v5/breaking-changes/lifecycle-hooks-document-service) |
| [dependency-remove-strapi-plugin-i18n](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/dependency-remove-strapi-plugin-i18n.json.ts) | Remove the i18n plugin dependency as i18n is now integrated into the core of Strapi |
| [dependency-upgrade-react-and-react-dom](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/dependency-upgrade-react-and-react-dom.json.ts) | Upgrade the react and react-dom dependencies |
| [dependency-upgrade-react-router-dom](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/dependency-upgrade-react-router-dom.json.ts) | Upgrade the react-router-dom dependency |
| [dependency-upgrade-styled-components](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/dependency-upgrade-styled-components.json.ts) | Upgrade the styled-components dependency |
| [deprecate-helper-plugin](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/deprecate-helper-plugin.code.ts) | Partly handle migrations from `@strapi/helper-plugin` |
| [entity-service-document-service](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/entity-service-document-service.code.ts) | Partly handle the migration from the Entity Service API to the new Document Service API |
| [s3-keys-wrapped-in-credentials](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/s3-keys-wrapped-in-credentials.code.ts) | Wrap the `accessKeyId` and `secretAccessKey` properties inside a `credentials` object for users using the `aws-s3` provider |
| [sqlite3-to-better-sqlite3](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/sqlite3-to-better-sqlite3.json.ts) | Update the sqlite dependency to better-sqlite3 |
| [strapi-public-interface](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/strapi-public-interface.code.ts) | Transform `@strapi/strapi` imports to use the new public interface |
| [use-uid-for-config-namespace](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/use-uid-for-config-namespace.code.ts) | Replace string dot format for config get/set/has with uid format for 'plugin' and 'api' namespace where possible |
| [utils-public-interface](https://github.com/strapi/strapi/blob/v5/main/packages/utils/upgrade/resources/codemods/5.0.0/utils-public-interface.code.ts) | Update utils to use the new public interface |
| [comment-out-lifecycle-files](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/comment-out-lifecycle-files.code.ts) | Comment out lifecycles files in favor of [Document Service Middlewares](/dev-docs/migration/v4-to-v5/breaking-changes/lifecycle-hooks-document-service) |
| [dependency-remove-strapi-plugin-i18n](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/dependency-remove-strapi-plugin-i18n.json.ts) | Remove the i18n plugin dependency as i18n is now integrated into the core of Strapi |
| [dependency-upgrade-react-and-react-dom](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/dependency-upgrade-react-and-react-dom.json.ts) | Upgrade the react and react-dom dependencies |
| [dependency-upgrade-react-router-dom](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/dependency-upgrade-react-router-dom.json.ts) | Upgrade the react-router-dom dependency |
| [dependency-upgrade-styled-components](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/dependency-upgrade-styled-components.json.ts) | Upgrade the styled-components dependency |
| [deprecate-helper-plugin](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/deprecate-helper-plugin.code.ts) | Partly handle migrations from `@strapi/helper-plugin` |
| [entity-service-document-service](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/entity-service-document-service.code.ts) | Partly handle the migration from the Entity Service API to the new Document Service API |
| [s3-keys-wrapped-in-credentials](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/s3-keys-wrapped-in-credentials.code.ts) | Wrap the `accessKeyId` and `secretAccessKey` properties inside a `credentials` object for users using the `aws-s3` provider |
| [sqlite3-to-better-sqlite3](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/sqlite3-to-better-sqlite3.json.ts) | Update the sqlite dependency to better-sqlite3 |
| [strapi-public-interface](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/strapi-public-interface.code.ts) | Transform `@strapi/strapi` imports to use the new public interface |
| [use-uid-for-config-namespace](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/use-uid-for-config-namespace.code.ts) | Replace string dot format for config get/set/has with uid format for 'plugin' and 'api' namespace where possible |
| [utils-public-interface](https://github.com/strapi/strapi/blob/develop/packages/utils/upgrade/resources/codemods/5.0.0/utils-public-interface.code.ts) | Update utils to use the new public interface |

:::tip
If you develop Strapi plugins, other codemods handle some aspects of the helper-plugin deprecation. See the [related breaking change](/dev-docs/migration/v4-to-v5/breaking-changes/helper-plugin-deprecated) for more information.
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/dev-docs/plugins/admin-panel-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -740,6 +740,6 @@ interface LayoutSettings extends Contracts.ContentTypes.Settings {
```

:::note
`EditViewLayout` and `ListViewLayout` are parts of the `useDocumentLayout` hook (see [source code](https://github.com/strapi/strapi/blob/v5/main/packages/core/admin/admin/src/content-manager/hooks/useDocumentLayout.ts)).
`EditViewLayout` and `ListViewLayout` are parts of the `useDocumentLayout` hook (see [source code](https://github.com/strapi/strapi/blob/develop/packages/core/admin/admin/src/content-manager/hooks/useDocumentLayout.ts)).
:::

2 changes: 1 addition & 1 deletion docusaurus/docs/dev-docs/plugins/content-manager-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ interface EditViewContext {
```

:::tip
More information about types and APIs can be found in [Strapi's codebase, in the `/admin/src/content-manager.ts` file](https://github.com/strapi/strapi/blob/v5/main/packages/core/content-manager/admin/src/content-manager.ts).
More information about types and APIs can be found in [Strapi's codebase, in the `/admin/src/content-manager.ts` file](https://github.com/strapi/strapi/blob/develop/packages/core/content-manager/admin/src/content-manager.ts).
:::

**Example:**
Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/dev-docs/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The following table lists all the possible ways to define which template to use:

| Syntax | Description |
|--------|-------------|
| `--template website` | Using one of the [Strapi-maintained templates](https://github.com/strapi/strapi/tree/v5/main/templates) calling it by its (folder) name. |
| `--template website` | Using one of the [Strapi-maintained templates](https://github.com/strapi/strapi/tree/develop/templates) calling it by its (folder) name. |
| `--template strapi/strapi` | Using the template's GitHub repository shorthand.<br/>This will use the default repository branch. |
| `--template strapi/strapi/some/sub/path` | Using the template's GitHub repository shorthand and specifying a subpath.<br/>This will use the default repository branch. |
| `--template strapi/strapi`<br/>`--template-branch=xxx`<br/>`--template-path=some/sub/path` | The most verbose way, explicitly defining a template branch and a subpath. |
Expand All @@ -56,4 +56,4 @@ The following table lists all the possible ways to define which template to use:

Creating a Strapi 5 template is as simple as creating a Strapi application. Create the application (see [CLI installation](/dev-docs/installation/cli)) and the generated folder containing your Strapi 5 application can serve as a template. You can then pass it to the `--template` flag when creating a new Strapi 5 application to use it as a template.

An example of what a template could look like is the [Strapi-maintained `website` template](https://github.com/strapi/strapi/tree/v5/main/templates/website).
An example of what a template could look like is the [Strapi-maintained `website` template](https://github.com/strapi/strapi/tree/develop/templates/website).

0 comments on commit 6ea83f6

Please sign in to comment.