github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 03:01:21 -04:00
Code Issues Projects Releases Packages Wiki Activity

[i18n] a few docs updates (#127964)

Browse source
This commit is contained in:
Ahmad Bamieh 2022-03-17 18:18:49 +02:00 • committed by GitHub
parent f4c4fd6778
commit 3cc429d2cb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/developer/plugin/external-plugin-localization.asciidoc
View file

@ -83,18 +83,12 @@ node scripts/i18n_check --fix --include-config ../kibana-extra/myPlugin/.i18nrc.
[discrete]
=== Implementing i18n in the UI
{kib} relies on several UI frameworks (ReactJS and AngularJS) and
requires localization in different environments (browser and NodeJS).
{kib} relies on ReactJS and requires localization in different environments (browser and NodeJS).
The internationalization engine is framework agnostic and consumable in
all parts of {kib} (ReactJS, AngularJS and NodeJS).
all parts of {kib} (ReactJS, and NodeJS).
To simplify
internationalization in UI frameworks, additional abstractions are
built around the I18n engine: `react-intl` for React and custom
components for AngularJS. https://github.com/yahoo/react-intl[React-intl]
is built around https://github.com/yahoo/intl-messageformat[intl-messageformat],
so both React and AngularJS frameworks use the same engine and the same
message syntax.
To simplify internationalization in React, an additional abstraction is
built around the I18n engine using https://github.com/yahoo/react-intl[React-intl] for React.
[discrete]
@ -109,7 +103,7 @@ export const HELLO_WORLD = i18n.translate('hello.wonderful.world', {
});
-----------
Full details are {kib-repo}tree/master/packages/kbn-i18n#vanilla-js[here].
Full details are {kib-repo}tree/main/packages/kbn-i18n#vanilla-js[here].
[discrete]
==== i18n for React
@ -133,14 +127,14 @@ export const Component = () => {
};
-----------
Full details are {kib-repo}tree/master/packages/kbn-i18n#react[here].
Full details are {kib-repo}tree/main/packages/kbn-i18n#react[here].
[discrete]
=== Resources
To learn more about i18n tooling, see {blob}src/dev/i18n/README.md[i18n dev tooling].
To learn more about i18n tooling, see {kib-repo}blob/{branch}src/dev/i18n/README.md[i18n dev tooling].
To learn more about implementing i18n in the UI, use the following links:
* {blob}packages/kbn-i18n/README.md[i18n plugin]
* {blob}packages/kbn-i18n/GUIDELINE.md[i18n guidelines]
* {kib-repo}blob/{branch}packages/kbn-i18n/README.md[i18n plugin]
* {kib-repo}blob/{branch}packages/kbn-i18n/GUIDELINE.md[i18n guidelines]