[jira] [Comment Edited] (FLINK-13909) LinkElement does not support different anchors required for localization

["Zhu Zhu (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-13909?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16922299#comment-16922299 ] 

Zhu Zhu edited comment on FLINK-13909 at 9/4/19 8:57 AM:
---------------------------------------------------------

Here's my thoughts on docs/configs localisation.

We should have a key for each statement in docs and configs.

And then we can have different translations for those statements, maintained in different localisation files.

 

To simplify the key definition,

 

1. Doc statement key can be defined in base docs with some special marker, e.g.

{\{ @statement XXX }} base statement \{{ @endstatement }}

2. Config statement key can be defined using its config key with a special prefix, e.g.

{{_CONFIG#jobmanager.execution.failover-strategy_}}

 

Heading's anchor, in this way, can be the head statement key, thus to be the same in different localisation docs.


was (Author: zhuzh):
Here's my thoughts on docs/configs localisation.

We should have a key for each statement in docs and configs.

And then we can have different translations for those statements, maintained in different localisation files.

 

To simplify the key definition,

 

1. Doc statement key can be defined in base docs with some special marker, e.g.

{{_{ @statement XXX } base statement \{ @endstatement }_}}

2. Config statement key can be defined using its config key with a special prefix, e.g.

{{_CONFIG#jobmanager.execution.failover-strategy_}}

 

Heading's anchor, in this way, can be the head statement key, thus to be the same in different localisation docs.

> LinkElement does not support different anchors required for localization
> ------------------------------------------------------------------------
>
>                 Key: FLINK-13909
>                 URL: https://issues.apache.org/jira/browse/FLINK-13909
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 1.9.0, 1.10.0
>            Reporter: Till Rohrmann
>            Priority: Major
>
> While addressing FLINK-13898 we realized that the {{LinkElement}} does not support multiple anchors which are needed to support localisation. Due to the translation into Chinese the anchors are not the same across Flink's English and Chinese documentation.
> Either we keep anchors the same in both versions or we have a way to support multiple anchors, one for each localisation.



--
This message was sent by Atlassian Jira
(v8.3.2#803003)