Google Season of Docs 2023: Dubbo 3.x version documentation translation.
- Dominant language
- CSS
- Stars
- 491
- Forks
- 809
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 6
Description
[Google Season of Docs (GSoD)](https://developers.google.com/season-of-docs/docs?hl=en) is an excellent platform to connect the open-source community and technical writers. It provides motivation for open-source document participants through public welfare funds, which is an excellent opportunity for open-source technical writers.
Apache Dubbo is applying to join the GSoD 2023. Below are some detailed information about the topic. If you are interested in the topic, please leave a message at this Issue below and apply for registration through the official GSoD channel.
# Dubbo 3.x version documentation translation
## Project problem
According to statistics from Google Analytics, Apache Dubbo has successfully developed into an international project used by users and developers from around the world. Therefore, we need to ensure that we provide complete multilingual documentation.
In the Dubbo 2 version, we have well-organized documents in both Chinese and English languages, and the two language versions are basically updated synchronously. Last year, the community released Dubbo3, which is our next-generation microservice framework in the Cloud Native era.
The community has provided solid and complete documents in Chinese for Dubbo3, but the English version still stays in 2.x. So we want to find some voluntary technical writers to help us complete the translation work from Chinese to English.
The entire list of tasks involved in this project includes:
- Translation for the `quick start` part
- Translation for the `introduction` part
- Translation for the `core features` part
- Translation for the `tasks` part
- Translation for the `references` part
## Project scope
### In scope
We expect this project to:
- Help establish the technologies and procedures needed for translation
- Produce an initial set of translated documents for the 3.x version, this includes quick start, introduction, core features, tasks, and reference.
Task list:
- Scope for [quick start](https://cn.dubbo.apache.org/zh-cn/overview/quickstart/)
- Scope for [introduction](https://cn.dubbo.apache.org/zh-cn/overview/quickstart/)
- Scope for [core features](https://cn.dubbo.apache.org/zh-cn/overview/core-features/)
- Scope for [tasks](https://cn.dubbo.apache.org/zh-cn/overview/tasks/)
- Scope for [reference](https://cn.dubbo.apache.org/zh-cn/overview/mannual/)
### Out of scope
Apache Dubbo already has a solid and complete Chinese documentation for the 3.x version which can be served a good reference for the English version translation. Although we are definitely happty to see contributors contributing documentations for features that are not existing in the initial language (the Chinese version), we do not have the requirements of doing that. Just translate all Chinese documents existed by the time of the submission of the proposal into English is fine.
## Project success
We will consider the project a success if:
- The English version of each part is successfully published on the official Dubbo website at the end of this program.
- The published translations are evaluated by the Dubbo PMC members to have accurately described the related features.
## Project timeline
| **Dates** | **Action Items** |
| --- | --- |
| May | Orientation |
| June - August | Documentation translation |
| September | Translation review |
| October | Sencond round translation based on review input |
| November | Final Evaluation |
## Budget
We try to split the whole project into 5 parts, each participated by one technical writer (can be the same person).
| Budget items | Amountf (USD) | Running Total (USD) | Notes |
| --- | --- | --- | --- |
| Contributors to translate and review `quick start` part | 2000 | 2000 | |
| Contributors to translate and review `introduction` part | 2000 | 4000 | |
| Contributors to translate and review `core features` part | 2000 | 6000 | |
| Contributors to translate and review `tasks` part | 2000 | 8000 | |
| Contributors to translate and review `reference` part | 2000 | 10000 | |
| Project SWAG including T-shirts, stickers and shipping fee | 500 | 10500 | 5 x $100 each |
| Total | 10500 | | |
If necessary, the amounts will be adjusted according to the Google Summer of Code [Purchasing Power Parity table](https://developers.google.com/open-source/gsoc/help/student-stipends), depending on the country of origin of applicants.
### What skills would a technical writer need to work on this project?
- Must have: Fluent in both Chinese and English
- Must have: Good understanding of Hugo and Markdown
- Must have: Good understanding of Microservices and Apache Dubbo
- Must have: Good understanding of how GitHub works
- Nice to have: Familiarity with our GitHub CI in order to automatically update the documentation
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the linked Chinese Dubbo 3.x documentation scopes for quick start, introduction, core features, tasks, and reference, then review the repository's Hugo and Markdown documentation workflow. Done means the selected sections are translated into English, published on the official Dubbo website, and accurately reviewed by Dubbo PMC members.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, hugo, markdown
- Domain
- documentation, localization
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100