Skip to content

Commit e78eb66

Browse files
authored
Merge pull request #43 from rustfs/feature/translate-english-docs
feat: 完成英语文档翻译的核心文档结构
2 parents 9f994c8 + a218b58 commit e78eb66

File tree

16 files changed

+253
-122
lines changed

16 files changed

+253
-122
lines changed

.claude/settings.local.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
"Bash(git merge:*)",
1010
"Bash(git branch:*)",
1111
"Bash(rsync:*)",
12-
"Bash(npm run build:*)"
12+
"Bash(npm run build:*)",
13+
"Bash(git pull:*)",
14+
"Bash(git stash:*)"
1315
],
1416
"deny": [],
1517
"ask": []

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
请你帮我翻译文档为各个语言,这个项目是一个分布式文件存储系统的文档,你要做的事情你根据中文(docs/zh)下的内容,一对一翻译为英文,请你严格按照下列步骤操作:
88

99
0. 所有翻译都以中文作为源语言。
10-
1. 选择目标语言,比如按照 docs/ 下的顺序,先选中目标为 de,并创建此语言专用特性分支。
10+
1. 选择目标语言,比如按照 docs/ 下的顺序,先选中目标为 de,并创建此语言专用特性分支(切分支前确保主分支是最新的)
1111
2. 获取中文目录文件结构,逐一对比需要翻译的文件,举例:docs/zh/index.md 对比方案是:如果 docs/zh/ 下的同名文件更新时间晚于 docs/de 下的同名文件,则需要翻译,加入 todolist.
1212
3. 开始翻译中文对应的内容为目标语言,如果是外链,代码,则不翻译,并且删除在中文目录下没有的仅在目标语言目录中存在的文件。
1313
4. 图片则直接从中文对应的目录拷贝。
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "RustFS Access Key Management"
3+
description: "Creation, usage, and deletion of RustFS access keys."
4+
---
5+
6+
# Access Keys
7+
8+
RustFS access keys are the core credentials of the RustFS system, used for identity authentication and operation authorization, and are very useful in API and SDK scenarios. This chapter introduces the creation and deletion of RustFS access keys.
9+
10+
Prerequisites:
11+
12+
- An available RustFS instance. You can refer to the [Installation Guide](../../installation/index.md) for installation.
13+
14+
## Creating Access Keys
15+
16+
1. Log in to the RustFS UI console.
17+
2. In the left navigation bar, select **Access Keys**.
18+
3. On the access keys page, in the upper right corner, click **Add Access Key**.
19+
4. Enter the key's **expiration time, name, and description**, then click **Submit**.
20+
5. (Optional but recommended). On the access key page that appears, select **Copy** or **Export** to save the access key for future use.
21+
22+
![access key list page](images/access_token_creation.png)
23+
24+
## Deleting Access Keys
25+
26+
1. Log in to the RustFS UI console.
27+
2. In the left navigation bar, select **Access Keys**.
28+
3. On the access keys page, select the access key you want to delete.
29+
4. Select the **Delete** button on the right side of the access key or **Delete Selected Items** in the upper right corner to delete the access key.
30+
31+
![access key deletion](images/access_token_deletion.png)
189 KB
Loading
173 KB
Loading
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "RustFS IAM Management"
3+
description: "Detailed explanation of user/user group/policy/AK&SK and other content in RustFS."
4+
---
5+
6+
This chapter includes the following content:
7+
8+
- User Management
9+
- User Group Management
10+
- Policy Management
11+
- Bucket Policy
12+
- AK/SK

docs/en/concepts/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "RustFS Architecture Design and Core Concepts Explained"
3+
description: "This article introduces vocabulary frequently used in object storage, helping users quickly understand object storage"
4+
---
5+
6+
This chapter contains the following content:
7+
8+
- [RustFS Introduction](./introduction.md)
9+
- [RustFS Design Architecture](./architecture.md)
10+
- [Mainstream Storage Product Comparison](./comparison.md)
11+
- [Common Terminology](./glossary.md)
12+
- [Core Concepts](./principle/index.md)
13+
- [Usage Limitations](./limit.md)

docs/en/concepts/introduction.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "What is RustFS?"
3+
description: "RustFS is an object storage solution, an open-source distributed object storage released under the Apache2 license."
4+
---
5+
6+
# What is RustFS?
7+
8+
RustFS is a simple, efficient, and distributed object storage.
9+
At the same time, it is also an efficient, open-source, and free object storage solution. It is 100% compatible with the S3 protocol and is open-source software released under the Apache2 license. RustFS is written in the currently most popular and memory-safe language, Rust.
10+
It is a commercial-friendly distributed object storage product developed and contributed by excellent engineers from around the world. RustFS can replace many object storage products with unfriendly open-source licenses.
11+
12+
RustFS will soon transition from commercial applications to open source and be released globally, helping the world reduce storage costs and improve data security.
13+
14+
## Operating System and CPU Support
15+
16+
You can run RustFS on almost any CPU and operating system, whether it's Linux, Unix, Windows, MacOS, FreeBSD, Docker, or even edge gateways, you can run RustFS.
17+
CPU architecture support: X86, ARM, and many other CPU architectures.
18+
19+
## Features of RustFS
20+
21+
- **S3 Compatible**: 100% compatible with the S3 protocol, excellent compatibility with big data, data lakes, backup software, image processing software, and industrial production software;
22+
- **Distributed**: RustFS is a distributed object storage, so RustFS can meet various requirements;
23+
- **Commercial-friendly**: RustFS is 100% open-source software and is released under the Apache v2.0 license, so RustFS is commercial-friendly;
24+
- **Fast**: The performance of the Rust programming language infinitely approaches the speed of the C language. Therefore, RustFS has very powerful performance;
25+
- **Secure**: RustFS is written in the memory-safe Rust language, so RustFS is 100% secure;
26+
- **Cross-platform**: RustFS works on Windows, macOS, and Linux;
27+
- **Extensible**: RustFS supports custom plugins, so RustFS can meet various requirements;
28+
- **Customizable**: Due to its open-source nature, you can customize various plugins, so RustFS can meet various requirements;
29+
- **Cloud-native**: RustFS supports deployment via Docker and other methods, and can be quickly deployed in cloud-native environments.
30+
31+
## RustFS Values
32+
33+
Help all humanity improve data security and reduce storage costs.
34+
35+
## RustFS Vision
36+
37+
Every individual AI agent in the world can use RustFS to store data.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "RustFS Core Concepts Explained"
3+
description: "Detailed explanation of RustFS core concepts, including erasure coding, stripes, Data Scanner, data self-healing, etc. Allows users to have a deeper understanding of RustFS."
4+
---
5+
6+
This chapter contains the following content:
7+
8+
- [Erasure Coding](./erasure-coding.md)
9+
- Stripes
10+
- Data Scanner
11+
- Data Self-healing
12+
- Stripes
113 KB
Loading

0 commit comments

Comments
 (0)