diff --git a/docs/.vuepress/config/theme-config.js b/docs/.vuepress/config/theme-config.js index 84bc905631..82cb9130d9 100644 --- a/docs/.vuepress/config/theme-config.js +++ b/docs/.vuepress/config/theme-config.js @@ -87,15 +87,15 @@ const themeConfig = { }, ] }, - { - text: 'Pre-release Documentation', - items: [ - { - text: 'docs-next', - link: 'https://docs-next.strapi.io', - }, - ] - }, + // { // temporarily disabled while we move to Docusaurus + // text: 'Pre-release Documentation', + // items: [ + // { + // text: 'docs-next', + // link: 'https://docs-next.strapi.io', + // }, + // ] + // }, ], }, { diff --git a/docs/package.json b/docs/package.json index 2e8b792a34..c8e4c849c9 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,6 +1,6 @@ { "name": "strapi-docs", - "version": "4.4.6", + "version": "4.5.0", "main": "index.js", "scripts": { "dev": "yarn create:config-file && vuepress dev", diff --git a/docs/user-docs/latest/assets/content-manager/RF_multiple-choices2.png b/docs/user-docs/latest/assets/content-manager/RF_multiple-choices2.png new file mode 100644 index 0000000000..9bfe61afe7 Binary files /dev/null and b/docs/user-docs/latest/assets/content-manager/RF_multiple-choices2.png differ diff --git a/docs/user-docs/latest/assets/content-manager/RF_one-choice2.png b/docs/user-docs/latest/assets/content-manager/RF_one-choice2.png new file mode 100644 index 0000000000..f81c38dfc7 Binary files /dev/null and b/docs/user-docs/latest/assets/content-manager/RF_one-choice2.png differ diff --git a/docs/user-docs/latest/assets/content-manager/content-manager_translate2.png b/docs/user-docs/latest/assets/content-manager/content-manager_translate2.png new file mode 100644 index 0000000000..1e6b7a9c60 Binary files /dev/null and b/docs/user-docs/latest/assets/content-manager/content-manager_translate2.png differ diff --git a/docs/user-docs/latest/assets/content-manager/edit-view-config2.png b/docs/user-docs/latest/assets/content-manager/edit-view-config2.png new file mode 100644 index 0000000000..17939fe38a Binary files /dev/null and b/docs/user-docs/latest/assets/content-manager/edit-view-config2.png differ diff --git a/docs/user-docs/latest/assets/content-manager/edit-view2.png b/docs/user-docs/latest/assets/content-manager/edit-view2.png new file mode 100644 index 0000000000..7145ece640 Binary files /dev/null and b/docs/user-docs/latest/assets/content-manager/edit-view2.png differ diff --git a/docs/user-docs/latest/assets/content-manager/edit-view_relational-fields2.png b/docs/user-docs/latest/assets/content-manager/edit-view_relational-fields2.png new file mode 100644 index 0000000000..cdbc3ce7e8 Binary files /dev/null and b/docs/user-docs/latest/assets/content-manager/edit-view_relational-fields2.png differ diff --git a/docs/user-docs/latest/assets/content-manager/editing_draft_version2.png b/docs/user-docs/latest/assets/content-manager/editing_draft_version2.png new file mode 100644 index 0000000000..ae32cb5d28 Binary files /dev/null and b/docs/user-docs/latest/assets/content-manager/editing_draft_version2.png differ diff --git a/docs/user-docs/latest/assets/content-manager/editing_published_version2.png b/docs/user-docs/latest/assets/content-manager/editing_published_version2.png new file mode 100644 index 0000000000..e0e87d2225 Binary files /dev/null and b/docs/user-docs/latest/assets/content-manager/editing_published_version2.png differ diff --git a/docs/user-docs/latest/assets/plugins/installed-providers.png b/docs/user-docs/latest/assets/plugins/installed-providers.png deleted file mode 100644 index e3d746960a..0000000000 Binary files a/docs/user-docs/latest/assets/plugins/installed-providers.png and /dev/null differ diff --git a/docs/user-docs/latest/assets/plugins/marketplace-plugins.png b/docs/user-docs/latest/assets/plugins/marketplace-plugins.png new file mode 100644 index 0000000000..18a5600185 Binary files /dev/null and b/docs/user-docs/latest/assets/plugins/marketplace-plugins.png differ diff --git a/docs/user-docs/latest/assets/users-permissions/end-user_content-manager2.png b/docs/user-docs/latest/assets/users-permissions/end-user_content-manager2.png new file mode 100644 index 0000000000..408a2ddac4 Binary files /dev/null and b/docs/user-docs/latest/assets/users-permissions/end-user_content-manager2.png differ diff --git a/docs/user-docs/latest/content-manager/configuring-view-of-content-type.md b/docs/user-docs/latest/content-manager/configuring-view-of-content-type.md index 4cbcab6ca9..38e0058f9c 100644 --- a/docs/user-docs/latest/content-manager/configuring-view-of-content-type.md +++ b/docs/user-docs/latest/content-manager/configuring-view-of-content-type.md @@ -69,7 +69,7 @@ Note also that relational fields have a couple limitations when it comes to sort In the edit view of a content-type, in the right side of the interface, a **Configure the view** button is displayed. It allows to access the configurations that can be set for the edit view of the content-type, such as the entry title, and the display of the fields of the content-type, including the relational ones. -![Configuring the edit view of the Content Manager](../assets/content-manager/edit-view-config.png) +![Configuring the edit view of the Content Manager](../assets/content-manager/edit-view-config2.png) ### Edit view settings @@ -85,19 +85,20 @@ In the edit view of a content-type, in the right side of the interface, a **Conf ### Edit view display 1. In the edit view of your content-type, click on the **Configure the view** button. -2. In the View area, define what fields to display in the list view table, in what order and what size: - - Click the add button ![Add icon](../assets/icons/add_icon.svg) to add a new field. +2. In the View area, define what fields (including relational fields) to display in the list view table, in what order and what size: + - Click the ![Add icon](../assets/icons/add_icon.svg) **Insert another field** button to add a new field. - Click the delete button ![Clear icon](../assets/icons/clear.svg) to remove a field. - Click the reorder button ![Drag icon](../assets/icons/drag.svg) and drag and drop it to the place you want it to be displayed among the other fields. 3. Click the edit button ![Edit icon](../assets/icons/edit.svg) of a field to access its available settings: | Setting name | Instructions | | --------------- | ----------------------------------------------------------------------------------------- | -| Label | Write the label to should be used for the field. | +| Label | Write the label that should be used for the field. | | Description | Write a description for the field, to help other administrators fill it properly. | | Placeholder | Write the placeholder that should be displayed by default in the field. | | Editable field | Click on **ON** or **OFF** to able or disable the edition of the field by administrators. | | Size | Select the size in which the field should be displayed in the Content Manager. Note that this setting is neither available for JSON and Rich Text fields, nor dynamic zones and components. | +| Entry title | *(relational fields only)* Write the entry title that should be used for the relational field. It is recommended to choose well the entry title of relational fields as the more comprehensive it is, the easier it will be for administrators to manage the content of relational fields from the edit view. | 4. Click on the **Save** button. @@ -106,15 +107,3 @@ The settings and display of a component's fields cannot be managed and reordered Note also that the settings are defined for the component itself, which means that the settings will automatically be applied for every other content-type where the component is used. ::: - -#### Relational fields - -On the right side of the View area is displayed a Relational fields part. As in the edit view, regular fields and relational fields are managed separately (see [Managing relational fields](managing-relational-fields.md)). Although most configuration options are similar to regular fields', relational fields configurations have some specificities. - -To define what relational fields of an entry should be available in the edit view, the following options are available: - -- the **Insert another relational field** button, to add another relational field to your entry. If the button remains unclickable, it means that no other relational field can be added. -- the delete button ![Clear icon](../assets/icons/clear.svg), to remove a relational field. -- the reorder button ![Drag icon](../assets/icons/drag.svg), to drag and drop to the place you want your relational field to be displayed among the others. - -As for regular fields, it is possible to access the available settings of the relational fields by clicking on their name. Most settings are the same as for regular fields (see [Edit view display](./configuring-view-of-content-type.md#edit-view-display)) except for "Entry title" which is only available for relational fields. It is recommended to choose well the entry title of relational fields as the more comprehensive it is, the easier it will be for administrators to manage the content of relational fields from the edit view. diff --git a/docs/user-docs/latest/content-manager/managing-relational-fields.md b/docs/user-docs/latest/content-manager/managing-relational-fields.md index b94175de41..08d8b89446 100644 --- a/docs/user-docs/latest/content-manager/managing-relational-fields.md +++ b/docs/user-docs/latest/content-manager/managing-relational-fields.md @@ -6,11 +6,9 @@ canonicalUrl: https://docs.strapi.io/user-docs/latest/content-manager/managing-r # Managing relational fields -Relation-type fields added to a content-type from the Content-type Builder allow establishing a relation with another collection type. These fields are called "relational fields". +Relation-type fields added to a content-type from the Content-type Builder allow establishing a relation with another collection type. These fields are called "relational fields". -Relational fields are before all else regular fields, meaning that their content is written from the edit view of the content-type they belong to (see [Writing content](writing-content.md)). - -However, relational fields can point to one or several entries of the other content-type, this is why in the Content Manager it is possible to manage a content-type's relational fields to choose which entries are relevant. +The content of relational fields is written from the edit view of the content-type they belong to (see [Writing content](writing-content.md)). However, relational fields can point to one or several entries of the other collection type, this is why in the Content Manager it is possible to manage a content-type's relational fields to choose which entries are relevant. ::: details Example In my Strapi admin panel I have created 2 collection types: @@ -23,14 +21,12 @@ I want to assign a category to each of my restaurants, therefore I have establis In the Content Manager, from the edit view of my Restaurant entries, I can manage the Category relational field, and choose which entry of Category is relevant for my restaurant. ::: -![Relations box in the edit view](../assets/content-manager/edit-view_relational-fields.png) - -The relational fields of a content-type are managed from the Relations box, located in the right side of the edit view interface. It lists the names of the relational fields. Under each relational field name is displayed a drop-down list containing all available entry titles. +![Relations box in the edit view](../assets/content-manager/edit-view_relational-fields2.png) -The Relations box allows to choose which entries the relational fields should point to. You can either choose one or several entries depending on the type of relation that was established. +The relational fields of a content-type are displayed among regular fields. For each relational field is displayed a drop-down list containing all available entry titles. It allows to choose which entry the relational fields should point to. You can either choose one or several entries depending on the type of relation that was established. ::: tip -Instead of choosing an entry by scrolling the list, you can click any drop-down list from the Relations box and type to search a specific entry. +Not all entries are listed by default: more can be displayed by clicking on the **Load more** button. Also, instead of choosing an entry by scrolling the list, you can click any relational field drop-down list and type to search a specific entry. ::: ::: note @@ -45,15 +41,15 @@ If the [Internationalization plugin](/user-docs/latest/plugins/strapi-plugins.md Many-to-one, one-to-one, and one-way types of relation only allow to choose one entry per relational field. -One-choice relational fields +One-choice relational fields To select the only relevant relational field's entry: -1. In the Relations box of your content-type's edit view, click on the drop-down list of the relational field. +1. In the content-type's edit view, click on the drop-down list of the relational field. 2. Among the list of entries, choose one. ::: tip -Click on **Details** to be redirected to the edit view of the content-type the relational field originally belongs to. Make sure you save your page first, to avoid losing your last modifications. +You can click on the name of the selected entry to be redirected to the edit view of the relational field's content type. Make sure you save your page first, to avoid losing your last modifications. ::: To remove the entry selected in the drop-down list, click on the delete button ![Clear icon](../assets/icons/clear.svg). @@ -62,16 +58,16 @@ To remove the entry selected in the drop-down list, click on the delete button ! Many-to-many, one-to-many, and many-ways types of relation allow to choose several entries per relational field. -Multiple choices relational fields +Multiple choices relational fields To select the relevant relational field's entries: -1. In the Relations box of your content-type's edit view, click on the drop-down list of the relational field. +1. In the content-type's edit view, click on the drop-down list of the relational field. 2. Among the list of entries, choose one. 3. Repeat step 2 until all relevant entries have been chosen. ::: tip -All selected entries are listed right below the drop-down list. Click on the name of an entry to be redirected to the edit view of the content-type the relational field originally belongs to. +All selected entries are listed right below the drop-down list. Click on the name of an entry to be redirected to the edit view of the relational field's content-type. Make sure you save your page first, to avoid losing your last modifications. ::: To remove an entry, click on the remove button ![Minus icon](../assets/icons/minus.svg) in the selected entries list. diff --git a/docs/user-docs/latest/content-manager/saving-and-publishing-content.md b/docs/user-docs/latest/content-manager/saving-and-publishing-content.md index a072286219..dec3d96c4f 100644 --- a/docs/user-docs/latest/content-manager/saving-and-publishing-content.md +++ b/docs/user-docs/latest/content-manager/saving-and-publishing-content.md @@ -16,7 +16,7 @@ The possibility to manage drafts for contents comes from the Draft & Publish fea Your contents can have 2 statuses: draft or published. You can see the current status indicated on the right of the interface, above the Information box. -![Editing draft version](../assets/content-manager/editing_draft_version.png) +![Editing draft version](../assets/content-manager/editing_draft_version2.png) By default, each newly created content is a draft. Drafts can be modified and saved at will, using the **Save** button on the top right corner of the edit view, until they are ready to be published. @@ -30,7 +30,7 @@ Before publishing a draft, make sure it doesn't have relations with other non-pu When a content is not a draft anymore, but has been published, it is indicated on the right of the interface, above the Information box. -![Editing published version](../assets/content-manager/editing_published_version.png) +![Editing published version](../assets/content-manager/editing_published_version2.png) ::: tip To schedule publication, i.e. convert a draft to a published entry at a given date and time, you can follow [this technical guide](https://forum.strapi.io/t/schedule-publications/23184) which requires adding custom code to the Strapi application. diff --git a/docs/user-docs/latest/content-manager/translating-content.md b/docs/user-docs/latest/content-manager/translating-content.md index c4af277a9a..3ad8a99968 100644 --- a/docs/user-docs/latest/content-manager/translating-content.md +++ b/docs/user-docs/latest/content-manager/translating-content.md @@ -8,7 +8,7 @@ canonicalUrl: https://docs.strapi.io/user-docs/latest/content-manager/translatin With the [Internationalization plugin](/user-docs/latest/plugins/strapi-plugins.md#internationalization-plugin) installed, it is possible to manage content in more than one language, called "locale". To manage content in a specific locale, the latter must be added beforehand through the Internationalization settings (see [Configuring Internationalization locales](../settings/managing-global-settings.md#configuring-internationalization-locales)). -![Edit view of a localizable content-type](../assets/content-manager/content-manager_translate.png) +![Edit view of a localizable content-type](../assets/content-manager/content-manager_translate2.png) In the Content Manager, when the Internationalization plugin is installed, some options are added to the edit view: diff --git a/docs/user-docs/latest/content-manager/writing-content.md b/docs/user-docs/latest/content-manager/writing-content.md index 0d4a77bb89..31e4791f11 100644 --- a/docs/user-docs/latest/content-manager/writing-content.md +++ b/docs/user-docs/latest/content-manager/writing-content.md @@ -8,7 +8,7 @@ canonicalUrl: https://docs.strapi.io/user-docs/latest/content-manager/writing-co In Strapi, writing content consists in filling up fields, which are meant to contain specific content (e.g. text, numbers, media etc.). These fields were configured for the collection or single type beforehand, through the [Content-type Builder](/user-docs/latest/content-types-builder/introduction-to-content-types-builder.md). -![Edit view to write content](../assets/content-manager/edit-view.png) +![Edit view to write content](../assets/content-manager/edit-view2.png) ## Filling up fields @@ -24,9 +24,10 @@ To write or edit content: | Number | Write your number in the textbox. Up and down arrows, displayed on the right of the box, allow to increase or decrease the current number indicated in the textbox. | | Date | 1. Click the date and/or time box.
2. Choose a date using the calendar and/or a time among the list. | | Boolean | Click on **OFF** or **ON**. | +| Relation | Choose an entry from the drop-down list. See [Managing relational fields](/user-docs/latest/content-manager/managing-relational-fields.md) for more information. | | Email | Write a complete and valid email address. | | Password | Write a password.

