apache / apache/kyuubi

[Umbrella] Support Chinese Documents and Website for Kyuubi

Open
#2,561 0 comments 0 reactions 0 assignees View on GitHub
kind:umbrella priority:major
Dominant language
Scala
Stars
2.4k
Forks
1k
PR merge metrics
No merged PRs in 30d

Description

### Code of Conduct

- [X] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)

### Search before asking

- [X] I have searched in the [issues](https://github.com/apache/incubator-kyuubi/issues) and found no similar issues.

### Describe the proposal

# Motivation
In order to better develop the kyuubi community, it would be helpful to support the Chinese website and documents.
# Implementation
## Chinese website
Kyuubi website is base on Hugo. Hugo is support multi-language, detail see [Multilingual Mode](https://gohugo.io/content-management/multilingual/).
Translation implements by two ways:
1. [Translation by content directory](https://gohugo.io/content-management/multilingual/#translation-by-content-directory) for `markdown` files. This way is set different directories for different languages. For instance, `src/en` for English markdown file and `src/zh` for Chinese markdown files.
2. [Translation of Strings](https://gohugo.io/content-management/multilingual/#query-basic-translation) for `HTML` files. This way is to define an id and then translation in the corresponding file, like `i18n/zh.toml` for Chinese and `i18n/en.toml` for English.

## Chinese document
Kyuubi document is build by Sphinx independent.I find It is not easy to combine two languages document together.

So my method is to put the different languages documents into different folders and compile them separately. And then link the different language documents to the different language Kyuubi website.

If you have a better way to do it, please let me know.

### Task list

- [ ] #2563
- [ ] Translation document to Chinese
- [ ] Link to the corresponding document

### Are you willing to submit PR?

- [ ] Yes I am willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Start with the Hugo website's multilingual configuration, including the `src/en`, `src/zh`, and `i18n/zh.toml`/`i18n/en.toml` locations mentioned in the proposal. Review how the Sphinx documents are built separately and inspect task #2563. Done means Chinese website and documentation are available in separate language paths and linked appropriately.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo
Domain
documentation, internationalization, localization, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.