strapi · pwizla · Oct 28, 2024 · Oct 28, 2024 · Oct 28, 2024 · Oct 28, 2024
@@ -45,6 +45,8 @@ The Strapi Documentation team has created a complete style guide for you to make
 
 💁 While writing, please consider the [12 Rules of Technical Writing](https://handbook.strapi.io/user-success-manual/12-rules-of-technical-writing) that the Strapi Documentation team will use to assess the quality and consistency of the contribution. 😊
 
+⚠️ **Important: Please disable any linter or automatic formatting tool(s)** before saving and submitting your files. Not doing so could, at best, add unnecessary formatting changes to the submitted PR or, at worst, prevent Docusaurus from properly rendering some pages.
+
 ### Working locally: Set up the project
 
 To set up the Docusaurus project on your machine, perform the following steps from a terminal instance:

@@ -14,7 +14,7 @@ Before going any further into this Strapi Cloud documentation, we recommend you
 
 - **Hosting Platform** <br/> Strapi Cloud is a hosting platform that allows to deploy already existing Strapi projects created with Strapi CMS (Content Management System). Strapi Cloud is *not* the SaaS (Software as a Service) version of Strapi CMS. Feel free to refer to the [Developer Documentation](https://docs.strapi.io/dev-docs/intro) and [User Guide](https://docs.strapi.io/user-docs/intro) to learn more about Strapi CMS.
 
-- **Strapi Cloud Pricing Plans** <br/> As a Strapi Cloud user you have the choice between 3 tiers: Developer, Pro and Team. Depending on the tier, you have access to different functionalities, support and customization options (see [Pricing page](https://strapi.io/pricing-cloud) for more details). In this Strapi Cloud documentation, the <CloudDevBadge />, <CloudProBadge />, and <CloudTeamBadge /> badges can be displayed beside a section's title to indicate for which tier the feature is available.
+- **Strapi Cloud Pricing Plans** <br/> As a Strapi Cloud user you have the choice between 3 tiers: Developer, Pro and Team. Depending on the tier, you have access to different functionalities, support and customization options (see [Pricing page](https://strapi.io/pricing-cloud) for more details). In this Strapi Cloud documentation, the <CloudDevBadge />, <CloudProBadge />, and <CloudTeamBadge /> badges can be displayed below a section's title to indicate for which tier the feature is available.
 
 - **Strapi CMS Enterprise features** <br/> Some of Strapi features, usually accessible via the Enterprise Edition of Strapi CMS, are included in some Strapi Cloud tiers (see [Pricing page](https://strapi.io/pricing-cloud) and [Information on billing & usage](/cloud/getting-started/usage-billing) for more details). These features, highlighted with an <EnterpriseBadge /> badge, are documented in the [User Guide](https://docs.strapi.io/user-docs/intro) and the [Developer Documentation](https://docs.strapi.io/dev-docs/intro).
 

@@ -31,7 +31,7 @@ Strapi Cloud offers a free 14 days trial for all new accounts, and 3 paid plans:
 | **Content History** | 14 days retention | N/A | 14 days retention | 90 days retention |
 |  |  |  |  |  |
 | **Backups** | N/A | N/A | Weekly | Daily |
-| **Environments** | N/A | N/A | 0 included (up to 99 extra) | 1 included (up to 99 extra) |
+| **Environments** | N/A | N/A | 0 included (up to 99 extra) | 2 included (up to 99 extra) |
 
 :::strapi Additional information on usage and features
 - General features & usage:

@@ -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.

@@ -1,6 +1,7 @@
 ---
 title: Admin panel bundlers
 description: Learn more about configuring Vite and webpack with Strapi 5.
+displayed_sidebar: cmsSidebar
 sidebar_label: Bundlers
 toc_max_heading_level: 4
 tags:

@@ -1,6 +1,7 @@
 ---
 title: Admin panel deployment
 description: Learn more about deploying Strapi's admin panel in various scenarios.
+displayed_sidebar: cmsSidebar
 sidebar_label: Deployment
 toc_max_heading_level: 4
 tags:

@@ -1,6 +1,7 @@
 ---
 title: Admin panel extension
 description: Learn more about extending Strapi's admin panel.
+displayed_sidebar: cmsSidebar
 sidebar_label: Extension
 toc_max_heading_level: 4
 tags:

@@ -1,6 +1,7 @@
 ---
 title: Admin panel customization - URL, host, and path configuration
 description: Learn more about configuring the URL, host, and path to access Strapi's admin panel.
+displayed_sidebar: cmsSidebar
 sidebar_label: URL, host, and port configuration
 toc_max_heading_level: 4
 tags:

@@ -1,6 +1,7 @@
 ---
 title: Admin panel customization options
 description: Various options help you configure Strapi's administration panel behavior and look, so you can make it reflect your identity.
+displayed_sidebar: cmsSidebar
 sidebar_label: Customization options
 toc_max_heading_level: 4
 tags:

@@ -1,6 +1,7 @@
 ---
 title: Customizing the WYSIWYG editor
 description: Learn more about the various strategies available to customize the WYSIWYG editor in Strapi's admin panel.
+displayed_sidebar: cmsSidebar
 sidebar_label: WYSIWYG editor
 tags:
 - admin panel 

@@ -17,7 +17,7 @@ Strapi provides advanced built-in features for developers who'd like to get the
 
 <CustomDocCardsWrapper>
 
-<CustomDocCard emoji="🌍" title="Internationalization (i18n)" description="The i18n feature allows creating, managing and distributing localized content in different languages." link="/dev-docs/i18n"/>
+<CustomDocCard emoji="🌍" title="Internationalization (i18n)" description="The i18n feature allows creating, managing and distributing localized content in different languages." link="/user-docs/features/internationalization"/>
 
 <CustomDocCard title="CLI reference" description="Control Strapi through the Command Line Interface (CLI)." link="/dev-docs/cli" />
 
@@ -27,7 +27,7 @@ Strapi provides advanced built-in features for developers who'd like to get the
 
 <CustomDocCard title="Templates" description="Use and create pre-made Strapi applications designed for a specific purpose." link="/dev-docs/templates" />
 
-<CustomDocCard title="Data management" description="Use Strapi's built-in data management system to import, export, or transfer data." link="/dev-docs/data-management" />
+<CustomDocCard title="Data management" description="Use Strapi's built-in data management system to import, export, or transfer data." link="/user-docs/features/data-management" />
 
 <CustomDocCard title="Database migrations" description="Manage database migrations operations." link="/dev-docs/database-migrations" />
 

@@ -2,6 +2,7 @@
 title: Content API
 description: Learn more about Strapi 5's Content API
 displayed_sidebar: cmsSidebar
+sidebar_label: APIs Introduction
 pagination_prev: dev-docs/setup-deployment
 pagination_next: dev-docs/advanced-features
 tags:

@@ -1,6 +1,7 @@
 ---
 title: Using fields with the Document Service API
 description: Use Strapi's Document Service API to select the fields to return with your queries.
+sidebar_label: Fields
 displayed_sidebar: cmsSidebar
 tags:
 - API
@@ -24,7 +25,7 @@ import IdsInResponse from '/docs/snippets/id-in-responses.md'
 
 By default the [Document Service API](/dev-docs/api/document-service) returns all the fields of a document but does not populate any fields. This page describes how to use the `fields` parameter to return only specific fields with the query results.
 
-:::time.p
+:::tip
 You can also use the `populate` parameter to populate relations, media fields, components, or dynamic zones (see the [`populate` parameter](/dev-docs/api/document-service/populate) documentation).
 :::
 

@@ -2,6 +2,7 @@
 title: Using filters with the Document Service API
 description: This document provides information about the filters available in the Document Service API.
 displayed_sidebar: cmsSidebar
+sidebar_label: Filters
 tags:
 - API
 - Content API

@@ -2,6 +2,7 @@
 title: Using the locale parameter with the Document Service API
 description: Use Strapi's Document Service API to work with locale versions with your queries.
 displayed_sidebar: cmsSidebar
+sidebar_label: Locale
 tags:
 - API
 - Content API
@@ -21,7 +22,7 @@ tags:
 
 # Document Service API: Using the `locale` parameter
 
-By default the [Document Service API](/dev-docs/api/document-service) returns the default locale version of documents (which is 'en', i.e. the English version, unless another default locale has been set for the application, see [User Guide](/user-docs/settings/internationalization)). This page describes how to use the `locale` parameter to get or manipulate data only for specific locales.
+By default the [Document Service API](/dev-docs/api/document-service) returns the default locale version of documents (which is 'en', i.e. the English version, unless another default locale has been set for the application, see [Internationalization (i18n) feature](/user-docs/features/internationalization)). This page describes how to use the `locale` parameter to get or manipulate data only for specific locales.
 
 ## Get a locale version with `findOne()` {#find-one}
 

@@ -2,6 +2,7 @@
 title: Extending the Document Service behavior
 description: This document provides information about the middlewares in the Document Service API.
 toc_max_heading_level: 4
+sidebar_label: Middlewares
 displayed_sidebar: cmsSidebar
 ---
 

@@ -2,6 +2,7 @@
 title: Using Populate with the Document Service API
 description: Use Strapi's Document Service API to populate or select some fields.
 displayed_sidebar: cmsSidebar
+sidebar_label: Populate
 tags:
 - Components
 - Content API

@@ -2,6 +2,7 @@
 title: Using Sort & Pagination with the Document Service API
 description: Use Strapi's Document Service API to sort and paginate query results
 displayed_sidebar: cmsSidebar
+sidebar_label: Sort & Pagination
 tags:
 - API 
 - Content API 

@@ -2,6 +2,7 @@
 title: Using Draft & Publish with the Document Service API
 description: Use Strapi's Document Service API to return either the draft or the published version of a document
 displayed_sidebar: cmsSidebar
+sidebar_label: Status
 tags:
 - API
 - Content API

@@ -2,6 +2,7 @@
 title: Documents
 description: Learn what a Document is in Strapi v5
 displayed_sidebar: cmsSidebar
+sidebar_label: Document concept
 pagination_prev: dev-docs/api/content-api
 tags:
 - API

@@ -7,7 +7,6 @@ unlisted: true
 
 import EntityQueryKnex from '/docs/snippets/entity-query-knex.md'
 import BackendIntroCrosslink from '/docs/snippets/backend-custom-intro-crosslink.md'
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
 import ESdeprecated from '/docs/snippets/entity-service-deprecated.md'
 
 # Entity Service API

@@ -2,6 +2,7 @@
 title: Ordering & Pagination with the Entity Service API
 description: Use Strapi's Entity Service API to order and paginate queries results.
 displayed_sidebar: cmsSidebar
+unlisted: true
 ---
 
 import ESdeprecated from '/docs/snippets/entity-service-deprecated.md'

@@ -15,8 +15,6 @@ tags:
 - sort
 ---
 
-import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
-
 # GraphQL API
 
 The GraphQL API allows performing queries and mutations to interact with the [content-types](/dev-docs/backend-customization/models#content-types) through Strapi's [GraphQL plugin](/dev-docs/plugins/graphql.md). Results can be [filtered](#filters), [sorted](#sorting) and [paginated](#pagination).
@@ -463,7 +461,7 @@ mutation CreateCategory {
 ```
 
 :::tip
-If the Internationalization (i18n) feature is enabled for your content-type, you can create a document for a specific locale (see [i18n documentation](/dev-docs/i18n#graphql-create)).
+If the Internationalization (i18n) feature is enabled for your content-type, you can create a document for a specific locale (see [i18n documentation](/dev-docs/api/graphql#graphql-create)).
 :::
 
 ### Update an existing document
@@ -491,7 +489,7 @@ mutation UpdateRestaurant($documentId: ID!, $data: RestaurantInput!) {
 ```
 
 :::tip
-If the Internationalization (i18n) feature is enabled for your content-type, you can create a document for a specific locale (see [i18n documentation](/dev-docs/i18n#graphql-update)).
+If the Internationalization (i18n) feature is enabled for your content-type, you can create a document for a specific locale (see [i18n documentation](/dev-docs/api/graphql#graphql-update)).
 :::
 
 #### Update relations
@@ -529,7 +527,7 @@ mutation DeleteRestaurant {
 ```
 
 :::tip
-If the Internationalization (i18n) feature is enabled for your content-type, you can delete a specific localized version of a document (see [i18n documentation](/dev-docs/i18n#graphql-delete)).
+If the Internationalization (i18n) feature is enabled for your content-type, you can delete a specific localized version of a document (see [i18n documentation](/dev-docs/api/graphql#graphql-delete)).
 :::
 
 ### Mutations on media files
@@ -747,3 +745,148 @@ Pagination methods can not be mixed. Always use either `page` with `pageSize` or
 :::tip
 The default and maximum values for `pagination.limit` can be [configured in the `./config/plugins.js`](/dev-docs/configurations/plugins#graphql) file with the `graphql.config.defaultLimit` and `graphql.config.maxLimit` keys.
 :::
+
+## `locale` {#locale}
+
+The [Internationalization (i18n)](/user-docs/features/internationalization) feature adds new features to the GraphQL API:
+
+- The `locale` field is added to the GraphQL schema.
+- GraphQL can be used:
+  - to query documents for a specific locale with the `locale` argument
+  - for mutations to [create](#graphql-create), [update](#graphql-update), and [delete](#graphql-delete) documents for a specific locale
+
+### Fetch all documents in a specific locale {#graphql-fetch-all}
+
+To fetch all documents <DocumentDefinition/> for a specific locale, pass the `locale` argument to the query:
+
+<ApiCall>
+
+<Request> 
+
+```graphql
+query {
+  restaurants(locale: "fr") {
+    documentId
+    name
+    locale
+  }
+}
+```
+
+</Request>
+
+<Response>
+
+```json
+{
+  "data": {
+    "restaurants": [
+      {
+        "documentId": "a1b2c3d4e5d6f7g8h9i0jkl",
+        "name": "Restaurant Biscotte",
+        "locale": "fr"
+      },
+      {
+        "documentId": "m9n8o7p6q5r4s3t2u1v0wxyz",
+        "name": "Pizzeria Arrivederci",
+        "locale": "fr"
+      },
+    ]
+  }
+}
+```
+
+</Response>
+
+</ApiCall>
+
+### Fetch a document in a specific locale {#graphql-fetch}
+
+To fetch a documents <DocumentDefinition/> for a specific locale, pass the `documentId` and the `locale` arguments to the query:
+
+<ApiCall>
+
+<Request title="Example query"> 
+
+```graphql
+query Restaurant($documentId: ID!, $locale: I18NLocaleCode) {
+  restaurant(documentId: "a1b2c3d4e5d6f7g8h9i0jkl", locale: "fr") {
+    documentId
+    name
+    description
+    locale
+  }
+}
+```
+
+</Request>
+
+ <Response title="Example response"> 
+
+```json
+{
+  "data": {
+    "restaurant": {
+      "documentId": "lviw819d5htwvga8s3kovdij",
+      "name": "Restaurant Biscotte",
+      "description": "Bienvenue au restaurant Biscotte!",
+      "locale": "fr"
+    }
+  }
+}
+```
+
+</Response>
+</ApiCall>
+
+### Create a new localized document {#graphql-create}
+
+The `locale` field can be passed to create a localized document <DocumentDefinition/> for a specific locale (for more information about mutations with GraphQL, see [the GraphQL API documentation](/dev-docs/api/graphql#create-a-new-document)).
+
+```graphql title="Example: Create a new restaurant for the French locale"
+mutation CreateRestaurant($data: RestaurantInput!, $locale: I18NLocaleCode) {
+  createRestaurant(
+    data: {
+      name: "Brasserie Bonjour",
+      description: "Description in French goes here"
+    },
+    locale: "fr"
+  ) {
+  documentId
+  name
+  description
+  locale
+}
+```
+
+### Update a document for a specific locale {#graphql-update}
+
+A `locale` argument can be passed in the mutation to update a document <DocumentDefinition/> for a given locale (for more information about mutations with GraphQL, see [the GraphQL API documentation](/dev-docs/api/graphql#update-an-existing-document)).
+
+```graphql title="Example: Update the description field of restaurant for the French locale"
+mutation UpdateRestaurant($documentId: ID!, $data: RestaurantInput!, $locale: I18NLocaleCode) {
+  updateRestaurant(
+    documentId: "a1b2c3d4e5d6f7g8h9i0jkl"
+    data: {
+      description: "New description in French"
+    },
+    locale: "fr"
+  ) {
+  documentId
+  name
+  description
+  locale
+}
+```
+
+### Delete a locale for a document {#graphql-delete}
+
+Pass the `locale` argument in the mutation to delete a specific localization for a document <DocumentDefinition/>:
+
+```graphql
+mutation DeleteRestaurant($documentId: ID!, $locale: I18NLocaleCode) {
+  deleteRestaurant(documentId: "xzmzdo4k0z73t9i68a7yx2kk", locale: "fr") {
+    documentId
+  }
+}
+```