💡 Click the eye icon, displayed on the right of the box, to show the password. | -| Enumeration | 1. Click the drop-down list.
2. Choose an item from the list. | +| Enumeration | 1. Click the drop-down list.
2. Choose an entry from the list. | | Media | 1. Click the media area.
2. Choose an asset from the [Media Library](/user-docs/latest/media-library/introduction-to-media-library.md) or from a [folder](/user-docs/latest/media-library/organizing-assets-with-folders.md) if you created some, or click the **Add more assets** button to add a new file to the Media Library.

💡 It is possible to drag and drop the chosen file in the media area. | | JSON | Write your content, in JSON format, in the code textbox. | | UID | Write a unique identifier in the textbox. A "Regenerate" button, displayed on the right of the box, allows to automatically generate a UID based on the content-type name. | diff --git a/docs/user-docs/latest/plugins/installing-plugins-via-marketplace.md b/docs/user-docs/latest/plugins/installing-plugins-via-marketplace.md index 0858c17080..cb015f8749 100644 --- a/docs/user-docs/latest/plugins/installing-plugins-via-marketplace.md +++ b/docs/user-docs/latest/plugins/installing-plugins-via-marketplace.md @@ -14,21 +14,25 @@ The Marketplace in the admin panel only displays v4 plugins, but all plugins for Keep in mind that v3 and v4 plugins are not cross-compatible, but that providers are compatible both with v3 and v4 plugins. ::: -![The Marketplace interface](../assets/plugins/installed-providers.png) +![The Marketplace interface](../assets/plugins/marketplace-plugins.png) The Plugins and Providers tabs display each plugin/provider on individual cards containing: - their name, sometimes followed by either of the following badges: - ![maintained by Strapi icon](../assets/icons/official-market.svg) to indicate it is made by Strapi, - ![verified by Strapi icon](../assets/icons/verified-marketplace.svg) to indicate it was verified by Strapi. +- the number of times the plugin/provider was starred on GitHub and downloaded - the description - a **Learn more** button for additional information, including detailed implementation instructions -- a **Copy install command** button to copy the installation command to the local clipboard. For any installed plugins and providers, this button is replaced by an indicator that it is already installed. +- a **Copy install command** button to copy the installation command to the local clipboard. This button is disabled if the plugin is not compatible with your current Strapi version. Hovering a disabled button displays the Strapi version with which the plugin is compatible. For any installed plugins and providers, this button is replaced by an indicator that it is already installed. In the top right corner of the Marketplace, the **Submit your plugin** button redirects to the Strapi Market where it is possible to submit your own plugin and provider. -::: tip -The search bar displays incremental search results based on the plugin/provider name and description. +::: tip TIPS + +- The search bar displays incremental search results based on the plugin/provider name and description. +- Use the "Sort by" button or set filters to find plugins more easily. + ::: ## Installing Marketplace plugins and providers diff --git a/docs/user-docs/latest/users-roles-permissions/managing-end-users.md b/docs/user-docs/latest/users-roles-permissions/managing-end-users.md index ffcce67691..64c5a74ada 100644 --- a/docs/user-docs/latest/users-roles-permissions/managing-end-users.md +++ b/docs/user-docs/latest/users-roles-permissions/managing-end-users.md @@ -12,7 +12,7 @@ With the [Users & Permissions plugin](../plugins/strapi-plugins.md#users-permiss With the Users & Permissions plugin, the end users and their account information are managed as a content-type. When the plugin is installed on a Strapi application, 3 collection types are automatically created (see [Users & Permissions plugin](../plugins/strapi-plugins.md#users-permissions-plugin)), including "User" which is the only one available directly in the Content Manager. -![Managing end users via the Content Manager](../assets/users-permissions/end-user_content-manager.png) +![Managing end users via the Content Manager](../assets/users-permissions/end-user_content-manager2.png) Registering new end users in a front-end application with the Users & Permissions plugin consists in adding a new entry to the User collection type (see [Introduction to the Content Manager](../content-manager/introduction-to-content-manager.md) for more information about the Content Manager). @@ -33,6 +33,6 @@ To create a new end-user account: | Password | (optional) Write a new password in the textbox. You can click on the eye icon for the password to be shown. | | Confirmed | (optional) Click **ON** for the end-user account to be confirmed. | | Blocked | (optional) Click **ON** to block the account of the end user, to prevent them to access content. | +| Role | (optional) Indicate the role that should be granted to the new end user. If this field is not filled in, the end user will be attributed the role set as default (see [Managing Users & Permissions plugin settings](../settings/configuring-users-permissions-plugin-settings.md)). | -4. In the Relation box, indicate the role that should be granted to the new end user. If this step is skipped, the end user will be attributed the role set as default (see [Managing Users & Permissions plugin settings](../settings/configuring-users-permissions-plugin-settings.md)). -5. Click on the **Save** button. +4. Click on the **Save** button.