Skip to content

Commit 043020e

Browse files
committed
feat(i18n): add missing README files for ES, KO, PT, RU languages
- Add README_ES.md (Spanish) - Add README_KO.md (Korean) - Add README_PT.md (Portuguese) - Add README_RU.md (Russian) - Update language switching links in all README files - Ensure consistency with docs directory language support
1 parent a71708e commit 043020e

22 files changed

+1365
-332
lines changed

.last-translated-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
09b6927107171dc247413361a4005cba870e4c15
1+
f217fe48fe460d4175646a105e8adbb4ab47c74a

README.md

Lines changed: 11 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,19 @@ Welcome to the RustFS community! We really appreciate your interest in contribut
66
English |
77
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_ZH.md">简体中文</a> |
88
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_JA.md">日本語</a> |
9-
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_DA.md">(#deutsch)</a> |
9+
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_DA.md">Deutsch</a> |
1010
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_FR.md">Français</a> |
11-
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_TR.md">Türkçe</a>
11+
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_TR.md">Türkçe</a> |
12+
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_ES.md">Español</a> |
13+
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_KO.md">한국어</a> |
14+
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_PT.md">Português</a> |
15+
<a href="https://github.com/rustfs/docs.rustfs.com/blob/main/README_RU.md">Русский</a>
1216
</p>
13-
14-
------
15-
16-
1717

18+
------
1819

1920
### Table of Contents
2021

