maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[DOCS] Fixes formatting in plugin and l10 docs (#34594)

Browse source
This commit is contained in:
gchaps 2019-04-05 07:01:16 -07:00 committed by gchaps
parent 247ff942ce
commit fcf30e8fef
3 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/development.asciidoc
View file

@ -15,6 +15,10 @@ include::development/core-development.asciidoc[]
include::development/plugin-development.asciidoc[]
include::development/visualize/development-visualize-index.asciidoc[]
include::development/add-data-guide.asciidoc[]
include::development/security/index.asciidoc[]
include::development/pr-review.asciidoc[]

6
docs/development/plugin-development.asciidoc
View file

@ -10,9 +10,6 @@ The Kibana plugin interfaces are in a state of constant development. We cannot
* <<development-uiexports>>
* <<development-plugin-functional-tests>>
* <<development-plugin-localization>>
* <<development-visualize-index>>
* <<add-data-guide>>
include::plugin/development-plugin-resources.asciidoc[]
@ -22,6 +19,3 @@ include::plugin/development-plugin-functional-tests.asciidoc[]
include::plugin/development-plugin-localization.asciidoc[]
include::visualize/development-visualize-index.asciidoc[]
include::add-data-guide.asciidoc[]

10
docs/development/plugin/development-plugin-localization.asciidoc
View file

@ -66,9 +66,9 @@ This outputs a `en.json` file inside the `translations` directory. To localize o
Checking i18n does the following:
* Checks all existing labels for violations.
* Takes translations from .i18nrc.json and compares them to the messages extracted and validated at the step above and:
* Takes translations from `.i18nrc.json` and compares them to the messages extracted and validated at the step above and:
** Checks for unused translations. If you remove a label that has a corresponding translation, you must also remove the label from the translations file.
* Checks for incompatible translations. If you add or remove a new parameter from an existing string, you must also remove the label from the translations file.
** Checks for incompatible translations. If you add or remove a new parameter from an existing string, you must also remove the label from the translations file.
To check your i18n translations, run the following command:
@ -84,7 +84,9 @@ node scripts/i18n_check --fix --include-config ../kibana-extra/myPlugin/.i18nrc.
Kibana relies on several UI frameworks (ReactJS and AngularJS) and
requires localization in different environments (browser and NodeJS).
The internationalization engine is framework agnostic and consumable in
all parts of Kibana (ReactJS, AngularJS and NodeJS). In order to simplify
all parts of Kibana (ReactJS, AngularJS 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]
@ -161,4 +163,4 @@ To learn more about i18n tooling, see {blob}src/dev/i18n/README.md[i18n dev tool
To learn more about implementing i18n in the UI, follow the links below:
* {blob}packages/kbn-i18n/README.md[i18n plugin]
* {blob}packages/kbn-i18n/GUIDELINE.md[i18n Guidelines]
* {blob}packages/kbn-i18n/GUIDELINE.md[i18n guidelines]