apache
Google Season of Docs 2023: Dubbo 3.x version documentation translation.
Google Season of Docs (GSoD) 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 startpart - Translation for the
introductionpart - Translation for the
core featurespart - Translation for the
taskspart - Translation for the
referencespart
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
- Scope for introduction
- Scope for core features
- Scope for tasks
- Scope for reference
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, 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
I'm very interested in this project, and I'm constantly following Dubbo and microservices technology. I hope to contribute more to the Dubbo community, and I am up to the task.
I would love to be a part of it. May I know if there are any materials that need to be submitted?
You should check the GSoD timeline and make sure to submit the application form when the application slot is open.
Hello. I am very interested in Dubbo and this project, and hope to contribute to it. I have a high English literacy and can translate between Chinese and English. At the same time, I have more free time on weekends, so I can have more energy to finish projects, and I am familiar with Makedown syntax and can use Typora to write md documents. CI/CD for Github Actions is also slightly covered. I hope I can join you and contribute to it. My QQ mailbox is: [email protected]
Hello,
I am a sophomore majoring in Computer Science and Technology, and I am very interested in participating in the Google Season of Docs 2023 with the Dubbo 3.x version documentation translation project. I believe that I have the necessary skills and expertise to contribute high-quality technical documentation.
As a fluent speaker of both Chinese and English, I am confident in my ability to translate technical content accurately between the two languages. Additionally, I have a good understanding of Markdown, which is an essential tool for creating and formatting technical documents.
I am available on weekends to work on this project and am willing to put in the effort necessary to complete it successfully.
If given the opportunity, I would be honored to work with you on this project. Please feel free to contact me via my email: [email protected]. I look forward to hearing back from you soon.
Thank you for considering my application.
Best regards,
@chickenlj is there any specific email address where potential applicants are expected to drop their GSOD proposals? Also, when is the expected deadline for submitting proposals regarding the same?
@chickenlj is there any specific email address where potential applicants are expected to drop their GSOD proposals? Also, when is the expected deadline for submitting proposals regarding the same?
Google requires the writers to submit proposals to this place by filing a pull request. Besides that, you can also send your proposal to [email protected]
The program timeline can be found here: https://developers.google.com/season-of-docs/docs/timeline?hl=en
To everyone who is interested in this project, please submit proposals to the GSoD repo. You can also choose to send a copy of your proposal to [email protected].
Hello. I am very interested in Dubbo and this project, and hope to contribute to it. I have a high English literacy and can translate between Chinese and English. At the same time, I have more free time on weekends, so I can have more energy to finish projects, and I am familiar with Makedown syntax and can use Typora to write md documents. I hope I can join you and contribute to it. My QQ mailbox is: [email protected]
