rust-lang / rust-lang/book

Suggestions on managing translations

Open
#464 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

blocked upstream Enhancement Translations
Dominant language
Rust
Stars
18.3k
Forks
4.1k
Avg merge
14m
Merged PRs (30d)
1

Description

As the English edition of the book is also constantly revised. So it will cause the translation and the original does not correspond. There is a suggestion.
We can manage articles in paragraphs. First give each paragraph(and title) an id in original text. Such as:

<!-- title1 -->
# Introduction

<!-- paragraph1 -->
Welcome to “The Rust Programming Language,” an introductory book about Rust.
Rust is a programming language that’s focused on safety, speed, and
concurrency. Its design lets you create programs that have the performance and
control of a low-level language, but with the powerful abstractions of a
high-level language. These properties make Rust suitable for programmers who
have experience in languages like C and are looking for a safer alternative, as
well as those from languages like Python who are looking for ways to write code
that performs better without sacrificing expressiveness.

<!-- paragraph2 -->
Rust performs the majority of its safety checks and memory management decisions
at compile time, so that your program's runtime performance isn't impacted. This
makes it useful in a number of use cases that other languages aren’t good at:
programs with predictable space and time requirements, embedding in other
languages, and writing low-level code, like device drivers and operating
systems. It's also great for web applications: it powers the Rust package
registry site, [crates.io]!  We're excited to see what *you* create with Rust.

[crates.io]: https://crates.io/

<!-- paragraph3 -->
This book is written for a reader who already knows how to program in at least
one programming language. After reading this book, you should be comfortable
writing Rust programs. We’ll be learning Rust through small, focused examples
that build on each other to demonstrate how to use various features of Rust as
well as how they work behind the scenes.

<!-- title2 -->
## Contributing to the book

<!-- paragraph4 -->
This book is open source. If you find an error, please don’t hesitate to file an
issue or send a pull request [on GitHub].

[on GitHub]: https://github.com/rust-lang/book

In this way, when the content of each paragraph change only needs to submit an issue to inform the translator which section of the changes occurred.
The issue can be closed. After all the translators(Translation manager in each language) have confirmed it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No repository file or test is named. Start by examining how the book currently organizes its original and translated content and how translation updates are communicated. Done would require an agreed paragraph and title identification workflow, confirmed by the translation managers.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation, internationalization, localization
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.