Dev docs updates: Internationalization plugin #224

pwizla · 2021-04-08T14:19:13Z

What does it do?

Addition of a new link in Development > Strapi plugins
Addition of a whole new "Internationalization" document that:
- quickly introduces i18n
- and describes in detail how to use the i18n plugin
  * with the Content API
  * and with the GraphQL plugin
Update sidebar for easier access to Strapi plugins
Update some parts of Content API and GraphQL plugin docs so that readers are aware of i18n plugin docs

This reverts commit 00302e8.

This reverts commit 5545dc8.

* Better examples for GET and POST requests * "Updating an entry" content is no longer a callout * Add some in-code comments, questions and todos * Various linting updates

This will be transferred to another PR.

Convly

LGTM, it looks really cool overall, I'll play a bit more with it tomorrow 🙂

meganelacheny

LGTM 🚀
This is a really nice documentation, great job @pwizla ! 👏

docs/.vuepress/theme/global-components/PluginsLinks.vue

Co-authored-by: meganelacheny <megane.lacheny@strapi.io>

alexandrebodin

One precision but the rest looks good to me :)

docs/developer-docs/latest/developer-resources/content-api/content-api.md

docs/developer-docs/latest/development/plugins/graphql.md

lauriejim

LGTM good job 🚀

docs/developer-docs/latest/developer-resources/content-api/content-api.md

docs/developer-docs/latest/development/plugins/i18n.md

derrickmehaffy · 2021-04-16T22:24:47Z

docs/developer-docs/latest/development/plugins/i18n.md

