[jira] [Comment Edited] (FLINK-18496) Anchors are not generated based on ZH characters
[ https://issues.apache.org/jira/browse/FLINK-18496?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17283923#comment-17283923 ] Zhilong Hong edited comment on FLINK-18496 at 2/18/21, 2:52 AM: -Since the document is migrated from Jekyll to Hugo in FLINK-21193, I think this issue is no longer valid and can be closed.- cc [~zhuzh] was (Author: thesharing): Since the document is migrated from Jekyll to Hugo in FLINK-21193, I think this issue is no longer valid and can be closed. cc [~zhuzh] > Anchors are not generated based on ZH characters > > > Key: FLINK-18496 > URL: https://issues.apache.org/jira/browse/FLINK-18496 > Project: Flink > Issue Type: Bug > Components: Project Website >Reporter: Zhu Zhu >Assignee: Zhilong Hong >Priority: Major > Labels: starter > > In ZH version pages of flink-web, the anchors are not generated based on ZH > characters. The anchor name would be like 'section-1', 'section-2' if there > is no EN characters. An example can be the links in the navigator of > https://flink.apache.org/zh/contributing/contribute-code.html > This makes it impossible to ref an anchor from the content because the anchor > name might change unexpectedly if a new section is added. > Note that it is a problem for flink-web only. The docs generated from the > flink repo can properly generate ZH anchors. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Comment Edited] (FLINK-18496) Anchors are not generated based on ZH characters
[
https://issues.apache.org/jira/browse/FLINK-18496?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17167107#comment-17167107
]
Zhilong Hong edited comment on FLINK-18496 at 7/29/20, 10:18 AM:
-
Thank you for your concern, Jark. The plugin works in flink/docs because there
is no docs in {{_posts}} folder in flink/docs. In other words, there is no
excerpt generated in flink/docs.
At first I use Jekyll 4.0.1. If I move files from {{_posts}} to a new folder in
flink-web, the build succeeds, though the Flink Blog page breaks down.
Then I use Jekyll 4.1.1, because in 4.1.1, it introduces excerpts for all the
pages instead of {{_posts}} only. After moving files from {{_posts}} to a new
folder in flink-web, I use Jekyll 4.1.1 instead of 4.0.1 and enable excerpts
for all the pages. The build fails. I think this proves that the plugin is
conflict with the excerpt generation.
was (Author: thesharing):
Thank you for your concern, Jark. The plugin works in flink/docs because there
is no docs in {{_posts}} folder in flink/docs. In other words, there is no
excerpt generated in flink/docs.
At first I use Jekyll 4.0.1. If I move files from {{_posts}} to a new folder in
flink-web, the build succeeds, though the Flink Blog page breaks down.
Then I use Jekyll 4.1.1, because in 4.1.1, it introduces excerpts for all the
pages instead of {{_posts}} only. After moving files from {{_posts}} to a new
folder in flink-web ,I use Jekyll 4.1.1 instead of 4.0.1 and enable excerpts
for all the pages. The build fails. I think this proves that the plugin is
conflict with the excerpt generation.
> Anchors are not generated based on ZH characters
>
>
> Key: FLINK-18496
> URL: https://issues.apache.org/jira/browse/FLINK-18496
> Project: Flink
> Issue Type: Bug
> Components: Project Website
>Reporter: Zhu Zhu
>Assignee: Zhilong Hong
>Priority: Major
> Labels: starter
>
> In ZH version pages of flink-web, the anchors are not generated based on ZH
> characters. The anchor name would be like 'section-1', 'section-2' if there
> is no EN characters. An example can be the links in the navigator of
> https://flink.apache.org/zh/contributing/contribute-code.html
> This makes it impossible to ref an anchor from the content because the anchor
> name might change unexpectedly if a new section is added.
> Note that it is a problem for flink-web only. The docs generated from the
> flink repo can properly generate ZH anchors.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Comment Edited] (FLINK-18496) Anchors are not generated based on ZH characters
[ https://issues.apache.org/jira/browse/FLINK-18496?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17166815#comment-17166815 ] Zhilong Hong edited comment on FLINK-18496 at 7/29/20, 2:36 AM: I try to use the Gemfile in flink/docs, but it doesn't work. In my opinion, the main blocker is that "jekyll-multiple-language" is conflict with the *excerpt* in Jekyll 4. I'm still working on this, but it seems difficult to solve this issue. was (Author: thesharing): I try to use the Gemfile in flink/docs, but it doesn't work. In my opinion, the main blocker is that "jekyll-multiple-language" is conflict with the *excerpt* in Jekyll 4. I'm still working on this, but it seems hard to solve this issue. > Anchors are not generated based on ZH characters > > > Key: FLINK-18496 > URL: https://issues.apache.org/jira/browse/FLINK-18496 > Project: Flink > Issue Type: Bug > Components: Project Website >Reporter: Zhu Zhu >Assignee: Zhilong Hong >Priority: Major > Labels: starter > > In ZH version pages of flink-web, the anchors are not generated based on ZH > characters. The anchor name would be like 'section-1', 'section-2' if there > is no EN characters. An example can be the links in the navigator of > https://flink.apache.org/zh/contributing/contribute-code.html > This makes it impossible to ref an anchor from the content because the anchor > name might change unexpectedly if a new section is added. > Note that it is a problem for flink-web only. The docs generated from the > flink repo can properly generate ZH anchors. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Comment Edited] (FLINK-18496) Anchors are not generated based on ZH characters
[ https://issues.apache.org/jira/browse/FLINK-18496?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17166049#comment-17166049 ] Zhilong Hong edited comment on FLINK-18496 at 7/28/20, 2:52 AM: Change `_post` into another folder name works. The build succeeds. But the references of `_post` have to be modified according to the new folder name. I'm working on this. was (Author: thesharing): Change `_post` into another folder name works. The build succeeds. But the references of `_post` have to be modified according to the new folder name. > Anchors are not generated based on ZH characters > > > Key: FLINK-18496 > URL: https://issues.apache.org/jira/browse/FLINK-18496 > Project: Flink > Issue Type: Bug > Components: Project Website >Reporter: Zhu Zhu >Assignee: Zhilong Hong >Priority: Major > Labels: starter > > In ZH version pages of flink-web, the anchors are not generated based on ZH > characters. The anchor name would be like 'section-1', 'section-2' if there > is no EN characters. An example can be the links in the navigator of > https://flink.apache.org/zh/contributing/contribute-code.html > This makes it impossible to ref an anchor from the content because the anchor > name might change unexpectedly if a new section is added. > Note that it is a problem for flink-web only. The docs generated from the > flink repo can properly generate ZH anchors. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Comment Edited] (FLINK-18496) Anchors are not generated based on ZH characters
[
https://issues.apache.org/jira/browse/FLINK-18496?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17165660#comment-17165660
]
Zhilong Hong edited comment on FLINK-18496 at 7/28/20, 1:43 AM:
I think the issue is related to the posts.
1. In flink/docs there is no {{_posts}} folder, so I copy the {{_posts}} folder
from flink-web to flink/docs. The same issue appears in flink/docs. It fails to
build the doc, too.
2. If I move the posts from {{_post}} folder to other folders in flink-web, the
build succeeds.
3. If I remove the plugin "jekyll-multiple-language" in {{_config.yml}} and
compile the English/Chinese version separately, the build succeeds.
Since the plugin "jekyll-multiple-language" is no longer maintained since 2015,
and the last version it supports is jekyll 3, I think the plugin is
incompatible with posts in the {{_post}} folder. In addition, there are similar
issues in the repo of the plugin:
https://github.com/liaohuqiu/jekyll-multiple-languages/issues/19 .
Also when I remove the files in {{_post}} folder, the build succeeds. And the
anchors are generated correctly. So I think the upgrading the version of jekyll
can solve the anchor issue, but we need to replace "jekyll-multiple-language"
with alternatives like
https://github.com/kurtsson/jekyll-multiple-languages-plugin. The main
challenge is: their usage are different, which may introduce a lot of changes
and new issues.
was (Author: thesharing):
I think the issue is related to the posts.
1. In flink/docs there is no `_posts` folder, so I copy the `_posts` folder
from flink-web to flink/docs. The same issue appears in flink/docs. It fails to
build the doc, too.
2. If I move the posts from `_post` folder to other folders in flink-web, the
build succeeds.
3. If I remove the plugin "jekyll-multiple-language" in `_config.yml` and
compile the English/Chinese version separately, the build succeeds.
Since the plugin "jekyll-multiple-language" is no longer maintained since 2015,
and the last version it supports is jekyll 3, I think the plugin is
incompatible with posts in the `_post` folder. In addition, there are similar
issues in the repo of the plugin:
https://github.com/liaohuqiu/jekyll-multiple-languages/issues/19 .
Also when I remove the files in `_post` folder, the build succeeds. And the
anchors are generated correctly. So I think the upgrading the version of jekyll
can solve the anchor issue, but we need to replace "jekyll-multiple-language"
with alternatives like
https://github.com/kurtsson/jekyll-multiple-languages-plugin. The main
challenge is: their usage are different, which may introduce a lot of changes
and new issues.
> Anchors are not generated based on ZH characters
>
>
> Key: FLINK-18496
> URL: https://issues.apache.org/jira/browse/FLINK-18496
> Project: Flink
> Issue Type: Bug
> Components: Project Website
>Reporter: Zhu Zhu
>Assignee: Zhilong Hong
>Priority: Major
> Labels: starter
>
> In ZH version pages of flink-web, the anchors are not generated based on ZH
> characters. The anchor name would be like 'section-1', 'section-2' if there
> is no EN characters. An example can be the links in the navigator of
> https://flink.apache.org/zh/contributing/contribute-code.html
> This makes it impossible to ref an anchor from the content because the anchor
> name might change unexpectedly if a new section is added.
> Note that it is a problem for flink-web only. The docs generated from the
> flink repo can properly generate ZH anchors.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Comment Edited] (FLINK-18496) Anchors are not generated based on ZH characters
[
https://issues.apache.org/jira/browse/FLINK-18496?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17165675#comment-17165675
]
Jark Wu edited comment on FLINK-18496 at 7/27/20, 12:44 PM:
Thanks a lot for investigating this issue [~Thesharing]!
The jekyll-multiple-languages-plugin has been considered when we started the
Chinese translation in FLIP-35. But we gave it up becuase of the large
refactoring work.
Did you try to change the {{_post}} into another folder name? Because the
{{_post}} folder is just used to hold the source code and is not a public path
in the URL. So I think it's fine to rename it.
was (Author: jark):
Thanks a lot for investigating this issue [~Thesharing]!
The jekyll-multiple-languages-plugin has been considered when we started the
Chinese translation in FLIP-35. But we gave it up becuase of the refactoring
effort.
Did you try to change the {{_post}} into another folder name? Because the
{{_post}} folder is just used to hold the source code and is not a public path
in the URL. So I think it's fine to rename it.
> Anchors are not generated based on ZH characters
>
>
> Key: FLINK-18496
> URL: https://issues.apache.org/jira/browse/FLINK-18496
> Project: Flink
> Issue Type: Bug
> Components: Project Website
>Reporter: Zhu Zhu
>Assignee: Zhilong Hong
>Priority: Major
> Labels: starter
>
> In ZH version pages of flink-web, the anchors are not generated based on ZH
> characters. The anchor name would be like 'section-1', 'section-2' if there
> is no EN characters. An example can be the links in the navigator of
> https://flink.apache.org/zh/contributing/contribute-code.html
> This makes it impossible to ref an anchor from the content because the anchor
> name might change unexpectedly if a new section is added.
> Note that it is a problem for flink-web only. The docs generated from the
> flink repo can properly generate ZH anchors.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Comment Edited] (FLINK-18496) Anchors are not generated based on ZH characters
[ https://issues.apache.org/jira/browse/FLINK-18496?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17161253#comment-17161253 ] Andrey Zagrebin edited comment on FLINK-18496 at 7/20/20, 1:40 PM: --- The `Gemfiles` are indeed different in `flink-web` and `flink/docs`, `flink-web` having older versions, e.g. `jekyll`. One could try to update versions to see whether it resolves this issue. The local `Gemfile.lock` file might need to be deleted. was (Author: azagrebin): The `Gemfiles` are indeed different in `flink-web` and `flink/docs`, `flink-web` having older versions, e.g. `jekyll`. One could try to update versions to see whether it resolves this issue. > Anchors are not generated based on ZH characters > > > Key: FLINK-18496 > URL: https://issues.apache.org/jira/browse/FLINK-18496 > Project: Flink > Issue Type: Bug > Components: Project Website >Reporter: Zhu Zhu >Priority: Major > Labels: starter > > In ZH version pages of flink-web, the anchors are not generated based on ZH > characters. The anchor name would be like 'section-1', 'section-2' if there > is no EN characters. An example can be the links in the navigator of > https://flink.apache.org/zh/contributing/contribute-code.html > This makes it impossible to ref an anchor from the content because the anchor > name might change unexpectedly if a new section is added. > Note that it is a problem for flink-web only. The docs generated from the > flink repo can properly generate ZH anchors. -- This message was sent by Atlassian Jira (v8.3.4#803005)
