| Page properties | ||
|---|---|---|
|
Status
Current state: "Under Discussion"
...
...
JIRA:
...
|
...
|
...
|
Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).
...
- Adjust our PR review bot to include a "updated required English documentation" & "opened a JIRA for Chinese documentation translation sync" checks. A PR should not be merged without these checks being approved. Also should add the checklist to Review Checklist on website.
- Add a "zhchinese-doc" label (names TBD) translation" component to our JIRA, which should be tagged on Chinese documentation sync JIRAs opened in the previous step.
- Add a translation guideline in our contribute documentation page, including educating Chinese-speaking developers to search for these labels in JIRA.
...
The English version content is still in original URL. The Chinese version content will be build into the subdirectory /zh under the original URL. For example:
flink-web | flink/docs | |
English version | ||
Chinese version |
File Name and File Directory Structure
...
Here is an example of the new file structure and the build result
file structure | build result |
|
|
Compatibility, Deprecation, and Migration Plan
...
# What is Docusaurus and crowdin ?
Docusaurus [1] is is a documentation framework which supports document versioning and localization (via crowdin). IMO, Docusaurus is something similar to Jekyll.
Crowdin[2] is is a localization management platform. Users can upload contents (e.g. markdown source files) to crowdin and translate, collaborate, manage process on crowdin.
The English contents is kept in the original repository, and the multiple language translated contents is kept in crowdin. We need to download the translated contents from crowdin and build them into localization website.
Apache Pulsar is using them for Docusaurus for website and documentation as @Sijie mentioned above.
Here is the Pulsar project on crowdin [3]. : https://crowdin.com/project/apache-pulsar/zh-CN#
And here is a test project for Flink I created [4]. https://crowdin.com/project/flink-test/zh-CN#
# How can Flink fit into them?
I'm afraid that Flink is hard to fit into Docusaurus unless we rework our website/docs from Jekyll to Docusaurus.
...