21-
22-
2322
1. (#1-what-is-rustfs)
2423
2. (#2-our-mission-accessible--secure-data-for-everyone)
2524
3. Your Contribution Journey
@@ -34,40 +33,24 @@ English |
3433
- Acknowledgements
3534
- Content License
3635

37-
38-
3936
### 1. What is RustFS?
4037

41-
42-
4338
RustFS is a simple, high-performance, distributed object storage solution. It is 100% S3-compatible and released under the Apache 2.0 license, making it a commercially-friendly open-source software.
4439

4540
Written entirely in Rust—the modern programming language known for memory safety and exceptional performance 1—RustFS is developed by a global community of talented engineers. It is designed to be a powerful, reliable open-source alternative and can serve as a direct replacement for products like MinIO.2
4641

47-
48-
4942
### 2. Our Mission: Accessible & Secure Data for Everyone
5043

51-
52-
5344
We believe that data storage should be affordable, reliable, and secure for everyone, everywhere.
5445

5546
High-quality, multilingual documentation is central to this mission. It's not just an add-on; it's key to lowering the barrier to entry for users and developers across the globe. When you translate a guide or fix an error, you are directly helping people in different linguistic communities to more easily build robust, cost-effective data infrastructure. Your contributions empower a global audience, collectively enhancing data security and sovereignty. This community-driven approach to knowledge sharing maximizes the project's value and helps us truly realize our vision.4
5647

57-
58-
5948
### 3. Your Contribution Journey
6049

61-
62-
6350
We have designed different pathways for various types of contributors. Whether you want to quickly fix a small issue or systematically translate the entire documentation, you'll find the right guide here.
6451

65-
66-
6752
#### 3.1 Getting Started: Your First Contribution
6853

69-
70-
7154
The easiest way to get started is by making small edits directly through the GitHub web interface. This method requires no local development setup and is perfect for minor changes.6
7255

7356
Simple contributions you can make include:
@@ -88,12 +71,8 @@ Simple contributions you can make include:
8871

8972
This process serves as an excellent "on-ramp for contributors," allowing you to familiarize yourself with our workflow without any complex setup. A successful lightweight contribution is often the first step toward deeper involvement.5
9073

91-
92-
9374
#### 3.2 Translating the Documentation: Adding a New Language
9475

95-
96-
9776
This is the core area where we most need community help. Please follow these steps to add or improve translations.
9877

9978
**Step 1: Coordinate via GitHub Issues**
@@ -105,7 +84,7 @@ To avoid duplicated work and ensure collaboration, please visit our **[GitHub Is
10584

10685
**Step 2: Understand the Directory Structure**
10786

108-
Our documentation site is built with VitePress, which uses a file-based directory structure to manage multiple languages.9 All source files are located in the
87+
Our documentation site is built with VitePress, which uses a file-based directory structure to manage multiple languages.9 All source files are located in the
10988

11089
`docs/` directory.
11190

@@ -140,7 +119,7 @@ docs/
140119
```
141120
//.vitepress/config.ts
142121
import { defineConfig } from 'vitepress'
143-
122+
144123
export default defineConfig({
145124
//... other configs
146125
locales: {
@@ -211,36 +190,24 @@ To ensure consistency, please use the standard ISO 639-1 codes from the table be
211190
| German | `de` |
212191
| French | `fr` |
213192

214-
215-
216193
### 4. The Technical Workflow
217194

218-
219-
220195
For developers who wish to make more substantial contributions locally (such as adding a new language pack or making extensive changes), please follow this technical workflow.
221196

222-
223-
224197
#### 4.1 Prerequisites
225198

226-
227-
228199
Before you begin, please ensure you have the following software installed on your system:
229200

230-
- **Node.js**: Version `18.x` or higher.14 You can download it from the
201+
- **Node.js**: Version `18.x` or higher.14 You can download it from the
231202

232203
[official Node.js website](https://nodejs.org/).
233204

234205
- **Package Manager**: We recommend using `pnpm` for efficiency. You can install it globally with `npm install -g pnpm`. Alternatively, you can use `npm` or `yarn`.15
235206

236207
- **Git**: A version control system. You can download it from the [official Git website](https://git-scm.com/).
237208

238-
239-
240209
#### 4.2 Local Development Setup
241210

242-
243-
244211
Follow this sequence of commands to run the documentation development server locally:
245212

246213
1. Fork & Clone the Repository
@@ -277,14 +244,10 @@ Follow this sequence of commands to run the documentation development server loc
277244

278245
4. Access the Site
279246

280-
After successful execution, you should see output in your terminal similar to VitePress dev server running at: http://localhost:5173/. Open this URL in your browser to see the documentation site. Any changes you make to the Markdown files will be reflected instantly in the browser.15
281-
282-
247+
After successful execution, you should see output in your terminal similar to VitePress dev server running at: <http://localhost:5173/>. Open this URL in your browser to see the documentation site. Any changes you make to the Markdown files will be reflected instantly in the browser.15
283248

284249
#### 4.3 Pull Request (PR) & Commit Guidelines
285250

286-
287-
288251
We follow a standardized workflow to ensure code quality and a clean project history.
289252

290253
- **Branching Strategy**
@@ -321,43 +284,27 @@ We follow a standardized workflow to ensure code quality and a clean project his
321284
- We may request changes. Please don't be discouraged! This is a normal part of collaborative open-source development aimed at improving the quality of contributions.
322285
- Once your PR is approved and all automated checks have passed, a maintainer will merge it.
323286

324-
325-
326287
#### 4.4 Automated Checks & Deployment
327288

328-
329-
330289
To ensure the quality and stability of our documentation, we have a fully automated CI/CD (Continuous Integration/Continuous Deployment) pipeline.
331290

332291
- **Automated Checks**: When you submit a pull request, GitHub Actions will automatically run a series of checks. These checks verify that the documentation site builds successfully and that the code formatting is correct (linting).19
333292
- **Automated Deployment**: Once your PR is merged into the `main` branch, GitHub Actions will trigger again, automatically building the latest version of the site and deploying it to `https://docs.rustfs.com`.
334293

335294
By making this process transparent, we aim to build contributor trust in our workflow. You don't need to worry about the deployment details; a successful merge means a successful deployment. This gives you a clear view of the entire lifecycle of your contribution, from submission to publication.19
336295

337-
338-
339296
### 5. Community & Licensing
340297

341-
342-
343-
344-
345298
#### 5.1 Acknowledgements
346299

347-
348-
349300
The RustFS documentation is built by the community, for the community. We are incredibly grateful to everyone who contributes their time and expertise.
350301

351302
Every contribution, no matter how small, is highly valued. To fairly and transparently recognize all contributions, we use GitHub's built-in tools.
352303

353304
You can see a list of all our amazing contributors on the **[Contributors graph](https://github.com/rustfs/docs.rustfs.com/graphs/contributors)**. This automated, scalable approach ensures that every contribution is acknowledged and always up-to-date.22
354305

355-
356-
357306
#### 5.2 Content License
358307

359-
360-
361308
All documentation in this project is licensed under the **Creative Commons Attribution 4.0 International License**.23
362309

363310
By contributing to the RustFS documentation project, you agree that your contributions will be released under this license.

0 commit comments

Comments
 (0)