It is automatically converted to slug format (`my-strapi-app`). | | Git branch | Choose from the drop-down the default branch to use for this deployment. This uses the default branch of the repository. | | Deploy on push | Check the box to automatically deploy the latest changes from the selected branch. When disabled, you will need to manually deploy the latest changes. | - | Region | Choose the geographic location of the servers where your Strapi application is hosted. Selected region can either be New York in North America (default) or Amsterdam in Europe. | + | Region | Choose the geographic location of the servers where your Strapi application is hosted. Selected region can either be New York in North America (default), Amsterdam in Europe, Singapore in Asia or Sydney in Oceania. | :::note The Git branch and "Deploy on push" settings can be modified afterwards through the project's setting, however the project name and hosting region setting can only be chosen during the creation of the project (see [Project Settings](/cloud/projects/settings)). diff --git a/docusaurus/docs/cloud/getting-started/usage-billing.md b/docusaurus/docs/cloud/getting-started/usage-billing.md index aa9570ec00..a54e775455 100644 --- a/docusaurus/docs/cloud/getting-started/usage-billing.md +++ b/docusaurus/docs/cloud/getting-started/usage-billing.md @@ -19,7 +19,7 @@ Strapi Cloud offers a free 14 days trial for all new accounts, and 3 paid plans: | Feature | Free Trial | Developer | Pro | Team | | --- | --- | --- | --- | --- | -| **Seats** | 10 (up to 10 extra) | 1 (up to 3 extra) | 5 (up to 20 extra) | 10 (up to 50 extra) | +| **Seats** | 10 | 1 (up to 2 extra) | 5 (up to 15 extra) | 10 (up to 40 extra) | | **Database Entries** | 1,000 | 1,000 | 100,000 | 1,000,000 | | **Assets Storage** | 5GB | 15GB | 150GB | 500GB | | **Assets Bandwidth** | 50GB | 50GB per month | 500GB per month | 1,000GB per month | diff --git a/docusaurus/docs/cloud/projects/runtime-logs.md b/docusaurus/docs/cloud/projects/runtime-logs.md index e4cb2fd759..f4b3cc43e9 100644 --- a/docusaurus/docs/cloud/projects/runtime-logs.md +++ b/docusaurus/docs/cloud/projects/runtime-logs.md @@ -9,8 +9,6 @@ tags: - Strapi Cloud --- -import NotV5 from '/docs/snippets/_not-updated-to-v5.md' - # Runtime logs From a chosen project's dashboard, the *Runtime logs* tab displays the live logs of the project. diff --git a/docusaurus/docs/cloud/projects/settings.md b/docusaurus/docs/cloud/projects/settings.md index 47b7b202ab..ee62126627 100644 --- a/docusaurus/docs/cloud/projects/settings.md +++ b/docusaurus/docs/cloud/projects/settings.md @@ -23,13 +23,13 @@ The settings' menu on the left side of the interface is separated into 2 categor ## Project-level settings There are 5 tabs available for the project's settings: --  [*General (project)*](#general), +-  [*General*](#general), -  [*Environments*](#environments), -  [*Billing & Usage*](#billing--usage), -  [Plans](#plans), - and  [Invoices](#invoices). -### General (project) +### General The  *General* tab for the project-level settings enables you to check and update the following options for the project: @@ -74,7 +74,7 @@ Updating the git repository could result in the loss of the project and its data | Auto-deploy | Tick the box to automatically trigger a new deployment whenever a new commit is pushed to the selected branch. Untick it to disable the option. | 5. Click on the **Update repository** button at the bottom of the *Update repository* interface. -6. In the *Manage repository* dialog, confirm your changes by clicking on the **Relink repository** button. +6. In the *Update repository* dialog, confirm your changes by clicking on the **Confirm** button. #### Deleting Strapi Cloud project @@ -125,7 +125,11 @@ The  *Billing & Usage* Through this tab, you also have the possibility to: - click the **Change** button to be redirected to the  *Plans* tab, where you can change you subscription plan ([see related documentation](#plans)), -- click the **Edit** button to be redirected to the  *Billing* tab of your profile page, where you can edit the payment method (see [related documentation](/cloud/account/account-billing)). +- click the **Edit** button in order to set a new payment method (see [related documentation](/cloud/account/account-billing)). + +:::note +You can attach a dedicated card to your project by choosing the payment method directly from this page. In that way, you can manage your subscriptions with different cards. +::: :::tip In the Usage section of the  *Billing & Usage* tab, you can see the current monthly usage of your project compared to the maximum usage allowed by your project's subscription. Use the arrows in the top right corner to see the project's usage for any chosen month. @@ -235,20 +239,20 @@ In the *Profile > Invoices* tab, you will find the complete list of invoices for In the project's environments' settings, you first need to select the environment whose settings you would like to configure, using the dropdown. Depending on the chosen environment, there are 3 to 4 tabs available: --  [*General (environment)*](#general), +-  [*Configuration*](#configuration), -  [*Backups*](#backups), which are only available for the production environment, -  [*Domains*](#domains), - and  [*Variables*](#variables). -### General (environment) +### Configuration -The  *General* tab for the environment-level settings enables you to check and update the following options for the project: +The  *Configuration* tab for the environment-level settings enables you to check and update the following options for the project: - *Basic information*, to see: - the name of your Strapi Cloud project's environment. The environment name is set when it is created and cannot be modified afterwards. - the Node version of the environment: to change the Node version of the project (see [Modifying Node version](#modifying-node-version)). - the app's internal name for the environment, which can be useful for debug & support purposes. -- *Connect branch*: to change the branch of the GitHub repository used for your environment (see [Editing Git branch](#editing-git-branch)). Also allows to enable/disable the "deploy on push" option. +- *Connected branch*: to change the branch of the GitHub repository used for your environment (see [Editing Git branch](#editing-git-branch)). Also allows to enable/disable the "deploy on push" option. - *Danger zone*: to reset or permanently delete your Strapi Cloud project's environment (see [Resetting & Deleting environment](#resetting--deleting-environment)).
+
+
+
+
+ +
- -
-
-
-
-
-
+
+
+
+
-
-
-
-
-
+
+
+
+
-
-
-
-
-
+
+
+
+
-
-
-
-
## Population
The REST API by default does not populate any type of fields, so it will not populate relations, media fields, components, or dynamic zones unless you pass a `populate` parameter to populate various field types.
@@ -175,6 +174,32 @@ The population and pagination operators cannot be combined.
+
+
+
+
+
-
-
-
diff --git a/docusaurus/docs/dev-docs/api/rest/relations.md b/docusaurus/docs/dev-docs/api/rest/relations.md
index 9136fbb09a..3f96dd08c6 100644
--- a/docusaurus/docs/dev-docs/api/rest/relations.md
+++ b/docusaurus/docs/dev-docs/api/rest/relations.md
@@ -10,8 +10,6 @@ tags:
- REST API
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
-
# Managing relations with API requests
Defining relations between content-types (that are designated as entities in the database layers) is connecting entities with each other.
diff --git a/docusaurus/docs/dev-docs/api/rest/sort-pagination.md b/docusaurus/docs/dev-docs/api/rest/sort-pagination.md
index 55f2e986f6..82d385a543 100644
--- a/docusaurus/docs/dev-docs/api/rest/sort-pagination.md
+++ b/docusaurus/docs/dev-docs/api/rest/sort-pagination.md
@@ -18,7 +18,6 @@ tags:
import QsIntroFull from '/docs/snippets/qs-intro-full.md'
import QsForQueryTitle from '/docs/snippets/qs-for-query-title.md'
import QsForQueryBody from '/docs/snippets/qs-for-query-body.md'
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
# REST API: Sort & Pagination
@@ -42,17 +41,11 @@ The sorting order can be defined with:
- `:asc` for ascending order (default order, can be omitted)
- or `:desc` for descending order.
-
+
+
+
+
+ +
- -
-
-
-
-
-Accepts the following values:
- `sqlite` for SQLite databases
- `postgres` for PostgreSQL databases
- `mysql` for MySQL databases
Knex.Config Function (experimental)` | - | | `debug` | Show database exchanges and errors. | `Boolean` | `false` | | `useNullAsDefault`
_Optional, only for SQLite_ | Use `NULL` as a default value | `Boolean` | `true` | | `pool`
_Optional_ | [Database pooling options](#database-pooling-options) | `Object` | - | @@ -98,10 +98,15 @@ When using Docker, change the pool `min` value to `0` as Docker will kill any id The `settings` object found in `./config/database.js` (or `./config/database.ts` for TypeScript) is used to configure Strapi-specific database settings and accepts the following parameters: -| Parameter | Description | Type | Default | -| ---------------- | --------------------------------------------------------------- | --------- | ------- | -| `forceMigration` | Enable or disable the forced database migration. | `Boolean` | `true` | -| `runMigrations` | Enable or disable database migrations from running on start up. | `Boolean` | `true` | +| Parameter | Description | Type | Default | +| ---------------- | --------------------------------------------------------------- | --------- | ------- | +| `forceMigration` | Enable or disable the forced database migration. | `Boolean` | `true` | +| `runMigrations` | Enable or disable database migrations from running on start up. | `Boolean` | `true` | +| `useTypescriptMigrations` | Look for migrations in the build dir instead of the src dir | `Boolean` | `false` | + +:::note +When using `useTypescriptMigrations` you can continue to use existing JavaScript migrations by setting `compilerOptions { allowJs: true }` in your tsconfig file. +::: diff --git a/docusaurus/docs/dev-docs/configurations/environment.md b/docusaurus/docs/dev-docs/configurations/environment.md index 4e4a958aab..23dcfd0954 100644 --- a/docusaurus/docs/dev-docs/configurations/environment.md +++ b/docusaurus/docs/dev-docs/configurations/environment.md @@ -8,12 +8,8 @@ tags: - environment --- -import NotV5 from '/docs/snippets/_not-updated-to-v5.md' - # Environment configuration and variables -
Enabled by default in if `NODE_ENV` is set to `development`. | Boolean | `false` | | `shadowCRUD` | Whether type definitions for queries, mutations and resolvers based on models should be created automatically (see [Shadow CRUD documentation](/dev-docs/plugins/graphql#shadow-crud)). | Boolean | `true` | -| `v4ComptabilityMode` | Enables the retro-compatibility with the Strapi v4 format (see more details in the [breaking change entry](/dev-docs/migration/v4-to-v5/breaking-changes/graphql-api-updated) | Boolean | `false` | +| `v4CompatibilityMode` | Enables the retro-compatibility with the Strapi v4 format (see more details in the [breaking change entry](/dev-docs/migration/v4-to-v5/breaking-changes/graphql-api-updated) | Boolean | `false` | **Example custom configuration**: diff --git a/docusaurus/docs/dev-docs/configurations/server.md b/docusaurus/docs/dev-docs/configurations/server.md index bc9e3425cf..59394424af 100644 --- a/docusaurus/docs/dev-docs/configurations/server.md +++ b/docusaurus/docs/dev-docs/configurations/server.md @@ -12,12 +12,8 @@ tags: - port --- -import NotV5 from '/docs/snippets/\_not-updated-to-v5.md' - # Server configuration -
+
+
+### Redirect URL/URI
+
+The redirect URL/URI will be dependent on your provider configuration however in most cases should combine your application's public URL and the provider's callback URL. The example below shows how to combine the public URL with the provider's callback URL.
+
+```js
+callbackURL:
+ env('PUBLIC_URL', "https://api.example.com") +
+ strapi.admin.services.passport.getStrategyCallbackURL("TODO"),
+```
+
+In this example the redirect URL/URI used by the provider will be `https://api.example.com/admin/connect/TODO`.
+
+This is broken down as follows:
+
+- `https://api.example.com` is the public URL of your Strapi application
+- `/admin/connect` is the general path for SSO callbacks in Strapi
+- `/TODO` is the specific provider UID for TODO
+
+## Strapi Configuration
+
+Using: // TODO
+
+### Install the Provider Package
+
+Configuration Example with Logging
+ +```js +// TODO +``` + +
+
+
+### Redirect URL/URI
+
+The redirect URL/URI will be dependent on your provider configuration however in most cases should combine your application's public URL and the provider's callback URL. The example below shows how to combine the public URL with the provider's callback URL.
+
+```js
+callbackURL:
+ env('PUBLIC_URL', "https://api.example.com") +
+ strapi.admin.services.passport.getStrategyCallbackURL("discord"),
+```
+
+In this example the redirect URL/URI used by the provider will be `https://api.example.com/admin/connect/discord`.
+
+This is broken down as follows:
+
+- `https://api.example.com` is the public URL of your Strapi application
+- `/admin/connect` is the general path for SSO callbacks in Strapi
+- `/discord` is the specific provider UID for Discord
+
+## Strapi Configuration
+
+Using: [passport-discord](https://github.com/nicholastay/passport-discord)
+
+### Install the Provider Package
+
+Configuration Example with Logging
+ +```js +(accessToken, refreshToken, profile, done) => { + // See what is returned by the provider + console.log(profile); + + done(null, { + email: profile.email, + username: `${profile.username}`, + }); +} +``` + +
+
+
+### Redirect URL/URI
+
+The redirect URL/URI will be dependent on your provider configuration however in most cases should combine your application's public URL and the provider's callback URL. The example below shows how to combine the public URL with the provider's callback URL.
+
+```js
+callbackURL:
+ env('PUBLIC_URL', "https://api.example.com") +
+ strapi.admin.services.passport.getStrategyCallbackURL("azure_ad_oauth2"),
+```
+
+In this example the redirect URL/URI used by the provider will be `https://api.example.com/admin/connect/azure_ad_oauth2`.
+
+This is broken down as follows:
+
+- `https://api.example.com` is the public URL of your Strapi application
+- `/admin/connect` is the general path for SSO callbacks in Strapi
+- `/azure_ad_oauth2` is the specific provider UID for Mircosoft Entra ID / Azure Active Directory
+
+## Strapi Configuration
+
+Using: [passport-azure-ad-oauth2](https://github.com/auth0/passport-azure-ad-oauth2#readme)
+
+### Install the Provider Package
+
+Configuration Example with Logging
+ +```js +(accessToken, refreshToken, params, profile, done) => { + let waadProfile = jwt.decode(params.id_token, "", true); + + // See what is returned by the provider + console.log(waadProfile); + + done(null, { + email: waadProfile.email, + username: waadProfile.email, + firstname: waadProfile.given_name, // optional if email and username exist + lastname: waadProfile.family_name, // optional if email and username exist + }); +} +``` + +
+
+
+### Redirect URL/URI
+
+The redirect URL/URI will be dependent on your provider configuration however in most cases should combine your application's public URL and the provider's callback URL. The example below shows how to combine the public URL with the provider's callback URL.
+
+```js
+callbackURL:
+ env('PUBLIC_URL', "https://api.example.com") +
+ strapi.admin.services.passport.getStrategyCallbackURL("github"),
+```
+
+In this example the redirect URL/URI used by the provider will be `https://api.example.com/admin/connect/github`.
+
+This is broken down as follows:
+
+- `https://api.example.com` is the public URL of your Strapi application
+- `/admin/connect` is the general path for SSO callbacks in Strapi
+- `/github` is the specific provider UID for GitHub
+
+## Strapi Configuration
+
+Using: [passport-github](https://github.com/cfsghost/passport-github)
+
+### Install the Provider Package
+
+Configuration Example with Logging
+ +```js +(request, accessToken, refreshToken, profile, done) => { + // See what is returned by the provider + console.log(profile); + + done(null, { + // Map the data returned by the provider to the Strapi user object + email: profile.emails[0].value, + username: profile.username, + }); +} +``` + +
+
+
+### Redirect URL/URI
+
+The redirect URL/URI will be dependent on your provider configuration however in most cases should combine your application's public URL and the provider's callback URL. The example below shows how to combine the public URL with the provider's callback URL.
+
+```js
+callbackURL:
+ env('PUBLIC_URL', "https://api.example.com") +
+ strapi.admin.services.passport.getStrategyCallbackURL("TODO"),
+```
+
+In this example the redirect URL/URI used by the provider will be `https://api.example.com/admin/connect/TODO`.
+
+This is broken down as follows:
+
+- `https://api.example.com` is the public URL of your Strapi application
+- `/admin/connect` is the general path for SSO callbacks in Strapi
+- `/TODO` is the specific provider UID for TODO
+
+## Strapi Configuration
+
+Using: // TODO
+
+### Install the Provider Package
+
+Configuration Example with Logging
+ +```js +// TODO +``` + +
+
+
+### Redirect URL/URI
+
+The redirect URL/URI will be dependent on your provider configuration however in most cases should combine your application's public URL and the provider's callback URL. The example below shows how to combine the public URL with the provider's callback URL.
+
+```js
+callbackURL:
+ env('PUBLIC_URL', "https://api.example.com") +
+ strapi.admin.services.passport.getStrategyCallbackURL("google"),
+```
+
+In this example the redirect URL/URI used by the provider will be `https://api.example.com/admin/connect/google`.
+
+This is broken down as follows:
+
+- `https://api.example.com` is the public URL of your Strapi application
+- `/admin/connect` is the general path for SSO callbacks in Strapi
+- `/google` is the specific provider UID for Google
+
+## Strapi Configuration
+
+Using: [passport-google-oauth2](https://github.com/mstade/passport-google-oauth2)
+
+### Install the Provider Package
+
+Configuration Example with Logging
+ +```js +(request, accessToken, refreshToken, profile, done) => { + // See what is returned by the provider + console.log(profile); + + done(null, { + // Map the data returned by the provider to the Strapi user object + email: profile.email, + firstname: profile.given_name, + lastname: profile.family_name, + }); +} +``` + +
+
+
+### Redirect URL/URI
+
+The redirect URL/URI will be dependent on your provider configuration however in most cases should combine your application's public URL and the provider's callback URL. The example below shows how to combine the public URL with the provider's callback URL.
+
+```js
+callbackURL:
+ env('PUBLIC_URL', "https://api.example.com") +
+ strapi.admin.services.passport.getStrategyCallbackURL("TODO"),
+```
+
+In this example the redirect URL/URI used by the provider will be `https://api.example.com/admin/connect/TODO`.
+
+This is broken down as follows:
+
+- `https://api.example.com` is the public URL of your Strapi application
+- `/admin/connect` is the general path for SSO callbacks in Strapi
+- `/TODO` is the specific provider UID for TODO
+
+## Strapi Configuration
+
+Using: // TODO
+
+### Install the Provider Package
+
+Configuration Example with Logging
+ +```js +// TODO +``` + +
+
+
+### Redirect URL/URI
+
+The redirect URL/URI will be dependent on your provider configuration however in most cases should combine your application's public URL and the provider's callback URL. The example below shows how to combine the public URL with the provider's callback URL.
+
+```js
+callbackURL:
+ env('PUBLIC_URL', "https://api.example.com") +
+ strapi.admin.services.passport.getStrategyCallbackURL("okta"),
+```
+
+In this example the redirect URL/URI used by the provider will be `https://api.example.com/admin/connect/okta`.
+
+This is broken down as follows:
+
+- `https://api.example.com` is the public URL of your Strapi application
+- `/admin/connect` is the general path for SSO callbacks in Strapi
+- `/okta` is the specific provider UID for Okta
+
+## Strapi Configuration
+
+Using: [passport-okta-oauth20](https://github.com/antoinejaussoin/passport-okta-oauth20/#readme)
+
+### Install the Provider Package
+
+Configuration Example with Logging
+ +```js +(accessToken, refreshToken, profile, done) => { + // See what is returned by the provider + console.log(profile); + + done(null, { + email: profile.email, + username: profile.username, + }); +} +``` + +
-
-
-
-```jsx title="./config/middlewares.js"
-module.exports = [
- // ...
- {
- name: 'strapi::security',
- config: {
- contentSecurityPolicy: {
- useDefaults: true,
- directives: {
- 'connect-src': ["'self'", 'https:'],
- 'img-src': [
- "'self'",
- 'data:',
- 'blob:',
- 'dl.airtable.com',
- 'www.okta.com', // Base URL of the provider's logo
- ],
- 'media-src': [
- "'self'",
- 'data:',
- 'blob:',
- 'dl.airtable.com',
- 'www.okta.com', // Base URL of the provider's logo
- ],
- upgradeInsecureRequests: null,
- },
- },
- },
- },
- // ...
-]
-```
-
-
-
-
-
-```ts title="./config/middlewares.ts"
-export default [
- // ...
- {
- name: 'strapi::security',
- config: {
- contentSecurityPolicy: {
- useDefaults: true,
- directives: {
- 'connect-src': ["'self'", 'https:'],
- 'img-src': [
- "'self'",
- 'data:',
- 'blob:',
- 'dl.airtable.com',
- 'www.okta.com', // Base URL of the provider's logo
- ],
- 'media-src': [
- "'self'",
- 'data:',
- 'blob:',
- 'dl.airtable.com',
- 'www.okta.com', // Base URL of the provider's logo
- ],
- upgradeInsecureRequests: null,
- },
- },
- },
- },
- // ...
-]
-```
-
-
-
-
-
-
-:::note
-When deploying the admin panel to a different location or on a different subdomain, an additional configuration is required to set the common domain for the cookies. This is required to ensure the cookies are shared across the domains.
-:::
-
-:::caution
-Deploying the admin and backend on entirely different unrelated domains is not possible at this time when using SSO.
-:::
-
-Example: Security exception for provider logos
- -
-
-
-
-```jsx title="./config/admin.js"
-module.exports = ({ env }) => ({
- auth: {
- domain: env("ADMIN_SSO_DOMAIN", ".test.example.com"),
- providers: [
- // ...
- ],
- },
- url: env("ADMIN_URL", "http://admin.test.example.com"),
- // ...
-});
-```
-
-
-
-
-
-```ts title="./config/admin.ts"
-export default ({ env }) => ({
- auth: {
- domain: env("ADMIN_SSO_DOMAIN", ".test.example.com"),
- providers: [
- // ...
- ],
- },
- url: env("ADMIN_URL", "http://admin.test.example.com"),
- // ...
-});
-```
-
-
-
-
-
-
### The `createStrategy` Factory
A passport strategy is usually built by instantiating it using 2 parameters: the configuration object, and the verify function.
@@ -257,6 +128,10 @@ Adding a new provider means adding a new way for your administrators to log-in.
Strapi uses [Passport.js](http://www.passportjs.org/), which enables a large selection of providers. Any valid passport strategy that doesn't need additional custom data should therefore work with Strapi.
+:::caution
+Strategies are required to have their own "login page" where the user can enter their credentials. If the strategy doesn't have one, it won't work with Strapi's SSO.
+:::
+
:::caution
Strategies such as [ldapauth](https://github.com/vesse/passport-ldapauth) don't work out of the box since they require extra data to be sent from the admin panel.
If you want to add an LDAP provider to your application, you will need to write a [custom strategy](http://www.passportjs.org/packages/passport-custom/).
@@ -270,739 +145,25 @@ To configure a provider, follow the procedure below:
1. Make sure to import your strategy in your admin configuration file, either from an installed package or a local file.
2. You'll need to add a new item to the `auth.providers` array in your admin panel configuration that will match the [format given above](#setting-up-provider-configuration)
3. Restart your application, the provider should appear on your admin login page.
-
### Provider configuration examples
-#### Google
-
-Using: [passport-google-oauth2](https://github.com/mstade/passport-google-oauth2)
-
-Example: Setting custom cookie domain
- -
-
-
-#### Github
-
-Using: [passport-github](https://github.com/cfsghost/passport-github)
-
-Configuration example for Google:
-
-
-
-
-
-
-
-
-
-```js title="./config/admin.js"
-
-const GoogleStrategy = require("passport-google-oauth2");
-
-module.exports = ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "google",
- displayName: "Google",
- icon: "https://cdn2.iconfinder.com/data/icons/social-icons-33/128/Google-512.png",
- createStrategy: (strapi) =>
- new GoogleStrategy(
- {
- clientID: env("GOOGLE_CLIENT_ID"),
- clientSecret: env("GOOGLE_CLIENT_SECRET"),
- scope: [
- "https://www.googleapis.com/auth/userinfo.email",
- "https://www.googleapis.com/auth/userinfo.profile",
- ],
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL("google"),
- },
- (request, accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.email,
- firstname: profile.given_name,
- lastname: profile.family_name,
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
-```ts title="./config/admin.ts"
-
-import {Strategy as GoogleStrategy } from "passport-google-oauth2";
-
-export default ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "google",
- displayName: "Google",
- icon: "https://cdn2.iconfinder.com/data/icons/social-icons-33/128/Google-512.png",
- createStrategy: (strapi) =>
- new GoogleStrategy(
- {
- clientID: env("GOOGLE_CLIENT_ID"),
- clientSecret: env("GOOGLE_CLIENT_SECRET"),
- scope: [
- "https://www.googleapis.com/auth/userinfo.email",
- "https://www.googleapis.com/auth/userinfo.profile",
- ],
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL("google"),
- },
- (request, accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.email,
- firstname: profile.given_name,
- lastname: profile.family_name,
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
-
--
-
-
-
-#### Discord
-
-Using: [passport-discord](https://github.com/nicholastay/passport-discord#readme)
-
-Configuration example for Github:
-
-
-
-
-
-
-
-
-```js title="./config/admin.js"
-
-const GithubStrategy = require("passport-github2");
-
-module.exports = ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "github",
- displayName: "Github",
- icon: "https://cdn1.iconfinder.com/data/icons/logotypes/32/github-512.png",
- createStrategy: (strapi) =>
- new GithubStrategy(
- {
- clientID: env("GITHUB_CLIENT_ID"),
- clientSecret: env("GITHUB_CLIENT_SECRET"),
- scope: ["user:email"],
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL("github"),
- },
- (accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.emails[0].value,
- username: profile.username,
- });
- }
- ),
- },
- ],
- },
-});
-
-```
-
-
-
-
-
-```ts title="./config/admin.ts"
-
-import { Strategy as GithubStrategy } from "passport-github2";
-
-export default ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "github",
- displayName: "Github",
- icon: "https://cdn1.iconfinder.com/data/icons/logotypes/32/github-512.png",
- createStrategy: (strapi) =>
- new GithubStrategy(
- {
- clientID: env("GITHUB_CLIENT_ID"),
- clientSecret: env("GITHUB_CLIENT_SECRET"),
- scope: ["user:email"],
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL("github"),
- },
- (accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.emails[0].value,
- username: profile.username,
- });
- }
- ),
- },
- ],
- },
-});
-
-```
-
-
-
-
-
- -
- Configuration example for Discord:
-
-
-
-#### Microsoft
-
-Using: [passport-azure-ad-oauth2](https://github.com/auth0/passport-azure-ad-oauth2#readme)
-
-Configuration example for Discord:
-
-
-
-
-
-
-
-
-
-```jsx title="./config/admin.js"
-
-const DiscordStrategy = require("passport-discord");
-
-module.exports = ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "discord",
- displayName: "Discord",
- icon: "https://cdn0.iconfinder.com/data/icons/free-social-media-set/24/discord-512.png",
- createStrategy: (strapi) =>
- new DiscordStrategy(
- {
- clientID: env("DISCORD_CLIENT_ID"),
- clientSecret: env("DISCORD_SECRET"),
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL(
- "discord"
- ),
- scope: ["identify", "email"],
- },
- (accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.email,
- username: `${profile.username}#${profile.discriminator}`,
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
-```ts title="./config/admin.ts"
-
-import { Strategy as DiscordStrategy } from "passport-discord";
-
-
-export default ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "discord",
- displayName: "Discord",
- icon: "https://cdn0.iconfinder.com/data/icons/free-social-media-set/24/discord-512.png",
- createStrategy: (strapi) =>
- new DiscordStrategy(
- {
- clientID: env("DISCORD_CLIENT_ID"),
- clientSecret: env("DISCORD_SECRET"),
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL(
- "discord"
- ),
- scope: ["identify", "email"],
- },
- (accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.email,
- username: `${profile.username}#${profile.discriminator}`,
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
- -
-
-
-#### Keycloak (OpenID Connect)
-
-Using: [passport-keycloak-oauth2-oidc](https://www.npmjs.com/package/passport-keycloak-oauth2-oidc)
-
-Configuration example for Microsoft:
-
-
-
-
-
-
-
-
-```js title="./config/admin.js"
-
-const AzureAdOAuth2Strategy = require("passport-azure-ad-oauth2");
-const jwt = require("jsonwebtoken");
-
-module.exports = ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "azure_ad_oauth2",
- displayName: "Microsoft",
- icon: "https://upload.wikimedia.org/wikipedia/commons/thumb/9/96/Microsoft_logo_%282012%29.svg/320px-Microsoft_logo_%282012%29.svg.png",
- createStrategy: (strapi) =>
- new AzureAdOAuth2Strategy(
- {
- clientID: env("MICROSOFT_CLIENT_ID", ""),
- clientSecret: env("MICROSOFT_CLIENT_SECRET", ""),
- scope: ["user:email"],
- tenant: env("MICROSOFT_TENANT_ID", ""),
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL(
- "azure_ad_oauth2"
- ),
- },
- (accessToken, refreshToken, params, profile, done) => {
- let waadProfile = jwt.decode(params.id_token, "", true);
- done(null, {
- email: waadProfile.email,
- username: waadProfile.email,
- firstname: waadProfile.given_name, // optional if email and username exist
- lastname: waadProfile.family_name, // optional if email and username exist
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
-```ts title="./config/admin.ts"
-
-import { Strategy as AzureAdOAuth2Strategy} from "passport-azure-ad-oauth2";
-import jwt from "jsonwebtoken";
-
-export default ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "azure_ad_oauth2",
- displayName: "Microsoft",
- icon: "https://upload.wikimedia.org/wikipedia/commons/thumb/9/96/Microsoft_logo_%282012%29.svg/320px-Microsoft_logo_%282012%29.svg.png",
- createStrategy: (strapi) =>
- new AzureAdOAuth2Strategy(
- {
- clientID: env("MICROSOFT_CLIENT_ID", ""),
- clientSecret: env("MICROSOFT_CLIENT_SECRET", ""),
- scope: ["user:email"],
- tenant: env("MICROSOFT_TENANT_ID", ""),
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL(
- "azure_ad_oauth2"
- ),
- },
- (accessToken, refreshToken, params, profile, done) => {
- let waadProfile = jwt.decode(params.id_token, "", true);
- done(null, {
- email: waadProfile.email,
- username: waadProfile.email,
- firstname: waadProfile.given_name, // optional if email and username exist
- lastname: waadProfile.family_name, // optional if email and username exist
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
- -
-
-
-#### Okta
-
-Using: [passport-okta-oauth20](https://github.com/antoinejaussoin/passport-okta-oauth20/#readme)
-
-Configuration example for Keycloak (OpenID Connect):
-
-
-
-
-
-
-
-
-```js title="./config/admin.js"
-
-const KeyCloakStrategy = require("passport-keycloak-oauth2-oidc");
-
-module.exports = ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "keycloak",
- displayName: "Keycloak",
- icon: "https://raw.githubusercontent.com/keycloak/keycloak-admin-ui/main/themes/keycloak/logo.svg",
- createStrategy: (strapi) =>
- new KeyCloakStrategy(
- {
- clientID: env("KEYCLOAK_CLIENT_ID", ""),
- realm: env("KEYCLOAK_REALM", ""),
- publicClient: env.bool("KEYCLOAK_PUBLIC_CLIENT", false),
- clientSecret: env("KEYCLOAK_CLIENT_SECRET", ""),
- sslRequired: env("KEYCLOAK_SSL_REQUIRED", "external"),
- authServerURL: env("KEYCLOAK_AUTH_SERVER_URL", ""),
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL(
- "keycloak"
- ),
- },
- (accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.email,
- username: profile.username,
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
-```ts title="./config/admin.ts"
-
-import { Strategy as KeyCloakStrategy } from "passport-keycloak-oauth2-oidc";
-
-export default ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "keycloak",
- displayName: "Keycloak",
- icon: "https://raw.githubusercontent.com/keycloak/keycloak-admin-ui/main/themes/keycloak/logo.svg",
- createStrategy: (strapi) =>
- new KeyCloakStrategy(
- {
- clientID: env("KEYCLOAK_CLIENT_ID", ""),
- realm: env("KEYCLOAK_REALM", ""),
- publicClient: env.bool("KEYCLOAK_PUBLIC_CLIENT", false),
- clientSecret: env("KEYCLOAK_CLIENT_SECRET", ""),
- sslRequired: env("KEYCLOAK_SSL_REQUIRED", "external"),
- authServerURL: env("KEYCLOAK_AUTH_SERVER_URL", ""),
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL(
- "keycloak"
- ),
- },
- (accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.email,
- username: profile.username,
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
- -
-
+| Provider | Package | Configuration |
+|--------------------|----------------------------|----------------------------------------------------------------------------|
+| Auth0 | `passport-auth0` | [Auth0 configuration](/dev-docs/configurations/sso-providers/auth0) |
+| Discord | `passport-discord` | [Discord configuration](/dev-docs/configurations/sso-providers/discord) |
+| Microsoft Entra ID | `passport-azure-ad-oauth2` | [Microsoft configuration](/dev-docs/configurations/sso-providers/entra-id) |
+| GitHub | `passport-github` | [GitHub configuration](/dev-docs/configurations/sso-providers/github) |
+| Gitlab | `passport-gitlab2` | [Gitlab configuration](/dev-docs/configurations/sso-providers/gitlab) |
+| Google | `passport-google-oauth20` | [Google configuration](/dev-docs/configurations/sso-providers/google) |
+| Keycloak | `passport-keycloak-oauth2` | [Keycloak configuration](/dev-docs/configurations/sso-providers/keycloak) |
+| Okta | `passport-okta-oauth20` | [Okta configuration](/dev-docs/configurations/sso-providers/okta) |
+
+
## Performing advanced customization
-### Admin panel URL
-
-If the administration panel lives on a host/port different from the Strapi server, the admin panel URL needs to be updated:
-update the `url` key in the `./config/admin.js` configuration file (see [admin panel customization documentation](/dev-docs/admin-panel-customization#access-url)).
-
### Custom Logic
In some scenarios, you will want to write additional logic for your connection workflow such as:
diff --git a/docusaurus/docs/dev-docs/configurations/typescript.md b/docusaurus/docs/dev-docs/configurations/typescript.md
index 6d92fe89b6..11a29450b6 100644
--- a/docusaurus/docs/dev-docs/configurations/typescript.md
+++ b/docusaurus/docs/dev-docs/configurations/typescript.md
@@ -10,12 +10,8 @@ tags:
- typescript
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
-
# TypeScript configuration
-Configuration example for Okta:
-
-
-
-
-
-
-
-
-```js title="./config/admin.js"
-
-const OktaOAuth2Strategy = require("passport-okta-oauth20").Strategy;
-
-module.exports = ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "okta",
- displayName: "Okta",
- icon: "https://www.okta.com/sites/default/files/Okta_Logo_BrightBlue_Medium-thumbnail.png",
- createStrategy: (strapi) =>
- new OktaOAuth2Strategy(
- {
- clientID: env("OKTA_CLIENT_ID"),
- clientSecret: env("OKTA_CLIENT_SECRET"),
- audience: env("OKTA_DOMAIN"),
- scope: ["openid", "email", "profile"],
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL("okta"),
- },
- (accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.email,
- username: profile.username,
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
-```ts title="./config/admin.ts"
-
-import { Strategy as OktaOAuth2Strategy } from "passport-okta-oauth20";
-
-export default ({ env }) => ({
- auth: {
- // ...
- providers: [
- {
- uid: "okta",
- displayName: "Okta",
- icon: "https://www.okta.com/sites/default/files/Okta_Logo_BrightBlue_Medium-thumbnail.png",
- createStrategy: (strapi) =>
- new OktaOAuth2Strategy(
- {
- clientID: env("OKTA_CLIENT_ID"),
- clientSecret: env("OKTA_CLIENT_SECRET"),
- audience: env("OKTA_DOMAIN"),
- scope: ["openid", "email", "profile"],
- callbackURL:
- strapi.admin.services.passport.getStrategyCallbackURL("okta"),
- },
- (accessToken, refreshToken, profile, done) => {
- done(null, {
- email: profile.email,
- username: profile.username,
- });
- }
- ),
- },
- ],
- },
-});
-```
-
-
-
-
-
- -
- Removed `uploadFile` `uploadFiles` mutations
- Removed `updateFileInfo` mutation in favor of using the `updateUploadFile` mutation
- Removed `removeFile` mutation in favor of using the `deleteUploadFile` mutation
- Removed `folder` queries & mutations
- Removed `createUploadFile` mutation
- Removed `upload` `multipleUpload` mutations
- Removed `updateFileInfo` mutation in favor of using the `updateUploadFile` mutation
- Removed `removeFile` mutation in favor of using the `deleteUploadFile` mutation
- Removed `folder` queries & mutations
- Removed `createUploadFile` mutation
- Simplified the basic queries with no `meta`/`pagination`
- Introduced `Connection` to add pagination
As a Strapi Cloud customer, how can I handle the entire upgrade and deployment of my Strapi 5 application?
-:::danger Warning: Don't push a Strapi 5 project to Strapi Cloud yet -Strapi Cloud is still running on Strapi v4. The following process is provided as an indication of what will happen when Strapi 5 is released as a stable version. Do not try to push your Strapi 5 beta or Release Candidate (RC) project to Strapi Cloud yet. -::: - 1. [Create a backup](/cloud/projects/settings#backups) and update your code locally, following the step-by-step guide. 2. Run the `yarn deploy` or `npm run deploy` commands from the [Cloud CLI](/cloud/cli/cloud-cli).diff --git a/docusaurus/docs/dev-docs/migration/v4-to-v5/step-by-step.md b/docusaurus/docs/dev-docs/migration/v4-to-v5/step-by-step.md index ecadd9f863..385264abfe 100644 --- a/docusaurus/docs/dev-docs/migration/v4-to-v5/step-by-step.md +++ b/docusaurus/docs/dev-docs/migration/v4-to-v5/step-by-step.md @@ -14,7 +14,7 @@ const summaryStyle = {fontSize: '18px'} # Step-by-step guide to upgrade to Strapi 5 -The latest major version of Strapi is Strapi 5, which is currently provided as a Release Candidate (RC) version, not as a stable version yet. +The latest major version of Strapi is Strapi 5. The present page is meant to be used as step-by-step instructions for upgrading your Strapi v4 application to Strapi 5. @@ -116,7 +116,7 @@ Follow the steps below and leverage retro-compatibility flags and guided migrati ### Migrate GraphQL API calls -1. Enable the retro-compatibility flag by setting `v4ComptabilityMode` to `true` in the `graphl.config` object of [the `/config/plugins.js|ts` file](/dev-docs/configurations/plugins#graphql). +1. Enable the retro-compatibility flag by setting `v4CompatibilityMode` to `true` in the `graphl.config` object of [the `/config/plugins.js|ts` file](/dev-docs/configurations/plugins#graphql). 2. Update your queries and mutations only, guided by the dedicated [breaking change entry for GraphQL](/dev-docs/migration/v4-to-v5/breaking-changes/graphql-api-updated). 3. Validate that your client is running correctly. -4. Disable the retro-compatibily flag by setting `v4ComptabilityMode` to `true` and start using the new response format. +4. Disable the retro-compatibily flag by setting `v4CompatibilityMode` to `false` and start using the new response format. diff --git a/docusaurus/docs/dev-docs/plugins-extension.md b/docusaurus/docs/dev-docs/plugins-extension.md index 391a679d1b..c1e9fe81c3 100644 --- a/docusaurus/docs/dev-docs/plugins-extension.md +++ b/docusaurus/docs/dev-docs/plugins-extension.md @@ -12,12 +12,8 @@ tags: - services --- -import NotV5 from '/docs/snippets/_not-updated-to-v5.md' - # Plugins extension -
- Eg: 60, "45m", "10h", "2 days", "7d", "2y". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (minutes, hours, days, years, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms"). + Eg: 60, "45m", "10h", "2 days", "7d", "2y". A numeric value is interpreted as a seconds count. If you need more advanced examples please see the [ms package](https://github.com/vercel/ms).
+
## 🚀 Part A: Create a new project with Strapi
We will first create a new Strapi project on your machine by running a command in the terminal, and then register our first local administrator user.
-Follow the steps below by clicking on the togglable content to read more instructions.
-
-☑️ Prerequisites:
+
+
+
+
diff --git a/docusaurus/docs/dev-docs/typescript/development/guides/documents-and-entries.md b/docusaurus/docs/dev-docs/typescript/development/guides/documents-and-entries.md
new file mode 100644
index 0000000000..ec288d7b2f
--- /dev/null
+++ b/docusaurus/docs/dev-docs/typescript/development/guides/documents-and-entries.md
@@ -0,0 +1,214 @@
+---
+title: TypeScript - Manipulating Documents and Entries
+sidebar_label: Manipulating Documents and Entries
+description: TypeScript guide to get started with manipulating documents and entries
+tags:
+ - typescript
+ - guides
+ - data
+ - document
+ - component
+ - uid
+ - entries
+---
+
+# Manipulating documents and entries
+
+This guide will explore TypeScript patterns for manipulating documents and entries in a Strapi v5 application, including how to leverage Strapi's `UID` and `Data` namespaces to interact with both generic and known entity types safely. If you're working on a TypeScript-based Strapi project, mastering these approaches will help you take full advantage of type safety and code completion, ensuring robust, error-free interactions with your application’s content and components.
+
+:::prerequisites
+
+- **Strapi Application:** A Strapi v5 application. If you don't have one, follow the [documentation](/dev-docs/quick-start) to get started.
+- **TypeScript:** Ensure TypeScript is set up in your Strapi project. You can follow Strapi's [official guide](/dev-docs/typescript#getting-started-with-typescript-in-strapi) on configuring TypeScript.
+- **Generated Types:** Application types [have been generated](/dev-docs/typescript/development#generate-typings-for-content-types-schemas) and are accessible.
+ :::
+
+## Type Imports
+
+The `UID` namespace contains literal unions representing the available resources in the application.
+
+```typescript
+import type { UID } from '@strapi/strapi';
+```
+
+- `UID.ContentType` represents a union of every content-type identifier in the application
+- `UID.Component` represents a union of every component identifier in the application
+- `UID.Schema` represents a union of every schema (content-type or component) identifier in the application
+- And others...
+
+---
+
+Strapi provides a `Data` namespace containing several built-in types for entity representation.
+
+```typescript
+import type { Data } from '@strapi/strapi';
+```
+
+- `Data.ContentType` represents a Strapi document object
+- `Data.Component` represents a Strapi component object
+- `Data.Entity` represents either a document or a component
+
+:::tip
+Both the entities' type definitions and UIDs are based on the generated schema types for your application.
+
+In case of a mismatch or error, you can always [regenerate the types](/dev-docs/typescript/development#generate-typings-for-content-types-schemas).
+:::
+
+## Usage
+
+### Generic entities
+
+When dealing with generic data, it is recommended to use non-parametrized forms of the `Data` types.
+
+#### Generic documents
+
+```typescript
+async function save(name: string, document: Data.ContentType) {
+ await writeCSV(name, document);
+ // ^ {
+ // id: Data.ID;
+ // documentId: string;
+ // createdAt?: DateTimeValue;
+ // updatedAt?: DateTimeValue;
+ // publishedAt?: DateTimeValue;
+ // ...
+ // }
+}
+```
+
+:::warning
+In the preceding example, the resolved properties for `document` are those common to every content-type.
+
+Other properties have to be checked manually using type guards.
+
+```typescript
+if ('my_prop' in document) {
+ return document.my_prop;
+}
+```
+
+:::
+
+#### Generic components
+
+```typescript
+function renderComponent(parent: Node, component: Data.Component) {
+ const elements: Element[] = [];
+ const properties = Object.entries(component);
+
+ for (const [name, value] of properties) {
+ // ^ ^
+ // string any
+ const paragraph = document.createElement('p');
+
+ paragraph.textContent = `Key: ${name}, Value: ${value}`;
+
+ elements.push(paragraph);
+ }
+
+ parent.append(...elements);
+}
+```
+
+### Known entities
+
+When manipulating known entities, it is possible to parametrize `Data` types for better type safety and code completion.
+
+#### Known documents
+
+```typescript
+const ALL_CATEGORIES = ['food', 'tech', 'travel'];
+
+function validateArticle(article: Data.ContentType<'api::article.article'>) {
+ const { title, category } = article;
+ // ^? ^?
+ // string Data.ContentType<'api::category.category'>
+
+ if (title.length < 5) {
+ throw new Error('Title too short');
+ }
+
+ if (!ALL_CATEGORIES.includes(category.name)) {
+ throw new Error(`Unknown category ${category.name}`);
+ }
+}
+```
+
+#### Known components
+
+```typescript
+function processUsageMetrics(
+ id: string,
+ metrics: Data.Component<'app.metrics'>
+) {
+ telemetry.send(id, { clicks: metrics.clicks, views: metrics.views });
+}
+```
+
+### Advanced use cases
+
+#### Entities subsets
+
+Using the types' second parameter (`TKeys`), it is possible to obtain a subset of an entity.
+
+```typescript
+type Credentials = Data.ContentType<'api::acount.acount', 'email' | 'password'>;
+// ^? { email: string; password: string }
+```
+
+```typescript
+type UsageMetrics = Data.Component<'app.metrics', 'clicks' | 'views'>;
+// ^? { clicks: number; views: number }
+```
+
+#### Type argument inference
+
+It is possible to bind and restrict an entity type based on other function parameters.
+
+In the following example, the `uid` type is inferred upon usage as `T` and used as a type parameter for the `document`.
+
+```typescript
+import type { UID } from '@strapi/strapi';
+
+function display(
+ uid: T,
+ document: Data.ContentType
+) {
+ switch (uid) {
+ case 'api::article.article': {
+ return document.title;
+ // ^? string
+ // ^? Data.ContentType<'api::article.article'>
+ }
+ case 'api::category.category': {
+ return document.name;
+ // ^? string
+ // ^? Data.ContentType<'api::category.category'>
+ }
+ case 'api::account.account': {
+ return document.email;
+ // ^? string
+ // ^? Data.ContentType<'api::account.account'>
+ }
+ default: {
+ throw new Error(`unknown content-type uid: "${uid}"`);
+ }
+ }
+}
+```
+
+When calling the function, the `document` type needs to match the given `uid`.
+
+```typescript
+declare const article: Data.Document<'api::article.article'>;
+declare const category: Data.Document<'api::category.category'>;
+declare const account: Data.Document<'api::account.account'>;
+
+display('api::article.article', article);
+display('api::category.category', category);
+display('api::account.account', account);
+// ^ ✅
+
+display('api::article.article', category);
+// ^ Error: "category" is not assignable to parameter of type ContentType<'api::article.article'>
+```
diff --git a/docusaurus/docs/dev-docs/upgrade-tool.md b/docusaurus/docs/dev-docs/upgrade-tool.md
index 75a84ae743..1026b24bae 100644
--- a/docusaurus/docs/dev-docs/upgrade-tool.md
+++ b/docusaurus/docs/dev-docs/upgrade-tool.md
@@ -55,20 +55,25 @@ Strapi version numbers respect the [semantic versioning](https://semver.org/) co
- The second number is the **minor** version number.
- The third number is the **patch** version number.
-The upgrade tool allows upgrading to a major, minor, or patch version.
+The upgrade tool allows upgrading to a `major`, `minor`, or `patch` version.
-What the upgrade tool does depends on the latest existing version and the command you run.
+Alternatively, you can choose to upgrade to the `latest` available version.
-For instance, if the latest Strapi v4 version is v4.25.9:
+What the upgrade tool does depends on three things:
-| My Strapi application is currently on… | If I run… | My Strapi application will be upgraded to … |
-|----------------------------------------|-----------------------------|--------------------------------------------------------------------------------------------|
-| v4.25.1 | `npx @strapi/upgrade patch` | v4.25.9
(because v4.25.9 is the latest patch version for the v4.25 minor version) | -| v4.14.1 | `npx @strapi/upgrade minor` | v4.25.9 | -| v4.14.1 | `npx @strapi/upgrade major` | Nothing.
I first need to run `npx @strapi/upgrade minor` to upgrade to v4.25.9. | -| v4.25.9 | `npx @strapi/upgrade major` | v5.0.0 | +- the project Strapi version +- the latest available version of Strapi +- the command you run. +For instance, if the latest Strapi v4 version is v4.25.9, and the latest Strapi v5 version is v5.1.2: +| My Strapi application is currently on… | If I run… | My Strapi application will be upgraded to … | +|----------------------------------------|------------------------------|-------------------------------------------------------------------------------------------------| +| v4.25.1 | `npx @strapi/upgrade patch` | v4.25.9
(because v4.25.9 is the latest patch version for the v4.25 minor version) | +| v4.14.1 | `npx @strapi/upgrade minor` | v4.25.9 | +| v4.14.1 | `npx @strapi/upgrade major` | Nothing.
I first need to run `npx @strapi/upgrade minor` to upgrade to v4.25.9. | +| v4.25.9 | `npx @strapi/upgrade major` | v5.1.2 | +| v4.14.1 | `npx @strapi/upgrade latest` | v5.1.2
A confirmation prompt appears to make sure the major version bump is intended. | ## Upgrade to a new version @@ -78,21 +83,23 @@ Before running the upgrade process, make sure you've created a backup of your co ### Upgrade to a major version -Run the upgrade tool with the `major` parameter to upgrade the project to the next major version of Strapi: +Run the upgrade tool with the `major` parameter to upgrade the project to the latest release of the next major Strapi version: ```bash npx @strapi/upgrade major ``` -During the upgrade process, the application dependencies are updated and installed, and the related codemods are executed. +During the upgrade process, the application dependencies are updated and installed, and the related codemods are executed (if any). :::note -If your application is not already running the latest minor and patch version in the current major, the `major` upgrade is prevented, and you will first need to upgrade to the latest [minor.patch](#upgrade-to-a-minor-version) version in the current major version. This means that moving from v4.14.4 to v5.0.0 is a 2-step process because the latest v4 version is v4.16.2. +If your application is not already running the latest minor and patch version in the current major, the `major` upgrade is prevented, and you will first need to upgrade to the latest [minor.patch](#upgrade-to-a-minor-version) version in the current major version. + +This means that moving from v4.14.4 to v5.0.0 is a 2-step process because the latest v4 version is v4.16.2. ::: ### Upgrade to a minor version -Run the upgrade tool with the `minor` parameter to upgrade the project to the latest minor and patch version of Strapi: +Run the upgrade tool with the `minor` parameter to upgrade the project to the latest minor and patch version of Strapi for the current major: ```bash npx @strapi/upgrade minor @@ -110,6 +117,23 @@ npx @strapi/upgrade patch During the upgrade process, the project dependencies are updated and installed, and the related codemods are executed (if any). +### Upgrade to the latest version + +Run the upgrade tool with the `latest` parameter to upgrade the project to the latest available version regardless of the current Strapi version: + +```bash +npx @strapi/upgrade latest +``` + +During the upgrade process, the project dependencies are updated and installed, and the related codemods are executed (if any). + +:::note +If a `major` version upgrade is detected, the upgrade tool displays a confirmation prompt to make sure the change is +intended. + +In the scenario where the major bump isn't the desired option, see [the minor upgrade](#upgrade-to-a-minor-version). +::: + ## Run codemods only Run the upgrade tool with the `codemods` parameter to execute a utility that allows selecting the codemods to be executed. With this command, only the codemods are run, the dependencies are not updated nor installed. @@ -136,20 +160,20 @@ npx @strapi/upgrade codemods run 5.0.0-strapi-codemod-uid The `npx @strapi/upgrade [major|minor|patch]` commands can accept the following options: -| Option | Description | Default | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------|----------| -| [`-n, --dry`](#simulate-the-upgrade-without-updating-any-files-dry-run) | [Simulate](#simulate-the-upgrade-without-updating-any-files-dry-run) the upgrade without updating any files | false | -| [`-d, --debug`](#get-detailed-debugging-information) | Get [more logs](#get-detailed-debugging-information) in debug mode | false | -| [`-s, --silent`](#execute-the-upgrade-silently) | [Don't log anything](#execute-the-upgrade-silently) | false | -| [`-p, --project-path`](#select-a-path-for-the-strapi-application-folder) | [Path](#select-a-path-for-the-strapi-application-folder) to the Strapi project | - |
-| [`-y, --yes`](#answer-yes-to-every-prompt) | Automatically [answer "yes"](#answer-yes-to-every-prompt) to every prompt | false |
+| Option | Description | Default |
+|-----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------|
+| [`-n, --dry`](#simulate-the-upgrade-without-updating-any-files-dry-run) | [Simulate](#simulate-the-upgrade-without-updating-any-files-dry-run) the upgrade without updating any files | false |
+| [`-d, --debug`](#get-detailed-debugging-information) | Get [more logs](#get-detailed-debugging-information) in debug mode | false |
+| [`-s, --silent`](#execute-the-upgrade-silently) | [Don't log anything](#execute-the-upgrade-silently) | false |
+| [`-p, --project-path `](#select-a-path-for-the-strapi-application-folder) | [Path](#select-a-path-for-the-strapi-application-folder) to the Strapi project | - |
+| [`-y, --yes`](#answer-yes-to-every-prompt) | Automatically [answer "yes"](#answer-yes-to-every-prompt) to every prompt | false |
-The following options can be run either with the `npx @strapi/upgrade` command alone or with the `npx @strapi/upgrade [major|minor|patch]` commands:
+The following options can be run either with the `npx @strapi/upgrade` command alone or with the `npx @strapi/upgrade [major|minor|patch|latest]` commands:
-| Option | Description |
-| ------------------------------------------------------------------------ | ---------------------------------------------------------------- |
-| [`-V, --version`](#get-the-current-version) | Output the [version number](#get-the-current-version) |
-| [`-h, --help`](#get-help) | [Print](#get-help) command line options |
+| Option | Description |
+|---------------------------------------------|-------------------------------------------------------|
+| [`-V, --version`](#get-the-current-version) | Output the [version number](#get-the-current-version) |
+| [`-h, --help`](#get-help) | [Print](#get-help) command line options |
### Simulate the upgrade without updating any files (dry run)
@@ -161,6 +185,7 @@ Examples:
npx @strapi/upgrade major --dry
npx @strapi/upgrade minor --dry
npx @strapi/upgrade patch --dry
+npx @strapi/upgrade latest --dry
```
### Select a path for the Strapi application folder
@@ -226,9 +251,10 @@ Options:
-h, --help Print command line options
Commands:
- major [options] Upgrade to the next available major version of Strapi
+ major [options] Upgrade to ...
minor [options] Upgrade to ...
patch [options] Upgrade to ...
+ latest [options] Upgrade to ...
help [command] Print options for a specific command
```
diff --git a/docusaurus/docs/release-notes.md b/docusaurus/docs/release-notes.md
index 570ab20254..0b2e4c47b3 100644
--- a/docusaurus/docs/release-notes.md
+++ b/docusaurus/docs/release-notes.md
@@ -18,13 +18,272 @@ Since Strapi Docs version 5.0.0, the **docs' version number is independent from
Strapi Docs now follow the **[semantic versioning](https://semver.org/)** philosophy, but adapted to docs:
- **Major version** (6.0.0, 7.0.0…): A **significant rewrite** of the docs (content or framework). This may impact the user experience, redesign the site, or break old links (redirections are handled, but broken links can be [reported](https://github.com/strapi/documentation/issues/new/choose)).
-- **Minor version** (5.1.0, 5.2.0…): **New Strapi features or improvements** to the docs (e.g., new components or tools).
+- **Minor version** (5.1.0, 5.2.0…): **New Strapi features** or improvements to the docs (e.g., new components or tools).
- **Patch version** (5.1.1, 5.1.2…): **Content updates**, including improvement or extension of existing pages, code examples fixes, and typos.
New versions (minor or patch) are generally released weekly, on Wednesdays.
+## 5.2.1
+
+### 🖌 Updated content
+
+- [Add `strapi cloud environment link` to Cloud CLI](https://github.com/strapi/documentation/pull/2282)
+- [Add new Cloud regions](https://github.com/strapi/documentation/pull/2290)
+
+### 🧹 Chore, fixes, typos, and other improvements
+
+#### Dev Docs
+- [Add useTypescriptMigrations](https://github.com/strapi/documentation/pull/2283)
+- [Fix typo in retro-compatibility flag value](https://github.com/strapi/documentation/pull/2294)
+- [Fix typo in example code for injectComponent in Admin Panel API docs ](https://github.com/strapi/documentation/pull/2287)
+- [Fix outdated mention of Gold plan in SSO docs](https://github.com/strapi/documentation/pull/2286)
+- [Fix locale param. example in Interactive Query Builder](https://github.com/strapi/documentation/pull/2285)
+- [Fix discardDraft() Document Service API example](https://github.com/strapi/documentation/pull/2284)
+
+#### Strapi Cloud
+- [Update credit cards handling](https://github.com/strapi/documentation/pull/2262)
+
+#### Repository
+- [Add release notes script](https://github.com/strapi/documentation/pull/2289)
+
+***
+This release was made possible thanks to the following contributors. Thank you! 🫶
+
+
+
+ + +## 5.2.0 + +### ✨ New content + +#### Dev Docs + +- [Add WIP API Reference and Guides for TypeScript](https://github.com/strapi/documentation/pull/2266) + +### 🖌 Updated content + +#### Dev Docs + +- [Add Knex Config function support](https://github.com/strapi/documentation/pull/2252) + +#### User Guide + +- [Integration between the Releases and Review Workflows features](https://github.com/strapi/documentation/pull/2273) + +### 🧹 Chore, fixes, typos, and other improvement + +#### Cloud + +- [Minor Cloud Docs changes](https://github.com/strapi/documentation/pull/2264) +- [Remove Strapi 5 warning for Cloud in FAQ](https://github.com/strapi/documentation/pull/2272) +- [Move custom cloud provider config warnings higher](https://github.com/strapi/documentation/pull/2278) + +#### Dev Docs + +- [Fix example request for update method in Document Service API](https://github.com/strapi/documentation/pull/2275) + +#### Repo + +- [Align navbar search box with 100% width](https://github.com/strapi/documentation/pull/2280) + +*** + +This release was made possible thanks to the following contributors. Thank you! 🫶 + + + +
+
+ +## 5.1.3 + +### 🧹 Chore, fixes, typos, and other improvements + +- [Improve instructions for upgrading to Apollo v4](https://github.com/strapi/documentation/pull/2271) +- [Fix code example in breaking change for new response format](https://github.com/strapi/documentation/pull/2270) +- [Update names of removed mutations in GraphQL breaking change](https://github.com/strapi/documentation/pull/2269) +- [Fix typo in a snippet used in Cloud docs](https://github.com/strapi/documentation/pull/2268) + +*** + +This release was made possible thanks to the following contributors. Thank you! 🫶 + + + +
+
+ +## 5.1.2 + +### 🖌 Updated content + +#### Dev Docs + +- [Add support for 'latest' parameter in the upgrade tool](https://github.com/strapi/documentation/pull/2259) +- [Add example code and resulting screenshot for theme extension](https://github.com/strapi/documentation/pull/2261) + +### 🧹 Chore, fixes, typos, and other improvements + +#### Strapi Cloud + +- [Update cloud deployment logs screen](https://github.com/strapi/documentation/pull/2263) +- [Update confirmation modal text in Cloud Update Repository](https://github.com/strapi/documentation/pull/2258) + +#### Repository + +- [Restore bigger font-size for categories title in sidebar](https://github.com/strapi/documentation/pull/2260) + +*** + +This release was made possible thanks to the following contributors. Thank you! 🫶 + + + +
+
+ +## 5.1.1 + +### 🖌 Updated content + +#### Strapi Cloud + +* [List environments with Cloud CLI](https://github.com/strapi/documentation/pull/2239) + +#### Dev Docs + +* [`publicationAt` breaking change](https://github.com/strapi/documentation/pull/2249) + +### 🧹 Chore, fixes, typos, and other improvements + +#### Strapi Cloud + +* [Update wording on purchasable extra Seats](https://github.com/strapi/documentation/pull/2238) + +#### Dev Docs + +* [Clarify sorting for relational fields in the Content Manager list view](https://github.com/strapi/documentation/pull/2224) +* [Fix typo for `v4CompatibilityMode` flag](https://github.com/strapi/documentation/pull/2257) +* [Fix step-by-step v4 → v5 migration (v4CompatibilityMode flag)](https://github.com/strapi/documentation/pull/2255) +* [Update environment declaration in Docker guide](https://github.com/strapi/documentation/pull/2253) +* [Fix createStrapi method in TypeScript development documentation](https://github.com/strapi/documentation/pull/2248) +* [Fix links in the REST API documentation](https://github.com/strapi/documentation/pull/2247) +* [Fix CheckPagePermissions code example in helper-plugin deprecation guide](https://github.com/strapi/documentation/pull/2244) +* [Fix typo for init command in Plugin SDK](https://github.com/strapi/documentation/pull/2243) +* [Add link to ms package for examples for JWT expiresIn](https://github.com/strapi/documentation/pull/2242) + +#### Repository + +* [Update LICENSE](https://github.com/strapi/documentation/pull/2251) + + +*** + +This release was made possible thanks to the following contributors. Thank you! 🫶 + + + +
+
+ ## 5.1.0 ### ✨ New content diff --git a/docusaurus/docs/snippets/configuration-sso-admin.md b/docusaurus/docs/snippets/configuration-sso-admin.md new file mode 100644 index 0000000000..b4dd02c499 --- /dev/null +++ b/docusaurus/docs/snippets/configuration-sso-admin.md @@ -0,0 +1,57 @@ +There are some optional configurations that you can set should it be necessary, for more information on available options please see the [Admin Configuration](/dev-docs/configurations/admin-panel) documentation. + +- **`url`**: The public facing URL of your Strapi administration panel. (e.g. `https://admin.example.com`) +- **`auth.domain`**: Setting a custom domain for cookie storage. (e.g. `.example.com`) + +:::note +When deploying the admin panel to a different location or on a different subdomain, an additional configuration is required to set the common domain for the cookies. This is required to ensure the cookies are shared across the domains. +::: + +:::caution +Deploying the admin and backend on entirely different unrelated domains is not possible at this time when using SSO due to restrictions in cross-domain cookies. +::: + +
Step 1: Run the installation script and create a Strapi Cloud account
### Step 1: Run the installation script and create a Strapi Cloud account diff --git a/docusaurus/docs/dev-docs/testing.md b/docusaurus/docs/dev-docs/testing.md index 6476bdad88..434de77916 100644 --- a/docusaurus/docs/dev-docs/testing.md +++ b/docusaurus/docs/dev-docs/testing.md @@ -8,12 +8,8 @@ tags: - environment --- -import NotV5 from '/docs/snippets/_not-updated-to-v5.md' - # Unit testing -(because v4.25.9 is the latest patch version for the v4.25 minor version) | -| v4.14.1 | `npx @strapi/upgrade minor` | v4.25.9 | -| v4.14.1 | `npx @strapi/upgrade major` | Nothing.
I first need to run `npx @strapi/upgrade minor` to upgrade to v4.25.9. | -| v4.25.9 | `npx @strapi/upgrade major` | v5.0.0 | +- the project Strapi version +- the latest available version of Strapi +- the command you run. +For instance, if the latest Strapi v4 version is v4.25.9, and the latest Strapi v5 version is v5.1.2: +| My Strapi application is currently on… | If I run… | My Strapi application will be upgraded to … | +|----------------------------------------|------------------------------|-------------------------------------------------------------------------------------------------| +| v4.25.1 | `npx @strapi/upgrade patch` | v4.25.9
(because v4.25.9 is the latest patch version for the v4.25 minor version) | +| v4.14.1 | `npx @strapi/upgrade minor` | v4.25.9 | +| v4.14.1 | `npx @strapi/upgrade major` | Nothing.
I first need to run `npx @strapi/upgrade minor` to upgrade to v4.25.9. | +| v4.25.9 | `npx @strapi/upgrade major` | v5.1.2 | +| v4.14.1 | `npx @strapi/upgrade latest` | v5.1.2
A confirmation prompt appears to make sure the major version bump is intended. | ## Upgrade to a new version @@ -78,21 +83,23 @@ Before running the upgrade process, make sure you've created a backup of your co ### Upgrade to a major version -Run the upgrade tool with the `major` parameter to upgrade the project to the next major version of Strapi: +Run the upgrade tool with the `major` parameter to upgrade the project to the latest release of the next major Strapi version: ```bash npx @strapi/upgrade major ``` -During the upgrade process, the application dependencies are updated and installed, and the related codemods are executed. +During the upgrade process, the application dependencies are updated and installed, and the related codemods are executed (if any). :::note -If your application is not already running the latest minor and patch version in the current major, the `major` upgrade is prevented, and you will first need to upgrade to the latest [minor.patch](#upgrade-to-a-minor-version) version in the current major version. This means that moving from v4.14.4 to v5.0.0 is a 2-step process because the latest v4 version is v4.16.2. +If your application is not already running the latest minor and patch version in the current major, the `major` upgrade is prevented, and you will first need to upgrade to the latest [minor.patch](#upgrade-to-a-minor-version) version in the current major version. + +This means that moving from v4.14.4 to v5.0.0 is a 2-step process because the latest v4 version is v4.16.2. ::: ### Upgrade to a minor version -Run the upgrade tool with the `minor` parameter to upgrade the project to the latest minor and patch version of Strapi: +Run the upgrade tool with the `minor` parameter to upgrade the project to the latest minor and patch version of Strapi for the current major: ```bash npx @strapi/upgrade minor @@ -110,6 +117,23 @@ npx @strapi/upgrade patch During the upgrade process, the project dependencies are updated and installed, and the related codemods are executed (if any). +### Upgrade to the latest version + +Run the upgrade tool with the `latest` parameter to upgrade the project to the latest available version regardless of the current Strapi version: + +```bash +npx @strapi/upgrade latest +``` + +During the upgrade process, the project dependencies are updated and installed, and the related codemods are executed (if any). + +:::note +If a `major` version upgrade is detected, the upgrade tool displays a confirmation prompt to make sure the change is +intended. + +In the scenario where the major bump isn't the desired option, see [the minor upgrade](#upgrade-to-a-minor-version). +::: + ## Run codemods only Run the upgrade tool with the `codemods` parameter to execute a utility that allows selecting the codemods to be executed. With this command, only the codemods are run, the dependencies are not updated nor installed. @@ -136,20 +160,20 @@ npx @strapi/upgrade codemods run 5.0.0-strapi-codemod-uid The `npx @strapi/upgrade [major|minor|patch]` commands can accept the following options: -| Option | Description | Default | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------|----------| -| [`-n, --dry`](#simulate-the-upgrade-without-updating-any-files-dry-run) | [Simulate](#simulate-the-upgrade-without-updating-any-files-dry-run) the upgrade without updating any files | false | -| [`-d, --debug`](#get-detailed-debugging-information) | Get [more logs](#get-detailed-debugging-information) in debug mode | false | -| [`-s, --silent`](#execute-the-upgrade-silently) | [Don't log anything](#execute-the-upgrade-silently) | false | -| [`-p, --project-path
+
+
+
+
+
+
++
+ + +## 5.2.0 + +### ✨ New content + +#### Dev Docs + +- [Add WIP API Reference and Guides for TypeScript](https://github.com/strapi/documentation/pull/2266) + +### 🖌 Updated content + +#### Dev Docs + +- [Add Knex Config function support](https://github.com/strapi/documentation/pull/2252) + +#### User Guide + +- [Integration between the Releases and Review Workflows features](https://github.com/strapi/documentation/pull/2273) + +### 🧹 Chore, fixes, typos, and other improvement + +#### Cloud + +- [Minor Cloud Docs changes](https://github.com/strapi/documentation/pull/2264) +- [Remove Strapi 5 warning for Cloud in FAQ](https://github.com/strapi/documentation/pull/2272) +- [Move custom cloud provider config warnings higher](https://github.com/strapi/documentation/pull/2278) + +#### Dev Docs + +- [Fix example request for update method in Document Service API](https://github.com/strapi/documentation/pull/2275) + +#### Repo + +- [Align navbar search box with 100% width](https://github.com/strapi/documentation/pull/2280) + +*** + +This release was made possible thanks to the following contributors. Thank you! 🫶 + + + +
+
+
+
+
+
++
+ +## 5.1.3 + +### 🧹 Chore, fixes, typos, and other improvements + +- [Improve instructions for upgrading to Apollo v4](https://github.com/strapi/documentation/pull/2271) +- [Fix code example in breaking change for new response format](https://github.com/strapi/documentation/pull/2270) +- [Update names of removed mutations in GraphQL breaking change](https://github.com/strapi/documentation/pull/2269) +- [Fix typo in a snippet used in Cloud docs](https://github.com/strapi/documentation/pull/2268) + +*** + +This release was made possible thanks to the following contributors. Thank you! 🫶 + + + +
+
++
+ +## 5.1.2 + +### 🖌 Updated content + +#### Dev Docs + +- [Add support for 'latest' parameter in the upgrade tool](https://github.com/strapi/documentation/pull/2259) +- [Add example code and resulting screenshot for theme extension](https://github.com/strapi/documentation/pull/2261) + +### 🧹 Chore, fixes, typos, and other improvements + +#### Strapi Cloud + +- [Update cloud deployment logs screen](https://github.com/strapi/documentation/pull/2263) +- [Update confirmation modal text in Cloud Update Repository](https://github.com/strapi/documentation/pull/2258) + +#### Repository + +- [Restore bigger font-size for categories title in sidebar](https://github.com/strapi/documentation/pull/2260) + +*** + +This release was made possible thanks to the following contributors. Thank you! 🫶 + + + +
+
+ +## 5.1.1 + +### 🖌 Updated content + +#### Strapi Cloud + +* [List environments with Cloud CLI](https://github.com/strapi/documentation/pull/2239) + +#### Dev Docs + +* [`publicationAt` breaking change](https://github.com/strapi/documentation/pull/2249) + +### 🧹 Chore, fixes, typos, and other improvements + +#### Strapi Cloud + +* [Update wording on purchasable extra Seats](https://github.com/strapi/documentation/pull/2238) + +#### Dev Docs + +* [Clarify sorting for relational fields in the Content Manager list view](https://github.com/strapi/documentation/pull/2224) +* [Fix typo for `v4CompatibilityMode` flag](https://github.com/strapi/documentation/pull/2257) +* [Fix step-by-step v4 → v5 migration (v4CompatibilityMode flag)](https://github.com/strapi/documentation/pull/2255) +* [Update environment declaration in Docker guide](https://github.com/strapi/documentation/pull/2253) +* [Fix createStrapi method in TypeScript development documentation](https://github.com/strapi/documentation/pull/2248) +* [Fix links in the REST API documentation](https://github.com/strapi/documentation/pull/2247) +* [Fix CheckPagePermissions code example in helper-plugin deprecation guide](https://github.com/strapi/documentation/pull/2244) +* [Fix typo for init command in Plugin SDK](https://github.com/strapi/documentation/pull/2243) +* [Add link to ms package for examples for JWT expiresIn](https://github.com/strapi/documentation/pull/2242) + +#### Repository + +* [Update LICENSE](https://github.com/strapi/documentation/pull/2251) + + +*** + +This release was made possible thanks to the following contributors. Thank you! 🫶 + + + +
+
+
+
+
+
++
+ ## 5.1.0 ### ✨ New content diff --git a/docusaurus/docs/snippets/configuration-sso-admin.md b/docusaurus/docs/snippets/configuration-sso-admin.md new file mode 100644 index 0000000000..b4dd02c499 --- /dev/null +++ b/docusaurus/docs/snippets/configuration-sso-admin.md @@ -0,0 +1,57 @@ +There are some optional configurations that you can set should it be necessary, for more information on available options please see the [Admin Configuration](/dev-docs/configurations/admin-panel) documentation. + +- **`url`**: The public facing URL of your Strapi administration panel. (e.g. `https://admin.example.com`) +- **`auth.domain`**: Setting a custom domain for cookie storage. (e.g. `.example.com`) + +:::note +When deploying the admin panel to a different location or on a different subdomain, an additional configuration is required to set the common domain for the cookies. This is required to ensure the cookies are shared across the domains. +::: + +:::caution +Deploying the admin and backend on entirely different unrelated domains is not possible at this time when using SSO due to restrictions in cross-domain cookies. +::: + +
+
+
+
+
+```js title="./config/admin.js"
+
+module.exports = ({ env }) => ({
+ // ...
+ url: env('PUBLIC_ADMIN_URL', 'https://admin.example.com'),
+ auth: {
+ domain: env("ADMIN_SSO_DOMAIN", ".example.com"),
+ providers: [
+ // ...
+ ],
+ },
+ // ...
+});
+```
+
+
+
+
+
+```ts title="./config/admin.ts"
+
+export default ({ env }) => ({
+ // ...
+ url: env('PUBLIC_ADMIN_URL', 'https://admin.example.com'),
+ auth: {
+ domain: env("ADMIN_SSO_DOMAIN", ".example.com"),
+ providers: [
+ // ...
+ ],
+ },
+ // ...
+});
+```
+
+
+
+
diff --git a/docusaurus/docs/snippets/configuration-sso-middlewares.md b/docusaurus/docs/snippets/configuration-sso-middlewares.md
new file mode 100644
index 0000000000..19ac73bfa8
--- /dev/null
+++ b/docusaurus/docs/snippets/configuration-sso-middlewares.md
@@ -0,0 +1,87 @@
+The following middleware configurations are required when using SSO, for more information on available options please see the [Middlewares Configuration](/dev-docs/configurations/middlewares) documentation.
+
+- **`contentSecurityPolicy`**: Allows you to configure the Content Security Policy (CSP) for your Strapi application. This is used to prevent cross-site scripting attacks by allowing you to control what resources can be loaded by your application.
+
+:::note
+By default, Strapi security policy does not allow loading images from external URLs, so provider logos will not show up on the [login screen](/user-docs/intro#accessing-the-admin-panel) of the admin panel unless [a security exception is added](/dev-docs/configurations/middlewares#security) or you use a file uploaded directly on your Strapi application.
+:::
+
+Admin Optional Configuration Example
+ +
+
+
+
+```jsx title="./config/middlewares.js"
+module.exports = [
+ // ...
+ {
+ name: 'strapi::security',
+ config: {
+ contentSecurityPolicy: {
+ useDefaults: true,
+ directives: {
+ 'connect-src': ["'self'", 'https:'],
+ 'img-src': [
+ "'self'",
+ 'data:',
+ 'blob:',
+ 'market-assets.strapi.io',
+ 'cdn2.iconfinder.com', // Base URL of the provider's logo without the protocol
+ ],
+ 'media-src': [
+ "'self'",
+ 'data:',
+ 'blob:',
+ 'market-assets.strapi.io',
+ 'cdn2.iconfinder.com', // Base URL of the provider's logo without the protocol
+ ],
+ upgradeInsecureRequests: null,
+ },
+ },
+ },
+ },
+ // ...
+]
+```
+
+
+
+
+
+```ts title="./config/middlewares.ts"
+export default [
+ // ...
+ {
+ name: 'strapi::security',
+ config: {
+ contentSecurityPolicy: {
+ useDefaults: true,
+ directives: {
+ 'connect-src': ["'self'", 'https:'],
+ 'img-src': [
+ "'self'",
+ 'data:',
+ 'blob:',
+ 'market-assets.strapi.io',
+ 'cdn2.iconfinder.com', // Base URL of the provider's logo without the protocol
+ ],
+ 'media-src': [
+ "'self'",
+ 'data:',
+ 'blob:',
+ 'market-assets.strapi.io',
+ 'cdn2.iconfinder.com', // Base URL of the provider's logo without the protocol
+ ],
+ upgradeInsecureRequests: null,
+ },
+ },
+ },
+ },
+ // ...
+]
+```
+
+
+
+
diff --git a/docusaurus/docs/snippets/configuration-sso-server.md b/docusaurus/docs/snippets/configuration-sso-server.md
new file mode 100644
index 0000000000..ec23be45e2
--- /dev/null
+++ b/docusaurus/docs/snippets/configuration-sso-server.md
@@ -0,0 +1,88 @@
+The following server configurations are required when using SSO, for more information on available options please see the [Server Configuration](/dev-docs/configurations/server) documentation.
+
+- **`url`**: The public facing URL of your Strapi application. (e.g. `https://api.example.com`)
+- **`proxy.koa`**: Enabling trusted reverse proxy support. (`true`)
+
+Middlewares Configuration Example
+ +
+
+
+
+
+```js title="./config/server.js"
+
+module.exports = ({ env }) => ({
+ // ...
+ url: env('PUBLIC_URL', 'https://api.example.com'),
+ proxy: {
+ koa: env.bool('TRUST_PROXY', true),
+ },
+ // ...
+});
+```
+
+
+
+
+
+```ts title="./config/server.ts"
+
+export default ({ env }) => ({
+ // ...
+ url: env('PUBLIC_URL', 'https://api.example.com'),
+ proxy: {
+ koa: env.bool('TRUST_PROXY', true),
+ },
+ // ...
+});
+```
+
+
+
+
+
+There are also some optional configurations that you can set should it be necessary:
+
+- **`proxy.global`**: If you are in a restricted network environment that requires a forward proxy (e.g Squid) for all outgoing requests. (e.g. `http://username:password@yourProxy:3128`)
+
+Admin Required Configuration Example
+ +
+
+
+
+
+```js title="./config/server.js"
+
+module.exports = ({ env }) => ({
+ // ...
+ url: env('PUBLIC_URL', 'https://api.example.com'),
+ proxy: {
+ koa: env.bool('TRUST_PROXY', true),
+ global: env('GLOBAL_PROXY'),
+ },
+ // ...
+});
+```
+
+
+
+
+
+```ts title="./config/server.ts"
+
+export default ({ env }) => ({
+ // ...
+ url: env('PUBLIC_URL', 'https://api.example.com'),
+ proxy: {
+ koa: env.bool('TRUST_PROXY', true),
+ global: env('GLOBAL_PROXY'),
+ },
+ // ...
+});
+```
+
+
+
+
diff --git a/docusaurus/docs/snippets/invoices-statuses.md b/docusaurus/docs/snippets/invoices-statuses.md
index 8d3aac62e3..66a4f462cd 100644
--- a/docusaurus/docs/snippets/invoices-statuses.md
+++ b/docusaurus/docs/snippets/invoices-statuses.md
@@ -2,10 +2,10 @@ Invoices can have any of the following statuses:
- Paid: the payment has been done and the invoice is available, no additional action is required.
- Payment pending: the invoice is not complete or validated yet
-- Payment due: the paiement didn't go through and needs to be fixed
+- Payment due: the payment didn't go through and needs to be fixed
- Not paid: the payment has failed and won't automatically be retried
- Voided: the invoice has been cancelled.
:::tip
Click the  icon to download an invoice.
-:::
\ No newline at end of file
+:::
diff --git a/docusaurus/docs/user-docs/content-manager/adding-content-to-releases.md b/docusaurus/docs/user-docs/content-manager/adding-content-to-releases.md
index ae58312ba2..47e0e2e6fc 100644
--- a/docusaurus/docs/user-docs/content-manager/adding-content-to-releases.md
+++ b/docusaurus/docs/user-docs/content-manager/adding-content-to-releases.md
@@ -9,8 +9,6 @@ tags:
- Strapi Cloud
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
-
# Including content in a release Admin Optional Configuration Example
+ +
Password
The Password field displays a password field that is encrypted.
diff --git a/docusaurus/docs/user-docs/content-type-builder/creating-new-content-type.md b/docusaurus/docs/user-docs/content-type-builder/creating-new-content-type.md
index a6f04b62f1..ccfb5473ac 100644
--- a/docusaurus/docs/user-docs/content-type-builder/creating-new-content-type.md
+++ b/docusaurus/docs/user-docs/content-type-builder/creating-new-content-type.md
@@ -9,8 +9,6 @@ tags:
- single type
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
-
# Creating content-types
:::note Development-only
diff --git a/docusaurus/docs/user-docs/content-type-builder/introduction-to-content-types-builder.md b/docusaurus/docs/user-docs/content-type-builder/introduction-to-content-types-builder.md
index b56cc4a551..4700458743 100644
--- a/docusaurus/docs/user-docs/content-type-builder/introduction-to-content-types-builder.md
+++ b/docusaurus/docs/user-docs/content-type-builder/introduction-to-content-types-builder.md
@@ -11,8 +11,6 @@ tags:
pagination_next: user-docs/content-type-builder/creating-new-content-type
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
-
# Introduction to the Content-type Builder
The Content-type Builder is a core plugin of Strapi. It is a feature that is always activated by default and cannot be deactivated. The Content-type Builder is however only accessible when the application is in a development environment.
diff --git a/docusaurus/docs/user-docs/content-type-builder/managing-content-types.md b/docusaurus/docs/user-docs/content-type-builder/managing-content-types.md
index e026b0e20a..528c1b8a7b 100644
--- a/docusaurus/docs/user-docs/content-type-builder/managing-content-types.md
+++ b/docusaurus/docs/user-docs/content-type-builder/managing-content-types.md
@@ -9,7 +9,6 @@ tags:
- single type
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
import ScreenshotNumberReference from '/src/components/ScreenshotNumberReference.jsx';
# Managing content-types
diff --git a/docusaurus/docs/user-docs/media-library/adding-assets.md b/docusaurus/docs/user-docs/media-library/adding-assets.md
index bb087b269b..5297a0d0a8 100644
--- a/docusaurus/docs/user-docs/media-library/adding-assets.md
+++ b/docusaurus/docs/user-docs/media-library/adding-assets.md
@@ -9,8 +9,6 @@ tags:
- media library
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
-
# Adding assets
The Media Library displays all assets uploaded in the application, either via the [Media Library](/user-docs/media-library) or the [Content Manager](/user-docs/content-manager/writing-content.md#filling-up-fields) when managing a media field.
diff --git a/docusaurus/docs/user-docs/media-library/introduction-to-the-media-library.md b/docusaurus/docs/user-docs/media-library/introduction-to-the-media-library.md
index c82f0b5b73..517339897c 100644
--- a/docusaurus/docs/user-docs/media-library/introduction-to-the-media-library.md
+++ b/docusaurus/docs/user-docs/media-library/introduction-to-the-media-library.md
@@ -12,7 +12,6 @@ tags:
pagination_next: user-docs/media-library/adding-assets
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
import ScreenshotNumberReference from '/src/components/ScreenshotNumberReference.jsx';
# Introduction to the Media Library
diff --git a/docusaurus/docs/user-docs/media-library/managing-assets.md b/docusaurus/docs/user-docs/media-library/managing-assets.md
index 76970725dc..eb5400a22c 100644
--- a/docusaurus/docs/user-docs/media-library/managing-assets.md
+++ b/docusaurus/docs/user-docs/media-library/managing-assets.md
@@ -9,7 +9,6 @@ tags:
- media library
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
import ScreenshotNumberReference from '/src/components/ScreenshotNumberReference.jsx';
# Managing individual assets
diff --git a/docusaurus/docs/user-docs/media-library/organizing-assets-with-folders.md b/docusaurus/docs/user-docs/media-library/organizing-assets-with-folders.md
index f3e548c9f7..3b7e6e4c8f 100644
--- a/docusaurus/docs/user-docs/media-library/organizing-assets-with-folders.md
+++ b/docusaurus/docs/user-docs/media-library/organizing-assets-with-folders.md
@@ -10,7 +10,6 @@ tags:
- Users, Roles & Permissions
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
import ScreenshotNumberReference from '/src/components/ScreenshotNumberReference.jsx';
# Organizing assets with folders
diff --git a/docusaurus/docs/user-docs/plugins/installing-plugins-via-marketplace.md b/docusaurus/docs/user-docs/plugins/installing-plugins-via-marketplace.md
index e25510e988..6877b4b690 100644
--- a/docusaurus/docs/user-docs/plugins/installing-plugins-via-marketplace.md
+++ b/docusaurus/docs/user-docs/plugins/installing-plugins-via-marketplace.md
@@ -9,12 +9,8 @@ tags:
- upload plugin
---
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
-
# Using the Marketplace
-" >> "$OUTPUT_FILE"
+
+ # Sort and deduplicate contributors
+ sort -u "$TEMP_DIR/contributors_raw" | while IFS='|' read -r user avatar_url; do
+ cat >> "$OUTPUT_FILE" << EOF
+
+ 
+
+EOF
+ done
+
+ echo "
" >> "$OUTPUT_FILE"
+ echo -e "\n
" >> "$OUTPUT_FILE" + fi + + echo -e "${GREEN}Release notes generated in $OUTPUT_FILE${NC}" +} + +main diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js index f98da6cdc5..0db7c4bd19 100644 --- a/docusaurus/sidebars.js +++ b/docusaurus/sidebars.js @@ -15,40 +15,33 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { devDocsSidebar: [ - { // Getting Started + { + // Getting Started type: 'category', collapsed: false, label: '🚀 Getting Started', - link: {type: 'doc', id: 'dev-docs/intro'}, + link: { type: 'doc', id: 'dev-docs/intro' }, items: [ { type: 'doc', id: 'dev-docs/intro', - customProps: { - updated: true, - }, }, { type: 'doc', id: 'dev-docs/quick-start', - customProps: { - updated: true, - }, }, { type: 'doc', id: 'dev-docs/whats-new', label: "What's new?", - customProps: { - udpated: true - } }, 'dev-docs/faq', 'dev-docs/community', 'dev-docs/usage-information', - ] + ], }, - { // Setup & Deployment + { + // Setup & Deployment type: 'category', collapsed: false, label: '⚙️ Setup & Deployment', @@ -65,10 +58,7 @@ const sidebars = { { type: 'category', label: 'Installation', - link: {type: 'doc', id: 'dev-docs/installation'}, - customProps: { - updated: true, - }, + link: { type: 'doc', id: 'dev-docs/installation' }, items: [ { type: 'doc', @@ -78,12 +68,9 @@ const sidebars = { { type: 'doc', id: 'dev-docs/installation/cli', - customProps: { - updated: true, - }, }, 'dev-docs/installation/docker', - ] + ], }, 'dev-docs/project-structure', { @@ -95,7 +82,13 @@ const sidebars = { label: 'Introduction to configuration', id: 'dev-docs/configurations', }, - 'dev-docs/configurations/database', + { + type: 'doc', + id: 'dev-docs/configurations/database', + customProps: { + updated: true, + }, + }, 'dev-docs/configurations/server', 'dev-docs/configurations/admin-panel', 'dev-docs/configurations/middlewares', @@ -123,7 +116,7 @@ const sidebars = { id: 'dev-docs/deployment', }, items: [ - { + { type: 'doc', label: 'Introduction to deployment', id: 'dev-docs/deployment', @@ -133,33 +126,28 @@ const sidebars = { label: '☁️ Strapi Cloud', id: 'cloud/getting-started/deployment', }, - ] - } - ] + ], + }, + ], }, - { // Content APIs + { + // Content APIs type: 'category', collapsed: false, label: '📦 Content API', - link: {type: 'doc', id: 'dev-docs/api/content-api'}, + link: { type: 'doc', id: 'dev-docs/api/content-api' }, items: [ { type: 'doc', label: 'APIs Introduction & Concepts', id: 'dev-docs/api/content-api', - customProps: { - updated: true, - }, }, { type: 'category', label: 'REST API', - customProps: { - updated: true, - }, link: { type: 'doc', - id: 'dev-docs/api/rest' + id: 'dev-docs/api/rest', }, items: [ { @@ -174,14 +162,11 @@ const sidebars = { 'dev-docs/api/rest/relations', 'dev-docs/api/rest/interactive-query-builder', 'dev-docs/api/rest/guides/intro', - ] + ], }, { type: 'doc', id: 'dev-docs/api/graphql', - customProps: { - updated: true, - }, }, // { // type: 'category', @@ -222,105 +207,120 @@ const sidebars = { label: 'Document Service API', link: { type: 'doc', - id: 'dev-docs/api/document-service' - }, - customProps: { - new: true + id: 'dev-docs/api/document-service', }, items: [ { type: 'doc', label: 'Introduction & Concepts', - id: 'dev-docs/api/document' + id: 'dev-docs/api/document', }, { type: 'doc', label: 'Available methods', - id: 'dev-docs/api/document-service' + id: 'dev-docs/api/document-service', }, { type: 'doc', label: 'Filters', - id: 'dev-docs/api/document-service/filters' + id: 'dev-docs/api/document-service/filters', }, { type: 'doc', label: 'Populate', - id: 'dev-docs/api/document-service/populate' + id: 'dev-docs/api/document-service/populate', }, { type: 'doc', label: 'Fields', - id: 'dev-docs/api/document-service/fields' + id: 'dev-docs/api/document-service/fields', }, { type: 'doc', label: 'Sort & Pagination', - id: 'dev-docs/api/document-service/sort-pagination' + id: 'dev-docs/api/document-service/sort-pagination', }, { type: 'doc', label: 'Locale', - id: 'dev-docs/api/document-service/locale' + id: 'dev-docs/api/document-service/locale', }, { type: 'doc', label: 'Status', - id: 'dev-docs/api/document-service/status' + id: 'dev-docs/api/document-service/status', + customProps: { + updated: true, + }, }, { type: 'doc', label: 'Middlewares', - id: 'dev-docs/api/document-service/middlewares' + id: 'dev-docs/api/document-service/middlewares', }, - ] + ], }, - ] + ], }, - { // Advanced features + { + // Advanced features type: 'category', label: '🔧 Advanced features', collapsed: false, link: { type: 'doc', - id: 'dev-docs/advanced-features' + id: 'dev-docs/advanced-features', }, items: [ { type: 'doc', label: 'Introduction to advanced features', id: 'dev-docs/advanced-features', - customProps: { - new: true, - }, }, { type: 'doc', label: 'Internationalization (i18n)', - customProps: { - updated: true, - }, id: 'dev-docs/i18n', }, { type: 'doc', id: 'dev-docs/cli', - customProps: { - updated: true, - }, }, { type: 'category', label: 'TypeScript', link: { type: 'doc', - id: 'dev-docs/typescript' + id: 'dev-docs/typescript', }, items: [ 'dev-docs/typescript', - 'dev-docs/typescript/development', + { + type: 'doc', + id: 'dev-docs/typescript/development', + customProps: { + updated: true, + }, + }, 'dev-docs/typescript/adding-support-to-existing-project', - ] + { + type: 'category', + label: 'Guides', + link: { + type: 'doc', + id: 'dev-docs/typescript/development/guides', + }, + items: [ + { + type: 'doc', + id: 'dev-docs/typescript/development/guides/documents-and-entries', + customProps: { + new: true, + }, + }, + ], + }, + ], }, { type: 'doc', @@ -331,9 +331,6 @@ const sidebars = { type: 'doc', label: 'Templates', id: 'dev-docs/templates', - customProps: { - updated: true, - } }, { type: 'category', @@ -354,16 +351,17 @@ const sidebars = { type: 'doc', label: 'Data transfer', id: 'dev-docs/data-management/transfer', - } + }, ], }, 'dev-docs/database-migrations', 'dev-docs/database-transactions', 'dev-docs/testing', 'dev-docs/error-handling', - ] + ], }, - { // Customization + { + // Customization type: 'category', collapsed: false, label: '🛠 Customization', @@ -376,19 +374,13 @@ const sidebars = { type: 'doc', label: 'Customization Introduction & Concepts', id: 'dev-docs/customization', - customProps: { - new: true, - }, }, { type: 'category', label: 'Back-end customization', - customProps: { - updated: true, - }, link: { type: 'doc', - id: 'dev-docs/backend-customization' + id: 'dev-docs/backend-customization', }, items: [ { @@ -407,14 +399,11 @@ const sidebars = { 'dev-docs/backend-customization/services', 'dev-docs/backend-customization/models', 'dev-docs/backend-customization/webhooks', - ] + ], }, { type: 'category', label: 'Admin panel customization', - customProps: { - updated: true, - }, link: { type: 'doc', id: 'dev-docs/admin-panel-customization', @@ -431,11 +420,12 @@ const sidebars = { 'dev-docs/admin-panel-customization/wysiwyg-editor', 'dev-docs/admin-panel-customization/extension', 'dev-docs/admin-panel-customization/deployment', - ] + ], }, - ] + ], }, - { // Plugins + { + // Plugins type: 'category', collapsed: false, label: '🔌 Plugins', @@ -447,20 +437,20 @@ const sidebars = { { type: 'doc', label: 'Plugins Introduction & Concepts', - id: 'dev-docs/plugins' + id: 'dev-docs/plugins', }, { type: 'category', label: 'Using plugins', link: { type: 'doc', - id: 'dev-docs/plugins/using-plugins' + id: 'dev-docs/plugins/using-plugins', }, items: [ { type: 'doc', label: 'Introduction to using plugins', - id: 'dev-docs/plugins/using-plugins' + id: 'dev-docs/plugins/using-plugins', }, { type: 'doc', @@ -493,14 +483,11 @@ const sidebars = { label: 'Users & Permissions', id: 'dev-docs/plugins/users-permissions', }, - ] + ], }, { type: 'category', label: 'Developing plugins', - customProps: { - updated: true, - }, link: { type: 'doc', id: 'dev-docs/plugins/developing-plugins', @@ -509,24 +496,18 @@ const sidebars = { { type: 'doc', label: 'Introduction to developing plugins', - id: 'dev-docs/plugins/developing-plugins' + id: 'dev-docs/plugins/developing-plugins', }, 'dev-docs/plugins/development/create-a-plugin', { type: 'doc', id: 'dev-docs/plugins/development/plugin-structure', label: 'Plugin structure', - customProps: { - updated: true, - }, }, { type: 'doc', id: 'dev-docs/plugins/development/plugin-sdk', label: 'Plugin SDK', - customProps: { - new: true, - }, }, { type: 'category', @@ -540,18 +521,12 @@ const sidebars = { type: 'doc', label: 'Introduction to Admin Panel APIs', id: 'dev-docs/plugins/admin-panel-api', - customProps: { - updated: true, - }, }, { type: 'doc', id: 'dev-docs/plugins/content-manager-apis', - customProps: { - new: true, - }, - } - ] + }, + ], }, { type: 'doc', @@ -571,19 +546,17 @@ const sidebars = { 'dev-docs/plugins/guides/store-and-access-data', 'dev-docs/plugins/guides/pass-data-from-server-to-admin', 'dev-docs/plugins/development/create-a-plugin', - ] - } - ] - } - ] + ], + }, + ], + }, + ], }, - { // Update & Migration + { + // Update & Migration type: 'category', collapsed: false, label: '♻️ Upgrades', - customProps: { - new: true, - }, link: { type: 'doc', id: 'dev-docs/upgrades', @@ -603,19 +576,19 @@ const sidebars = { collapsed: false, link: { type: 'doc', - id: 'dev-docs/migration/v4-to-v5/introduction-and-faq' + id: 'dev-docs/migration/v4-to-v5/introduction-and-faq', }, label: 'Upgrade to Strapi 5', items: [ { type: 'doc', label: 'Introduction and FAQ', - id: 'dev-docs/migration/v4-to-v5/introduction-and-faq' + id: 'dev-docs/migration/v4-to-v5/introduction-and-faq', }, { type: 'doc', label: 'Step-by-step guide', - id: 'dev-docs/migration/v4-to-v5/step-by-step' + id: 'dev-docs/migration/v4-to-v5/step-by-step', }, { type: 'doc', @@ -627,8 +600,8 @@ const sidebars = { label: 'Specific resources', id: 'dev-docs/migration/v4-to-v5/additional-resources/introduction', }, - ] - } + ], + }, ], }, ], @@ -638,8 +611,8 @@ const sidebars = { collapsed: false, label: 'Getting Started', link: { - type: "doc", - id: "user-docs/intro", + type: 'doc', + id: 'user-docs/intro', }, items: [ 'user-docs/intro', @@ -652,7 +625,7 @@ const sidebars = { collapsed: false, link: { type: 'doc', - id: 'user-docs/content-manager/introduction-to-content-manager' + id: 'user-docs/content-manager/introduction-to-content-manager', }, label: 'Content Manager', items: [ @@ -662,9 +635,6 @@ const sidebars = { { type: 'doc', id: 'user-docs/content-manager/working-with-content-history', - customProps: { - new: true, - } }, 'user-docs/content-manager/managing-relational-fields', 'user-docs/content-manager/translating-content', @@ -672,9 +642,6 @@ const sidebars = { { type: 'doc', id: 'user-docs/content-manager/saving-and-publishing-content', - customProps: { - updated: true, - } }, 'user-docs/content-manager/adding-content-to-releases', ], @@ -684,43 +651,49 @@ const sidebars = { collapsed: false, label: 'Content-type Builder', link: { - type: "doc", - id: "user-docs/content-type-builder/introduction-to-content-types-builder", + type: 'doc', + id: 'user-docs/content-type-builder/introduction-to-content-types-builder', }, items: [ { type: 'autogenerated', - dirName: 'user-docs/content-type-builder' - } - ] + dirName: 'user-docs/content-type-builder', + }, + ], }, { type: 'category', collapsed: false, label: 'Media Library', link: { - type: "doc", - id: "user-docs/media-library/introduction-to-the-media-library", + type: 'doc', + id: 'user-docs/media-library/introduction-to-the-media-library', }, items: [ { type: 'autogenerated', - dirName: 'user-docs/media-library' - } - ] + dirName: 'user-docs/media-library', + }, + ], }, { - type: "category", + type: 'category', collapsed: false, - label: "Releases", + label: 'Releases', link: { - type: "doc", - id: "user-docs/releases/introduction", + type: 'doc', + id: 'user-docs/releases/introduction', }, items: [ 'user-docs/releases/introduction', 'user-docs/releases/creating-a-release', - 'user-docs/releases/managing-a-release', + { + type: 'doc', + id: 'user-docs/releases/managing-a-release', + customProps: { + updated: true, + }, + }, ], }, { @@ -728,50 +701,50 @@ const sidebars = { collapsed: false, label: 'Users, Roles & Permissions', link: { - type: "doc", - id: "user-docs/users-roles-permissions/introduction-to-users-roles-permissions", + type: 'doc', + id: 'user-docs/users-roles-permissions/introduction-to-users-roles-permissions', }, items: [ { type: 'autogenerated', - dirName: 'user-docs/users-roles-permissions' - } - ] + dirName: 'user-docs/users-roles-permissions', + }, + ], }, { type: 'category', collapsed: false, label: 'Plugins', link: { - type: "doc", - id: "user-docs/plugins/introduction-to-plugins", + type: 'doc', + id: 'user-docs/plugins/introduction-to-plugins', }, items: [ { type: 'autogenerated', - dirName: 'user-docs/plugins' - } - ] + dirName: 'user-docs/plugins', + }, + ], }, { type: 'category', collapsed: false, label: 'Settings', link: { - type: "doc", - id: "user-docs/settings/introduction", + type: 'doc', + id: 'user-docs/settings/introduction', }, items: [ - 'user-docs/settings/introduction', - 'user-docs/settings/configuring-users-permissions-plugin-settings', - 'user-docs/settings/audit-logs', + 'user-docs/settings/introduction', + 'user-docs/settings/configuring-users-permissions-plugin-settings', + 'user-docs/settings/audit-logs', { type: 'category', collapsed: false, label: 'Configuring global settings', link: { type: 'doc', - id: 'user-docs/settings/introduction' + id: 'user-docs/settings/introduction', }, items: [ 'user-docs/settings/admin-panel', @@ -783,167 +756,146 @@ const sidebars = { type: 'doc', label: 'Review Workflows', id: 'user-docs/settings/review-workflows', + customProps: { + updated: true, + }, }, 'user-docs/settings/single-sign-on', 'user-docs/settings/transfer-tokens', - ] + ], }, ], }, ], cloudSidebar: [ { - type: "category", + type: 'category', collapsed: false, - label: "Getting Started", + label: 'Getting Started', link: { - type: "doc", - id: "cloud/getting-started/intro", + type: 'doc', + id: 'cloud/getting-started/intro', }, items: [ - "cloud/getting-started/intro", + 'cloud/getting-started/intro', { - type: "doc", - label: "Cloud fundamentals", - id: "cloud/getting-started/cloud-fundamentals", - customProps: { - new: false, - }, + type: 'doc', + label: 'Cloud fundamentals', + id: 'cloud/getting-started/cloud-fundamentals', }, { - type: "category", - label: "Project deployment", - link: { type: "doc", id: "cloud/getting-started/deployment-options" }, - customProps: { - updated: false, - }, + type: 'category', + label: 'Project deployment', + link: { type: 'doc', id: 'cloud/getting-started/deployment-options' }, items: [ { - type: "doc", - id: "cloud/getting-started/deployment", - customProps: { - updated: true, - }, + type: 'doc', + id: 'cloud/getting-started/deployment', }, { - type: "doc", - id: "cloud/getting-started/deployment-cli", - customProps: { - new: true, - }, - }, + type: 'doc', + id: 'cloud/getting-started/deployment-cli', + }, ], }, { - type: "doc", - id: "cloud/getting-started/usage-billing", - customProps: { - updated: false, - }, + type: 'doc', + id: 'cloud/getting-started/usage-billing', }, - "cloud/getting-started/caching", + 'cloud/getting-started/caching', { - type: "doc", - label: "Notifications", - id: "cloud/projects/notifications", + type: 'doc', + label: 'Notifications', + id: 'cloud/projects/notifications', }, ], }, { - type: "category", + type: 'category', collapsed: false, - label: "Projects management", + label: 'Projects management', link: { - type: "doc", - id: "cloud/projects/overview", + type: 'doc', + id: 'cloud/projects/overview', }, items: [ - "cloud/projects/overview", + 'cloud/projects/overview', { - type: "doc", - label: "Project settings", - id: "cloud/projects/settings", - customProps: { - updated: true, - }, + type: 'doc', + label: 'Project settings', + id: 'cloud/projects/settings', }, - "cloud/projects/collaboration", - "cloud/projects/runtime-logs", + 'cloud/projects/collaboration', + 'cloud/projects/runtime-logs', ], }, { - type: "category", + type: 'category', collapsed: false, - label: "Deployments", + label: 'Deployments', link: { - type: "doc", - id: "cloud/projects/deploys", + type: 'doc', + id: 'cloud/projects/deploys', }, - items: ["cloud/projects/deploys", "cloud/projects/deploys-history"], + items: ['cloud/projects/deploys', 'cloud/projects/deploys-history'], }, { - type: "category", + type: 'category', collapsed: false, - label: "Account management", + label: 'Account management', link: { - type: "doc", - id: "cloud/account/account-settings", + type: 'doc', + id: 'cloud/account/account-settings', }, items: [ - "cloud/account/account-settings", + 'cloud/account/account-settings', { - type: "doc", - id: "cloud/account/account-billing", - label: "Account billing & invoices", - customProps: { - updated: false, - }, + type: 'doc', + id: 'cloud/account/account-billing', + label: 'Account billing & invoices', }, ], }, { - type: "category", + type: 'category', collapsed: false, - label: "Command Line Interface", + label: 'Command Line Interface', link: { - type: "doc", - id: "cloud/cli/cloud-cli", + type: 'doc', + id: 'cloud/cli/cloud-cli', }, items: [ { - type: "doc", - id: "cloud/cli/cloud-cli", - label: "Strapi Cloud CLI", - customProps: { - new: true, - }, + type: 'doc', + id: 'cloud/cli/cloud-cli', + label: 'Strapi Cloud CLI', }, ], }, { - type: "category", + type: 'category', collapsed: false, - label: "Advanced configuration", + label: 'Advanced configuration', link: { - type: "doc", - id: "cloud/advanced/database", + type: 'doc', + id: 'cloud/advanced/database', }, items: [ - "cloud/advanced/database", + 'cloud/advanced/database', { - type: "doc", - id: "cloud/advanced/email", - label: "Email provider", + type: 'doc', + id: 'cloud/advanced/email', + label: 'Email provider', customProps: { - new: false, + updated: true, }, }, { - type: "doc", - id: "cloud/advanced/upload", - label: "Upload provider", + type: 'doc', + id: 'cloud/advanced/upload', + label: 'Upload provider', customProps: { - new: false, + updated: true, }, }, ], @@ -953,7 +905,7 @@ const sidebars = { { type: 'link', label: '⬅️ Back to Dev Docs content', - href: '/dev-docs/intro' + href: '/dev-docs/intro', }, { type: 'category', @@ -961,13 +913,13 @@ const sidebars = { label: 'REST API reference', link: { type: 'doc', - id: 'dev-docs/api/rest' + id: 'dev-docs/api/rest', }, items: [ { type: 'category', label: 'Endpoints and basic requests', - link: {type: 'doc', id: 'dev-docs/api/rest'}, + link: { type: 'doc', id: 'dev-docs/api/rest' }, collapsed: false, items: [ { @@ -978,43 +930,43 @@ const sidebars = { { type: 'link', label: 'Get documents', - href: '/dev-docs/api/rest#get-documents' + href: '/dev-docs/api/rest#get-all', }, { type: 'link', label: 'Get a document', - href: '/dev-docs/api/rest#get-a-document' + href: '/dev-docs/api/rest#get', }, { type: 'link', label: 'Create a document', - href: '/dev-docs/api/rest#create-a-document' + href: '/dev-docs/api/rest#create', }, { type: 'link', label: 'Update a document', - href: '/dev-docs/api/rest#update-a-document' + href: '/dev-docs/api/rest#update', }, { type: 'link', label: 'Delete a document', - href: '/dev-docs/api/rest#delete-a-document' + href: '/dev-docs/api/rest#delete', }, - ] + ], }, { type: 'doc', id: 'dev-docs/api/rest/interactive-query-builder', - label: '✨ Interactive Query Builder' + label: '✨ Interactive Query Builder', }, { type: 'doc', - id: 'dev-docs/api/rest/parameters' + id: 'dev-docs/api/rest/parameters', }, { type: 'category', label: 'Populate and Select', - link: {type: 'doc', id: 'dev-docs/api/rest/populate-select'}, + link: { type: 'doc', id: 'dev-docs/api/rest/populate-select' }, collapsed: false, items: [ { @@ -1027,18 +979,21 @@ const sidebars = { label: 'Population', href: '/dev-docs/api/rest/populate-select#population', }, - ] + ], }, { type: 'category', collapsed: false, label: 'Filters, Locale, Publication State', - link: {type: 'doc', id: 'dev-docs/api/rest/filters-locale-publication' }, + link: { + type: 'doc', + id: 'dev-docs/api/rest/filters-locale-publication', + }, items: [ { type: 'link', label: 'Filtering', - href: '/dev-docs/api/rest/filters-locale-publication#filtering' + href: '/dev-docs/api/rest/filters-locale-publication#filtering', }, { type: 'link', @@ -1066,58 +1021,58 @@ const sidebars = { type: 'category', collapsed: false, label: 'Sort and Pagination', - link: { type: 'doc', id: 'dev-docs/api/rest/sort-pagination'}, + link: { type: 'doc', id: 'dev-docs/api/rest/sort-pagination' }, items: [ { type: 'link', label: 'Sorting', - href: '/dev-docs/api/rest/sort-pagination#sorting' + href: '/dev-docs/api/rest/sort-pagination#sorting', }, { type: 'link', label: 'Pagination', - href: '/dev-docs/api/rest/sort-pagination#pagination' + href: '/dev-docs/api/rest/sort-pagination#pagination', }, { type: 'link', label: 'Pagination by page', - href: '/dev-docs/api/rest/sort-pagination#pagination-by-page' + href: '/dev-docs/api/rest/sort-pagination#pagination-by-page', }, { type: 'link', label: 'Pagination by offset', - href: '/dev-docs/api/rest/sort-pagination#pagination-by-offset' + href: '/dev-docs/api/rest/sort-pagination#pagination-by-offset', }, - ] + ], }, { type: 'category', collapsed: false, label: 'Relations', - link: {type: 'doc', id: 'dev-docs/api/rest/relations'}, + link: { type: 'doc', id: 'dev-docs/api/rest/relations' }, items: [ { type: 'link', label: 'connect', - href: '/dev-docs/api/rest/relations#connect' + href: '/dev-docs/api/rest/relations#connect', }, { type: 'link', label: 'disconnect', - href: '/dev-docs/api/rest/relations#disconnect' + href: '/dev-docs/api/rest/relations#disconnect', }, { type: 'link', label: 'set', - href: '/dev-docs/api/rest/relations#set' + href: '/dev-docs/api/rest/relations#set', }, - ] + ], }, - ] + ], }, { - type: "category", - label: "Rest API guides", + type: 'category', + label: 'Rest API guides', collapsed: false, link: { type: 'doc', @@ -1125,28 +1080,28 @@ const sidebars = { }, items: [ { - type: "doc", - label: "Understanding populate", + type: 'doc', + label: 'Understanding populate', id: 'dev-docs/api/rest/guides/understanding-populate', }, { - type: "doc", - label: "How to populate creator fields", + type: 'doc', + label: 'How to populate creator fields', id: 'dev-docs/api/rest/guides/populate-creator-fields', }, { type: 'link', label: 'Additional resources', - href: '/dev-docs/api/rest/guides/intro#additional-resources' + href: '/dev-docs/api/rest/guides/intro#additional-resources', }, ], - } + }, ], devDocsConfigSidebar: [ { type: 'link', label: '⬅️ Back to Dev Docs content', - href: '/dev-docs/intro' + href: '/dev-docs/intro', }, { type: 'category', @@ -1168,7 +1123,7 @@ const sidebars = { label: 'Base configurations', link: { type: 'doc', - id: 'dev-docs/configurations' + id: 'dev-docs/configurations', }, items: [ 'dev-docs/configurations/database', @@ -1176,7 +1131,7 @@ const sidebars = { 'dev-docs/configurations/admin-panel', 'dev-docs/configurations/middlewares', 'dev-docs/configurations/api', - ] + ], }, { type: 'category', @@ -1184,7 +1139,7 @@ const sidebars = { collapsed: false, link: { type: 'doc', - id: 'dev-docs/configurations' + id: 'dev-docs/configurations', }, items: [ 'dev-docs/configurations/plugins', @@ -1195,7 +1150,7 @@ const sidebars = { 'dev-docs/configurations/environment', 'dev-docs/configurations/sso', 'dev-docs/configurations/features', - ] + ], }, { type: 'category', @@ -1203,7 +1158,7 @@ const sidebars = { collapsed: false, link: { type: 'doc', - id: 'dev-docs/configurations' + id: 'dev-docs/configurations', }, items: [ 'dev-docs/configurations/guides/rbac', @@ -1211,76 +1166,75 @@ const sidebars = { 'dev-docs/configurations/guides/access-cast-environment-variables', 'dev-docs/configurations/guides/access-configuration-values', 'dev-docs/configurations/guides/use-cron-jobs', - ] - } - ] + ], + }, + ], }, ], devDocsMigrationV5Sidebar: [ { type: 'link', label: '⬅️ Back to Dev Docs content', - href: '/dev-docs/intro' + href: '/dev-docs/intro', }, { type: 'category', collapsed: false, link: { type: 'doc', - id: 'dev-docs/migration/v4-to-v5/introduction-and-faq' + id: 'dev-docs/migration/v4-to-v5/introduction-and-faq', }, label: 'Upgrade to Strapi 5', - customProps: { - new: true, - }, items: [ { - type: "doc", - label: "Introduction and FAQ", - id: "dev-docs/migration/v4-to-v5/introduction-and-faq" + type: 'doc', + label: 'Introduction and FAQ', + id: 'dev-docs/migration/v4-to-v5/introduction-and-faq', }, { - type: "doc", - label: "Step-by-step guide", - id: "dev-docs/migration/v4-to-v5/step-by-step" + type: 'doc', + label: 'Step-by-step guide', + id: 'dev-docs/migration/v4-to-v5/step-by-step', }, { - type: "doc", - label: "Upgrade tool reference", + type: 'doc', + label: 'Upgrade tool reference', id: 'dev-docs/upgrade-tool', }, { - type: "category", + type: 'category', collapsible: true, collapsed: true, - label: "Breaking changes", + label: 'Breaking changes', link: { type: 'doc', - id: 'dev-docs/migration/v4-to-v5/breaking-changes' + id: 'dev-docs/migration/v4-to-v5/breaking-changes', }, items: [ { - type: "autogenerated", - dirName: 'dev-docs/migration/v4-to-v5/breaking-changes' + type: 'autogenerated', + dirName: 'dev-docs/migration/v4-to-v5/breaking-changes', }, - ] + ], }, { type: 'category', label: 'Specific resources', collapsed: false, - link: { type: 'doc', id: 'dev-docs/migration/v4-to-v5/additional-resources/introduction' }, + link: { + type: 'doc', + id: 'dev-docs/migration/v4-to-v5/additional-resources/introduction', + }, items: [ 'dev-docs/migration/v4-to-v5/additional-resources/introduction', 'dev-docs/migration/v4-to-v5/additional-resources/from-entity-service-to-document-service', 'dev-docs/migration/v4-to-v5/additional-resources/plugins-migration', 'dev-docs/migration/v4-to-v5/additional-resources/helper-plugin', - ] - } - ] + ], + }, + ], }, - - ] + ], }; module.exports = sidebars; diff --git a/docusaurus/src/scss/_mixins.scss b/docusaurus/src/scss/_mixins.scss index 3e6d164b96..66d847a889 100644 --- a/docusaurus/src/scss/_mixins.scss +++ b/docusaurus/src/scss/_mixins.scss @@ -14,6 +14,12 @@ } } +@mixin medium-to-intermediate { + @media (min-width: 997px) and (max-width: 1298px) { + @content; + } +} + /** Mixin: Responsive */ @mixin large-up { @media (min-width: 1536px) { diff --git a/docusaurus/src/scss/badge.scss b/docusaurus/src/scss/badge.scss index f8f1533483..ed36863396 100644 --- a/docusaurus/src/scss/badge.scss +++ b/docusaurus/src/scss/badge.scss @@ -108,6 +108,20 @@ h2 .badge { --custom-badge-inside-titles-top: -.3em; } +.menu { + .badge { + &--new, + &--updated { + font-size: .65rem; + } + + &--updated { + padding-left: 6px; + padding-right: 6px; + } + } +} + /** Dark mode */ @include dark { .badge { diff --git a/docusaurus/src/scss/custom-search-bar.scss b/docusaurus/src/scss/custom-search-bar.scss index 4ee692e2b3..c21710ca45 100644 --- a/docusaurus/src/scss/custom-search-bar.scss +++ b/docusaurus/src/scss/custom-search-bar.scss @@ -43,6 +43,7 @@ } .kapa-widget-button { + width: 100%; appearance: none; background: none; border: none; @@ -100,6 +101,42 @@ } } +@include medium-to-intermediate { + .my-custom-search-bar { + max-width: 200px; + margin-top: 10px; + margin-bottom: 10px; + + .DocSearch-Button, + .kapa-widget-button { + * { + font-size: 12px !important; + } + } + + .kapa-widget-button { + position: relative; + top: -1px; + svg { + width: 12px; + margin-left: 4px; + // height: 10px; + } + } + .DocSearch-Button { + svg { + margin-right: -4px; + width: 12px; + height: 12px; + } + &-Keys { + position: relative; + top: 0; + } + } + } +} + @include dark { .my-custom-search-bar { background: var(--strapi-neutral-0); diff --git a/docusaurus/src/scss/navbar.scss b/docusaurus/src/scss/navbar.scss index b577ea7c9a..75146b9d30 100644 --- a/docusaurus/src/scss/navbar.scss +++ b/docusaurus/src/scss/navbar.scss @@ -34,12 +34,12 @@ $selector-color-mode-toggle-wrapper: 'div[class*="ColorModeToggle"]'; &__items { max-width: var(--custom-navbar-items-width); gap: var(--strapi-spacing-2); + height: 100%; } &__brand, &__logo { height: auto; - line-height: 0; } &__brand { @@ -243,6 +243,28 @@ $selector-color-mode-toggle-wrapper: 'div[class*="ColorModeToggle"]'; } } +@include medium-to-intermediate { + .navbar__logo img { + width: 150px; + height: 23px; + } + .navbar__items { + padding-right: 20px; + + &--right { + padding-right: 0; + } + } + .navbar__item { + font-size: 13px; + line-height: 14px; + } + [class*="oggleIcon"] { // purposedly omitting the "t" because selectors vary in production and local envs + width: 20px; + height: 20px; + } +} + @include dark { .kapa-widget-button { button { diff --git a/docusaurus/src/scss/sidebar.scss b/docusaurus/src/scss/sidebar.scss index 25b112fa5f..9cafa71862 100644 --- a/docusaurus/src/scss/sidebar.scss +++ b/docusaurus/src/scss/sidebar.scss @@ -162,6 +162,10 @@ $selector-color-mode-toggle-wrapper: 'div[class*="ColorModeToggle"]'; > .menu__list-item-collapsible { font-weight: 700; font-size: var(--strapi-font-size-sm); + + > .menu__link--sublist { + font-size: 16px; + } } } } diff --git a/docusaurus/static/img/assets/admin-panel-customization/red-login-button.png b/docusaurus/static/img/assets/admin-panel-customization/red-login-button.png new file mode 100644 index 0000000000..a1accc812f Binary files /dev/null and b/docusaurus/static/img/assets/admin-panel-customization/red-login-button.png differ diff --git a/docusaurus/static/img/assets/cloud/account-billing2.png b/docusaurus/static/img/assets/cloud/account-billing2.png index 97bc5f55cb..81064ed93b 100644 Binary files a/docusaurus/static/img/assets/cloud/account-billing2.png and b/docusaurus/static/img/assets/cloud/account-billing2.png differ diff --git a/docusaurus/static/img/assets/cloud/account-billing2_DARK.png b/docusaurus/static/img/assets/cloud/account-billing2_DARK.png index e637e41649..58aa94b4ac 100644 Binary files a/docusaurus/static/img/assets/cloud/account-billing2_DARK.png and b/docusaurus/static/img/assets/cloud/account-billing2_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/deploy-logs.png b/docusaurus/static/img/assets/cloud/deploy-logs.png deleted file mode 100644 index 712b057340..0000000000 Binary files a/docusaurus/static/img/assets/cloud/deploy-logs.png and /dev/null differ diff --git a/docusaurus/static/img/assets/cloud/deploy-logs_DARK.png b/docusaurus/static/img/assets/cloud/deploy-logs_DARK.png deleted file mode 100644 index ee07fb849e..0000000000 Binary files a/docusaurus/static/img/assets/cloud/deploy-logs_DARK.png and /dev/null differ diff --git a/docusaurus/static/img/assets/cloud/deploy_logs.png b/docusaurus/static/img/assets/cloud/deploy_logs.png index 1df4bdebf0..56a14e3d85 100644 Binary files a/docusaurus/static/img/assets/cloud/deploy_logs.png and b/docusaurus/static/img/assets/cloud/deploy_logs.png differ diff --git a/docusaurus/static/img/assets/cloud/deploy_logs_DARK.png b/docusaurus/static/img/assets/cloud/deploy_logs_DARK.png index 7b2b8892d0..0ea768053b 100644 Binary files a/docusaurus/static/img/assets/cloud/deploy_logs_DARK.png and b/docusaurus/static/img/assets/cloud/deploy_logs_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/environments.png b/docusaurus/static/img/assets/cloud/environments.png index f6ad58c661..1380b26398 100644 Binary files a/docusaurus/static/img/assets/cloud/environments.png and b/docusaurus/static/img/assets/cloud/environments.png differ diff --git a/docusaurus/static/img/assets/cloud/environments_DARK.png b/docusaurus/static/img/assets/cloud/environments_DARK.png index b9298c1d18..3ec9fe600b 100644 Binary files a/docusaurus/static/img/assets/cloud/environments_DARK.png and b/docusaurus/static/img/assets/cloud/environments_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/project-creation-1.png b/docusaurus/static/img/assets/cloud/project-creation-1.png index deafa9ec65..f6fa0b48aa 100644 Binary files a/docusaurus/static/img/assets/cloud/project-creation-1.png and b/docusaurus/static/img/assets/cloud/project-creation-1.png differ diff --git a/docusaurus/static/img/assets/cloud/project-creation-1_DARK.png b/docusaurus/static/img/assets/cloud/project-creation-1_DARK.png index fe1b2d4648..a339cf7e9d 100644 Binary files a/docusaurus/static/img/assets/cloud/project-creation-1_DARK.png and b/docusaurus/static/img/assets/cloud/project-creation-1_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/project-creation-2.png b/docusaurus/static/img/assets/cloud/project-creation-2.png index 03ef262b0c..3651abe263 100644 Binary files a/docusaurus/static/img/assets/cloud/project-creation-2.png and b/docusaurus/static/img/assets/cloud/project-creation-2.png differ diff --git a/docusaurus/static/img/assets/cloud/project-creation-2_DARK.png b/docusaurus/static/img/assets/cloud/project-creation-2_DARK.png index eae2ae6db0..3d6f239f83 100644 Binary files a/docusaurus/static/img/assets/cloud/project-creation-2_DARK.png and b/docusaurus/static/img/assets/cloud/project-creation-2_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/settings-general.png b/docusaurus/static/img/assets/cloud/settings-general.png index 9e10563822..0cd72d5d7a 100644 Binary files a/docusaurus/static/img/assets/cloud/settings-general.png and b/docusaurus/static/img/assets/cloud/settings-general.png differ diff --git a/docusaurus/static/img/assets/cloud/settings-general_DARK.png b/docusaurus/static/img/assets/cloud/settings-general_DARK.png index 65b582df93..db03454989 100644 Binary files a/docusaurus/static/img/assets/cloud/settings-general_DARK.png and b/docusaurus/static/img/assets/cloud/settings-general_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/settings.png b/docusaurus/static/img/assets/cloud/settings.png index 4cb6813718..de0274fa8d 100644 Binary files a/docusaurus/static/img/assets/cloud/settings.png and b/docusaurus/static/img/assets/cloud/settings.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_DARK.png b/docusaurus/static/img/assets/cloud/settings_DARK.png index cf052430f7..597632e38e 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_DARK.png and b/docusaurus/static/img/assets/cloud/settings_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_backups.png b/docusaurus/static/img/assets/cloud/settings_backups.png index 48220c1f98..3a1140373e 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_backups.png and b/docusaurus/static/img/assets/cloud/settings_backups.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_backups_DARK.png b/docusaurus/static/img/assets/cloud/settings_backups_DARK.png index 58db972e65..4ba4ab3561 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_backups_DARK.png and b/docusaurus/static/img/assets/cloud/settings_backups_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_billing.png b/docusaurus/static/img/assets/cloud/settings_billing.png index a7e34def40..0aa22b0db9 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_billing.png and b/docusaurus/static/img/assets/cloud/settings_billing.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_billing_DARK.png b/docusaurus/static/img/assets/cloud/settings_billing_DARK.png index 9237324c80..b18a0a9685 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_billing_DARK.png and b/docusaurus/static/img/assets/cloud/settings_billing_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_domains.png b/docusaurus/static/img/assets/cloud/settings_domains.png index bc98b790cb..ff083799da 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_domains.png and b/docusaurus/static/img/assets/cloud/settings_domains.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_domains_DARK.png b/docusaurus/static/img/assets/cloud/settings_domains_DARK.png index 92cb75ed86..ea32632953 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_domains_DARK.png and b/docusaurus/static/img/assets/cloud/settings_domains_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_env.png b/docusaurus/static/img/assets/cloud/settings_env.png index a897f88d76..f8e0bd7f91 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_env.png and b/docusaurus/static/img/assets/cloud/settings_env.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_env_DARK.png b/docusaurus/static/img/assets/cloud/settings_env_DARK.png index 26142c2188..be90e3dbcf 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_env_DARK.png and b/docusaurus/static/img/assets/cloud/settings_env_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_invoices.png b/docusaurus/static/img/assets/cloud/settings_invoices.png index 592ce4b726..7f6021bd13 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_invoices.png and b/docusaurus/static/img/assets/cloud/settings_invoices.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_invoices_DARK.png b/docusaurus/static/img/assets/cloud/settings_invoices_DARK.png index c262ae35d9..53b6ce910c 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_invoices_DARK.png and b/docusaurus/static/img/assets/cloud/settings_invoices_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_plans.png b/docusaurus/static/img/assets/cloud/settings_plans.png index a9b2b4c799..3760cc222b 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_plans.png and b/docusaurus/static/img/assets/cloud/settings_plans.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_plans_DARK.png b/docusaurus/static/img/assets/cloud/settings_plans_DARK.png index a51c4d7d1a..29e3109f68 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_plans_DARK.png and b/docusaurus/static/img/assets/cloud/settings_plans_DARK.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_variables.png b/docusaurus/static/img/assets/cloud/settings_variables.png index c226390e61..737e41cd0f 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_variables.png and b/docusaurus/static/img/assets/cloud/settings_variables.png differ diff --git a/docusaurus/static/img/assets/cloud/settings_variables_DARK.png b/docusaurus/static/img/assets/cloud/settings_variables_DARK.png index e1666c6c9e..903497ad83 100644 Binary files a/docusaurus/static/img/assets/cloud/settings_variables_DARK.png and b/docusaurus/static/img/assets/cloud/settings_variables_DARK.png differ diff --git a/docusaurus/static/img/assets/releases/release-details.png b/docusaurus/static/img/assets/releases/release-details.png index 5e7e66234c..ecb5a9029f 100644 Binary files a/docusaurus/static/img/assets/releases/release-details.png and b/docusaurus/static/img/assets/releases/release-details.png differ diff --git a/docusaurus/static/img/assets/releases/release-details_DARK.png b/docusaurus/static/img/assets/releases/release-details_DARK.png index 4c3b6a125e..36af073160 100644 Binary files a/docusaurus/static/img/assets/releases/release-details_DARK.png and b/docusaurus/static/img/assets/releases/release-details_DARK.png differ diff --git a/docusaurus/static/img/assets/review-workflows/review-workflows.png b/docusaurus/static/img/assets/review-workflows/review-workflows.png index 00e0ee93c5..0ed84a5071 100644 Binary files a/docusaurus/static/img/assets/review-workflows/review-workflows.png and b/docusaurus/static/img/assets/review-workflows/review-workflows.png differ diff --git a/docusaurus/static/img/assets/review-workflows/review-workflows_DARK.png b/docusaurus/static/img/assets/review-workflows/review-workflows_DARK.png index ced46f8c6a..8f58b364ef 100644 Binary files a/docusaurus/static/img/assets/review-workflows/review-workflows_DARK.png and b/docusaurus/static/img/assets/review-workflows/review-workflows_DARK.png differ diff --git a/docusaurus/static/js/ext-signals.js b/docusaurus/static/js/ext-signals.js new file mode 100644 index 0000000000..7e8ff208c3 --- /dev/null +++ b/docusaurus/static/js/ext-signals.js @@ -0,0 +1,18 @@ +(function() { + if (typeof window === 'undefined') return; + if (typeof window.signals !== 'undefined') return; + var script = document.createElement('script'); + script.src = 'https://cdn.cr-relay.com/v1/site/d071dd4e-fd79-4841-88a9-d0fd342b1e39/signals.js'; + script.async = true; + window.signals = Object.assign( + [], + ['page', 'identify', 'form'].reduce(function (acc, method){ + acc[method] = function () { + signals.push([method, arguments]); + return signals; + }; + return acc; + }, {}) + ); + document.head.appendChild(script); +})(); diff --git a/docusaurus/vercel.json b/docusaurus/vercel.json index e28253febc..6e9b5ac6ef 100644 --- a/docusaurus/vercel.json +++ b/docusaurus/vercel.json @@ -192,6 +192,10 @@ "source": "/developer-docs/latest/setup-deployment-guides/configurations/optional/rbac.html", "destination": "/dev-docs/configurations/guides/rbac" }, + { + "source": "/dev-docs/rbac", + "destination": "/dev-docs/configurations/guides/rbac" + }, { "source": "/developer-docs/latest/setup-deployment-guides/configurations/optional/api.html", "destination": "/dev-docs/configurations/api" @@ -1186,8 +1190,8 @@ "destination": "https://strapi.io/integrations/svelte-cms" }, { - "source": "/dev-docs/integrations/vue", - "destination": "https://strapi.io/integrations/vuejs-cms" + "source": "/developer-docs/latest/developer-resources/content-api/integrations/vue-js.html%23create-a-vue-js-app", + "destination": "/dev-docs/integrations/vue-js" }, { "source": "/dev-docs/integrations",