You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
44
39
45
40
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
46
41
47
-
48
-
49
42
### 2. Our Mission: Accessible & Secure Data for Everyone
50
43
51
-
52
-
53
44
We believe that data storage should be affordable, reliable, and secure for everyone, everywhere.
54
45
55
46
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
56
47
57
-
58
-
59
48
### 3. Your Contribution Journey
60
49
61
-
62
-
63
50
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.
64
51
65
-
66
-
67
52
#### 3.1 Getting Started: Your First Contribution
68
53
69
-
70
-
71
54
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
72
55
73
56
Simple contributions you can make include:
@@ -88,12 +71,8 @@ Simple contributions you can make include:
88
71
89
72
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
90
73
91
-
92
-
93
74
#### 3.2 Translating the Documentation: Adding a New Language
94
75
95
-
96
-
97
76
This is the core area where we most need community help. Please follow these steps to add or improve translations.
98
77
99
78
**Step 1: Coordinate via GitHub Issues**
@@ -105,7 +84,7 @@ To avoid duplicated work and ensure collaboration, please visit our **[GitHub Is
105
84
106
85
**Step 2: Understand the Directory Structure**
107
86
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
109
88
110
89
`docs/` directory.
111
90
@@ -140,7 +119,7 @@ docs/
140
119
```
141
120
//.vitepress/config.ts
142
121
import { defineConfig } from 'vitepress'
143
-
122
+
144
123
export default defineConfig({
145
124
//... other configs
146
125
locales: {
@@ -211,36 +190,24 @@ To ensure consistency, please use the standard ISO 639-1 codes from the table be
211
190
| German |`de`|
212
191
| French |`fr`|
213
192
214
-
215
-
216
193
### 4. The Technical Workflow
217
194
218
-
219
-
220
195
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.
221
196
222
-
223
-
224
197
#### 4.1 Prerequisites
225
198
226
-
227
-
228
199
Before you begin, please ensure you have the following software installed on your system:
229
200
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
231
202
232
203
[official Node.js website](https://nodejs.org/).
233
204
234
205
-**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
235
206
236
207
-**Git**: A version control system. You can download it from the [official Git website](https://git-scm.com/).
237
208
238
-
239
-
240
209
#### 4.2 Local Development Setup
241
210
242
-
243
-
244
211
Follow this sequence of commands to run the documentation development server locally:
245
212
246
213
1. Fork & Clone the Repository
@@ -277,14 +244,10 @@ Follow this sequence of commands to run the documentation development server loc
277
244
278
245
4. Access the Site
279
246
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
283
248
284
249
#### 4.3 Pull Request (PR) & Commit Guidelines
285
250
286
-
287
-
288
251
We follow a standardized workflow to ensure code quality and a clean project history.
289
252
290
253
-**Branching Strategy**
@@ -321,43 +284,27 @@ We follow a standardized workflow to ensure code quality and a clean project his
321
284
- 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.
322
285
- Once your PR is approved and all automated checks have passed, a maintainer will merge it.
323
286
324
-
325
-
326
287
#### 4.4 Automated Checks & Deployment
327
288
328
-
329
-
330
289
To ensure the quality and stability of our documentation, we have a fully automated CI/CD (Continuous Integration/Continuous Deployment) pipeline.
331
290
332
291
-**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
333
292
-**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`.
334
293
335
294
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
336
295
337
-
338
-
339
296
### 5. Community & Licensing
340
297
341
-
342
-
343
-
344
-
345
298
#### 5.1 Acknowledgements
346
299
347
-
348
-
349
300
The RustFS documentation is built by the community, for the community. We are incredibly grateful to everyone who contributes their time and expertise.
350
301
351
302
Every contribution, no matter how small, is highly valued. To fairly and transparently recognize all contributions, we use GitHub's built-in tools.
352
303
353
304
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
354
305
355
-
356
-
357
306
#### 5.2 Content License
358
307
359
-
360
-
361
308
All documentation in this project is licensed under the **Creative Commons Attribution 4.0 International License**.23
362
309
363
310
By contributing to the RustFS documentation project, you agree that your contributions will be released under this license.
0 commit comments