+
+**Example request**
+
+```js


Vuepress uses prismjs and this is their list of supported codes: https://prismjs.com/#supported-languages

Thanks for the tip, @derrickmehaffy ! Honestly I was not too sure about what to use when I was writing, and re-used what we did for Content API.

But looking at the list you shared, http seems more appropriate.

I changed it here and I'll create another PR for other similar code blocks in the repo.

derrickmehaffy · 2021-04-16T22:26:51Z

docs/developer-docs/latest/development/plugins/i18n.md

+When creating a localization for existing localized entries, the body of the POST request can only accept localized fields.
+
+::: tip TIP
+The Content-Type should have the [`createlocalization` permission](http://localhost:8080/documentation/user-docs/latest/users-roles-permissions/configuring-administrator-roles.md#collection-and-single-types) enabled, otherwise the POST request will return a `403: Forbidden` status.


used a localhost:8080 address here :P

Oh, nice catch! 😅 Thanks @derrickmehaffy ! fixed it

derrickmehaffy · 2021-04-16T22:28:49Z

It shows my comments on the js code for syntax highlighting as required changes, they aren't just comments.

derrickmehaffy · 2021-04-19T15:22:52Z

This pull request has been mentioned on Strapi Community Forum. There might be relevant details there:

https://forum.strapi.io/t/content-internationalization-i18n-beta-is-live/3892/50

derrickmehaffy · 2021-04-19T17:48:01Z

This pull request has been mentioned on Strapi Community Forum. There might be relevant details there:

https://forum.strapi.io/t/content-internationalization-i18n-beta-is-live/3892/51

alexandrebodin · 2021-04-20T15:01:34Z

docs/developer-docs/latest/development/plugins/i18n.md

+A `STRAPI_PLUGIN_I18N_INIT_LOCALE_CODE` [environment variable](/developer-docs/latest/setup-deployment-guides/configurations.md#environment-variables) can be configured to set the initialization locale for your environment. The value used for this variable should be a string (see [full list of available locales](https://github.com/strapi/strapi/blob/features/i18n/packages/strapi-plugin-i18n/constants/iso-locales.json)).

-The value used for this variable should be a string (see [full list of available locales](https://github.com/strapi/strapi/blob/features/i18n/packages/strapi-plugin-i18n/constants/iso-locales.json)).
+This is useful when a Strapi app is deployed in production, with the i18n plugin installed and enabled on your content types for the first time. On a fresh i18n plugin installation, `'en'` is the default locale. So if the database does not contain any locale, and no `STRAPI_PLUGIN_I18N_INIT_LOCALE_CODE` is set for the environment, all the existing content saved in the database will be migrated with the locale defined as `'en'`. But if the `STRAPI_PLUGIN_I18N_INIT_LOCALE_CODE` is defined, then the content will be migrated and set up with this locale. This will prevent from manually updating the locale for every existing content entry.


instead of all the existing content I would have said that the content of the content types with i18n enabled will be auto migrated to the locale. The rest looks good to me!

Thanks @alexandrebodin ! I've just updated it :-)

derrickmehaffy

lgtm

pwizla and others added 22 commits April 1, 2021 19:32

Add new Locale subsection to Content API > Parameters

00302e8

Update PUT requests in Content API with locale info

a1fb491

Add locale info to POST requests in Content API

5545dc8

Add very basic draft of i18n plugin entry in Strapi plugins

9da0164

Add i18n link to plugins section

cc211b6

temp dump into i18n md

462567a

Revert "Add new Locale subsection to Content API > Parameters"

5058215

This reverts commit 00302e8.

Revert PUT entry in content api to move i18n info

5ce7a72

Revert "Add locale info to POST requests in Content API"

8f32f76

This reverts commit 5545dc8.

Add rewritten draft of dev docs for i18n plugin

7f293f0

Enhance i18n dev docs draft

91797e8

* Better examples for GET and POST requests * "Updating an entry" content is no longer a callout * Add some in-code comments, questions and todos * Various linting updates

Revert fix to content-api.md about Updating an entry

67a9f94

This will be transferred to another PR.

Merge branch 'main' into dev/i18n

747e78b

Fix Upload → i18n in PluginsLink comment 😅

6890e67

Merge branch 'dev/i18n' of github.com:strapi/documentation into dev/i18n

a69e9e8

Merge branch 'main' into dev/i18n

4ea91ec

Update comments in i18n dev docs

d4d5f42

Merge branch 'dev/i18n' of github.com:strapi/documentation into dev/i18n

5a41495

Add description meta tag for i18n in dev docs

82ed45d

Improve headings structure of i18n dev docs

148820a

Add collapsable list of Strapi plugins to sidebar

4139167

Reduce sidebar depth for Strapi plugins

6041417

pwizla force-pushed the dev/i18n branch from 85184be to 6041417 Compare April 9, 2021 13:23

pwizla added 2 commits April 9, 2021 15:31

Add title meta tag to i18n dev docs

fbfaa3a

Add some links to user guide to i18n dev docs

6939c4b

pwizla force-pushed the dev/i18n branch from fa87498 to 6939c4b Compare April 9, 2021 13:55

Simplify sidebarDepth config for Strapi plugins

cd933bd

derrickmehaffy requested review from derrickmehaffy and meganelacheny April 9, 2021 14:09

pwizla requested a review from lauriejim April 9, 2021 14:11

Convly approved these changes Apr 15, 2021

View reviewed changes

meganelacheny approved these changes Apr 16, 2021

View reviewed changes

docs/.vuepress/theme/global-components/PluginsLinks.vue Outdated Show resolved Hide resolved

Update docs/.vuepress/theme/global-components/PluginsLinks.vue

2a6d9e2

Co-authored-by: meganelacheny <megane.lacheny@strapi.io>

pwizla requested a review from alexandrebodin April 16, 2021 08:15

alexandrebodin requested changes Apr 16, 2021

View reviewed changes

docs/developer-docs/latest/developer-resources/content-api/content-api.md Outdated Show resolved Hide resolved

docs/developer-docs/latest/development/plugins/graphql.md Outdated Show resolved Hide resolved

lauriejim approved these changes Apr 16, 2021

View reviewed changes

pwizla and others added 3 commits April 16, 2021 13:35

Mention permission for i18n in GraphQL and Content API docs

6f9d372

Add missing dot at end of sentence from prev commit 😅

90b5a5b

Merge branch 'main' into dev/i18n

fc99aa6

alexandrebodin requested changes Apr 16, 2021

View reviewed changes

docs/developer-docs/latest/developer-resources/content-api/content-api.md Outdated Show resolved Hide resolved

Update prerequisite for i18n queries in GraphQL & Content API

4736edd

alexandrebodin approved these changes Apr 16, 2021

View reviewed changes

pwizla added 2 commits April 16, 2021 17:50

Update i18n dev docs about plugin being installed by default

dc47d3c

Turn link to update version, from i18n prerequisistes, to an interal one

074ffe8

derrickmehaffy requested changes Apr 16, 2021

View reviewed changes

pwizla added 2 commits April 19, 2021 09:37

Replace js by http as a language in request examples code blocks

c2a40cb

Remove forgotten localhost from documentation link in i18n.md

14feba2

pwizla added 2 commits April 20, 2021 14:59

Add default locale configuration documentation for i18n plugin

b1d8b4f

Clarify i18n init locale use case and update env vars table accordingly

49b6b1d

alexandrebodin reviewed Apr 20, 2021

View reviewed changes

pwizla and others added 3 commits April 20, 2021 17:53

Improve on i18n init locale use case description

8001b38

Merge branch 'main' into dev/i18n

9b7c371

Merge branch 'main' into dev/i18n

596ea16

derrickmehaffy approved these changes Apr 21, 2021

View reviewed changes

Merge branch 'main' into dev/i18n

ba49c0a

pwizla merged commit 8ca0420 into main Apr 21, 2021

pwizla deleted the dev/i18n branch April 21, 2021 13:26


		Example request

		```js

Dev docs updates: Internationalization plugin #224

Dev docs updates: Internationalization plugin #224

Uh oh!

Conversation

pwizla commented Apr 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does it do?

Uh oh!

Convly left a comment

Choose a reason for hiding this comment

Uh oh!

meganelacheny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alexandrebodin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lauriejim left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

derrickmehaffy Apr 16, 2021

Choose a reason for hiding this comment

Uh oh!

pwizla Apr 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

derrickmehaffy Apr 16, 2021

Choose a reason for hiding this comment

Uh oh!

pwizla Apr 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

derrickmehaffy commented Apr 16, 2021

Uh oh!

derrickmehaffy commented Apr 19, 2021

Uh oh!

derrickmehaffy commented Apr 19, 2021

Uh oh!

alexandrebodin Apr 20, 2021

Choose a reason for hiding this comment

Uh oh!

pwizla Apr 20, 2021

Choose a reason for hiding this comment

Uh oh!

derrickmehaffy left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

pwizla commented Apr 8, 2021 •

edited

Loading

pwizla Apr 19, 2021 •

edited

Loading

pwizla Apr 19, 2021 •

edited

Loading