Skip to content

Commit 2153d9f

Browse files
authored
docs: review and standardize English documentation (#73)
1 parent cd1ece3 commit 2153d9f

File tree

49 files changed

+620
-714
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+620
-714
lines changed

docs/about/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Integrity, Focus, Simplicity
3636
3737
### Investor Relations
3838

39-
For investment opportunities or strategic partnerships, please contact us.
39+
For investment opportunities or strategic partnerships, contact us.
4040

4141
📧 **Contact**
4242
<hello@rustfs.com>

docs/administration/iam/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ title: "RustFS IAM Management"
33
description: "Comprehensive guide to Identity and Access Management (IAM), including Users, Groups, Policies, and Access Keys."
44
---
55

6-
This chapter includes the following content:
6+
This section covers:
77

88
- User Management
99
- User Group Management
1010
- Policy Management
1111
- Bucket Policy
12-
- AK/SK
12+
- Access Keys (AK/SK)

docs/concepts/architecture.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,36 @@ description: "Introduction to RustFS Architecture"
55

66
# RustFS Architecture
77

8-
RustFS is an object storage system, similar to the well-known AWS S3. As a MinIO alternative, RustFS references MinIO's concise, lightweight, scalable, and elegant architecture.
8+
RustFS is a high-performance object storage system compatible with the AWS S3 API. It features a concise, lightweight, scalable, and decentralized architecture.
99

10-
Objects can be documents, videos, PDF files, etc. To store objects, MinIO provides a scalable, flexible, and efficient solution for storing, accessing, and managing data. Its compatibility with AWS S3 API enables seamless integration with AWS S3-based applications.
10+
Objects can be documents, videos, PDF files, or any other unstructured data. RustFS provides a scalable, flexible, and efficient solution for storing, accessing, and managing this data. Its compatibility with the AWS S3 API enables seamless integration with existing S3-based applications.
1111

12-
The architecture diagram is as follows:
12+
The following diagram illustrates the architecture:
1313

1414
![RustFS Architecture Diagram](./images/s2-1.png)
1515

16-
This is RustFS's basic architecture. A distributed grid is a computer architecture that uses multiple nodes to execute a single task. Nodes are connected to each other through a network, enabling them to communicate with each other.
16+
This diagram represents the basic architecture of RustFS. A distributed grid uses multiple nodes to execute a single task, connected via a network to enable communication.
1717

1818
## Consistency Design
1919

20-
In both distributed and single-machine modes, all read and write operations strictly follow the read-after-write consistency model.
20+
In both distributed and single-machine modes, all read and write operations strictly follow the **read-after-write** consistency model.
2121

22-
## Several Important Concepts in RustFS
22+
## Key Concepts
2323

2424
**Object**: The fundamental unit of storage in RustFS, representing files, byte streams, or any unstructured data.
2525

26-
**Bucket**: A logical container for storing Objects. Data is isolated between Buckets. For clients, it functions similarly to a top-level directory.
26+
**Bucket**: A logical container for storing objects. Data is isolated between buckets. For clients, it functions similarly to a top-level directory.
2727

28-
**Drive**: The disk that stores data, passed as a parameter when RustFS starts. All object data in RustFS will be stored in Drives.
28+
**Drive**: The physical disk that stores data, passed as a parameter when RustFS starts. All object data in RustFS is stored on these drives.
2929

30-
**Set**: A collection of a group of Drives. Distributed deployment automatically divides one or more Sets based on cluster scale. Drives in each Set are distributed in different locations. An object is stored on one Set. (Some places also call the combination of Sets **Strips** - stripes).
30+
**Set**: A group of drives. Distributed deployment automatically divides the cluster into one or more sets based on scale. Drives in each set are distributed across different locations. An object is stored within a single set. (Sometimes referred to as **Stripes**).
3131

32-
Therefore, before designing the architecture and deploying devices, note that:
32+
Consider the following when designing the architecture and deploying devices:
3333

34-
1. One object is stored on one Set;
35-
36-
2. One cluster is divided into multiple Sets;
37-
38-
3. The number of Drives contained in one Set is fixed, defaulting to automatic calculation by the system based on cluster scale;
39-
40-
4. Drives in one Set should be distributed across different nodes as much as possible;
34+
- One object is stored on one set.
35+
- One cluster is divided into multiple sets.
36+
- The number of drives in a set is fixed, defaulting to automatic calculation by the system based on cluster scale.
37+
- Drives in a set should be distributed across different nodes as much as possible.
4138

4239
## Architectural Design
4340

docs/concepts/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "What is RustFS?"
3-
description: "RustFS is an object storage solution - an open-source distributed object storage released under the Apache2 license."
3+
description: "RustFS is an open-source, distributed object storage solution released under the Apache 2.0 license."
44
---
55

66
# What is RustFS?
@@ -13,14 +13,14 @@ RustFS is transitioning from commercial roots to a fully open-source model, aimi
1313

1414
## Operating System and CPU Support
1515

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.
17-
CPU architecture support: X86, ARM, and various other CPU architectures.
16+
RustFS runs on almost any CPU and operating system, including Linux, Unix, Windows, macOS, FreeBSD, and Docker, as well as edge gateways.
17+
Supported CPU architectures: x86, ARM, and others.
1818

1919
## RustFS Features
2020

2121
- **S3 Compatible**: Fully compatible with the S3 protocol, ensuring seamless integration with big data ecosystems, data lakes, backup solutions, and media processing workflows.
2222
- **Distributed Architecture**: Designed to scale horizontally to meet diverse storage requirements across various scales.
23-
- **Commercial-Friendly**: Released under the Apache v2.0 license, making it safe and flexible for commercial integration.
23+
- **Enterprise-Ready**: Released under the Apache v2.0 license, making it safe and flexible for commercial integration.
2424
- **High Performance**: Built with Rust, offering performance comparable to C/C++ but with modern safety guarantees.
2525
- **Secure by Design**: Leverages Rust's memory safety guarantees to significantly reduce common security vulnerabilities.
2626
- **Cross-Platform**: Runs natively on Windows, macOS, and Linux.

docs/developer/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: RustFS Developer Guide
3-
description: Introduction to using STS/MCP/MinIO Client/SDK/API in RustFS, helping developers use RustFS more efficiently.
3+
description: Guide to using STS, MCP, MinIO Client, SDKs, and APIs with RustFS.
44
---
55

6-
This guide provides comprehensive instructions for integrating and interacting with RustFS using STS, MCP (Model Context Protocol), MinIO Client (`mc`), SDKs, and APIs. It is designed to enable developers to build efficient and scalable applications on top of RustFS. This document covers the following topics:
6+
This guide provides instructions for integrating and interacting with RustFS using STS, MCP (Model Context Protocol), MinIO Client (`mc`), SDKs, and APIs. It is designed to enable developers to build efficient and scalable applications on top of RustFS. This document covers the following topics:
77

88
- STS
99
- [MCP Usage Guide](./mcp.md)

docs/developer/license.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: RustFS Open Source License
3-
description: RustFS is released under the 100% commercial-friendly Apache v2.0 license
3+
description: RustFS is released under the Apache 2.0 license.
44
---
55

66
# RustFS Open Source License
77

88
## Open Source License
99

10-
- RustFS is released under the 100% commercial-friendly Apache v2.0 license
11-
- [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0)
10+
- RustFS is released under the Apache 2.0 license.
11+
- [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
1212

1313
## License Terms
1414

docs/developer/mc.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
title: "Managing RustFS Objects with MinIO Client"
3-
description: "Managing RustFS objects with MinIO Client"
2+
title: "Manage RustFS Objects with MinIO Client"
3+
description: "Manage RustFS objects using the MinIO Client."
44
---
55

66
# MinIO Client (`mc`)
77

8-
MinIO Client (`mc`) is an official command-line tool provided by MinIO for managing MinIO object storage services. `mc` can interact with MinIO, Amazon S3, and other S3-compatible object storage services, providing a simple and efficient way to manage data in object storage services. Since MinIO is S3-compatible, `mc` can also be used to manage RustFS objects.
8+
The MinIO Client (`mc`) is a command-line tool for managing object storage services. It supports MinIO, Amazon S3, and other S3-compatible services. As RustFS is S3-compatible, you can use `mc` to manage RustFS objects.
99

1010
Prerequisites:
1111

12-
- An available RustFS instance. Refer to the [Installation Guide](../installation/index.md) for installation.
13-
- `mc` tool is installed.
12+
- An available RustFS instance. Refer to the [Installation Guide](../installation/index.md).
13+
- The `mc` tool is installed.
1414
- Available [access keys](../administration/iam/access-token.md).
1515

16-
## Using `mc` to Operate RustFS
16+
## Using `mc` with RustFS
1717

18-
First, you need to use the `mc alias` command to configure an alias for RustFS:
18+
First, configure an alias for RustFS using the `mc alias` command:
1919

2020
```bash
2121
mc alias set rustfs http://12.34.56.78:9000 ACCESS_KEY SECRET_KEY
@@ -27,11 +27,11 @@ Output:
2727
Added `rustfs` successfully.
2828
```
2929

30-
Next, you can use `mc` to operate on the alias `rustfs` to create/delete buckets, upload/download files, etc.
30+
You can now use `mc` with the `rustfs` alias to create/delete buckets, upload/download files, etc.
3131

3232
### List Buckets
3333

34-
Use `mc ls` to list all buckets under the current RustFS instance:
34+
List all buckets:
3535

3636
```bash
3737
mc ls rustfs
@@ -47,7 +47,7 @@ Output:
4747

4848
### Create Bucket
4949

50-
Use `mc mb` command to create a bucket:
50+
Create a bucket:
5151

5252
```bash
5353
mc mb rustfs/bucket-creation-by-mc
@@ -61,7 +61,7 @@ Bucket created successfully `rustfs/bucket-creation-by-mc`.
6161

6262
### Delete Bucket
6363

64-
Use `mc rb` command to delete a bucket:
64+
Delete a bucket:
6565

6666
```bash
6767
mc rb rustfs/bucket-creation-by-mc
@@ -73,9 +73,9 @@ Output:
7373
Removed `rustfs/bucket-creation-by-mc` successfully.
7474
```
7575

76-
### Upload File to Bucket
76+
### Upload File
7777

78-
Use `mc cp` command to upload a file to a bucket:
78+
Upload a file to a bucket:
7979

8080
```bash
8181
mc cp file_name rustfs/bucket-creation-by-mc
@@ -87,9 +87,9 @@ Output:
8787
...path/to/file_name: 4 B / 4 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 12 B/s 0s%
8888
```
8989

90-
### Delete File in Bucket
90+
### Delete File
9191

92-
Use `mc rm` command to delete a file in a bucket:
92+
Delete a file from a bucket:
9393

9494
```bash
9595
mc rm rustfs/bucket-creation-by-mc/file_name

docs/developer/mcp.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "RustFS MCP Usage Guide"
55

66
# RustFS MCP
77

8-
**RustFS MCP Server** is a high-performance [Model Context Protocol (MCP)](https://www.anthropic.com/news/model-context-protocol) server that provides AI/LLM tools with seamless access to S3-compatible object storage operations. Built with Rust for maximum performance and security, it enables AI assistants like Claude Desktop to interact with cloud storage through standardized protocols.
8+
**RustFS MCP Server** is a high-performance [Model Context Protocol (MCP)](https://www.anthropic.com/news/model-context-protocol) server that provides AI/LLM tools with seamless access to S3-compatible object storage operations. Built with Rust for performance and security, it enables AI assistants like Claude Desktop to interact with cloud storage through standardized protocols.
99

1010
### What is MCP?
1111

@@ -15,16 +15,16 @@ The Model Context Protocol is an open standard that enables AI applications to e
1515

1616
### Supported S3 Operations
1717

18-
- **List Buckets**: List all accessible S3 buckets
19-
- **List Objects**: Browse bucket contents with optional prefix filtering
20-
- **Upload Files**: Upload local files with automatic MIME type detection and cache control
21-
- **Get Objects**: Retrieve objects from S3 storage, supporting read or download modes
18+
- **List Buckets**: Lists all accessible S3 buckets.
19+
- **List Objects**: Browses bucket contents with optional prefix filtering.
20+
- **Upload Files**: Uploads local files with automatic MIME type detection and cache control.
21+
- **Get Objects**: Retrieves objects from S3 storage, supporting read or download modes.
2222

2323
## 🔧 Installation
2424

2525
### Prerequisites
2626

27-
- Rust 1.88+ (for building from source)
27+
- Rust 1.75+ (for building from source)
2828
- Configured AWS credentials (via environment variables, AWS CLI, or IAM roles)
2929
- Access to S3-compatible storage services
3030

docs/developer/sdk/go.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: "RustFS Golang SDK Usage Guide"
2+
title: "Golang SDK Guide"
33
description: "Use the Golang SDK to operate on RustFS instances, including creating and deleting buckets and objects."
44
---
55

66
# Golang SDK
77

8-
Since RustFS is a fully S3-compatible object storage system, you can build a Golang SDK suitable for RustFS by wrapping the S3 Golang SDK. Through the SDK, you can operate on RustFS, including creating and deleting buckets/objects, uploading and downloading files, etc.
8+
RustFS is fully S3-compatible. You can use the standard AWS SDK for Go to interact with RustFS. Through the SDK, you can operate on RustFS, including creating and deleting buckets/objects, uploading and downloading files, etc.
99

1010
## Prerequisites
1111

12-
- A working RustFS instance (refer to [Installation Guide](../../installation/index.md) for installation).
13-
- Access keys (refer to [Access Key Management](../../administration/iam/access-token.md) for creation).
12+
- A working RustFS instance (refer to [Installation Guide](../../installation/index.md)).
13+
- Access keys (refer to [Access Key Management](../../administration/iam/access-token.md)).
1414

15-
## RustFS Golang SDK Construction
15+
## Initializing the Client
1616

17-
Use `RUSTFS_ACCESS_KEY_ID`, `RUSTFS_SECRET_ACCESS_KEY`, `RUSTFS_ENDPOINT_URL`, `RUSTFS_REGION` to construct an `aws.Config`, then use `s3.NewFromConfig` from the Golang S3 SDK to build a RustFS Client:
17+
Configure `aws.Config` using environment variables and initialize the client:
1818

19-
```
19+
```go
2020
region := os.Getenv("RUSTFS_REGION")
2121
access_key_id := os.Getenv("RUSTFS_ACCESS_KEY_ID")
2222
secret_access_key := os.Getenv("RUSTFS_SECRET_ACCESS_KEY")
@@ -44,7 +44,7 @@ client := s3.NewFromConfig(cfg, func(o *s3.Options) {
4444
})
4545
```
4646

47-
Then you can use the constructed RustFS Client to perform bucket and object operations.
47+
You can now perform bucket and object operations.
4848

4949
## Create Bucket
5050

docs/developer/sdk/index.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: "RustFS SDK Overview"
3-
description: "Which S3 SDKs can be used with RustFS? This article provides a detailed explanation."
3+
description: "Overview of supported S3 SDKs for RustFS."
44
---
55

66
# SDK Overview
77

8-
RustFS is a distributed object storage software that is 100% compatible with the S3 protocol. Users can:
8+
RustFS is a distributed object storage system fully compatible with the S3 protocol. Users can:
99

10-
1. Manage RustFS through the Console management interface;
11-
2. Manage RustFS through S3 clients;
12-
3. Implement object storage operations and management on the business side through SDKs.
10+
- Manage RustFS through the Console management interface.
11+
- Manage RustFS through S3 clients.
12+
- Implement object storage operations and management on the business side through SDKs.
1313

1414
Currently, the SDKs provided by RustFS include:
1515

@@ -20,27 +20,26 @@ Currently, the SDKs provided by RustFS include:
2020
- [TypeScript SDK](./typescript.md)
2121
- [Golang SDK](./go.md)
2222

23-
## Terminology Explanation Before Reading
23+
## Terminology
2424

25-
S3 is the name of the first object storage product opened and launched by Amazon. It opened all its protocols and specifications. Later, almost all object storage systems followed the S3 protocols and specifications. Sometimes people call S3 object storage, and sometimes they simply call S3 the object storage protocol.
25+
Amazon S3 (Simple Storage Service) was the first widely adopted object storage service. Its API has become the de facto standard for object storage. In this documentation, "S3" refers to the protocol.
2626

2727
## 1. SDK Recommendations
2828

29-
Since there are already too many SDKs on the market that have been maintained for many years, such as AWS S3 SDK which has been debugged and optimized for many years. Its performance and errors are almost zero. Therefore, we recommend that you directly use the standard AWS S3 SDK to directly control and communicate with RustFS.
29+
We recommend using the official AWS S3 SDKs. These SDKs are mature, well-maintained, and highly optimized.
3030

3131
If you have a familiar and trusted SDK from a vendor, you can use it.
3232

33-
Because many Chinese cloud providers have made "modifications" in many places and do not support many of the latest S3 technologies, many object storage products around the world do not recommend the SDKs of many Chinese cloud providers.
33+
Some third-party SDKs may have non-standard implementations. We recommend avoiding SDKs that are not strictly S3-compliant.
3434

35-
## 2. Can MinIO SDKs communicate directly with RustFS?
35+
## 2. Compatibility with MinIO SDKs
3636

37-
Yes.
38-
39-
We have conducted comprehensive adaptation and compatibility for MinIO SDKs.
37+
Yes, RustFS is fully compatible with MinIO SDKs.
4038

4139
If you are using MinIO SDKs, you can modify the Endpoint, AK, and SK to be directly compatible with RustFS.
4240

43-
## 3. What to do if there are other incompatible SDKs?
41+
## 3. Handling Incompatible SDKs
42+
43+
If you encounter an SDK that does not support standard S3, MinIO, or RustFS:
4444

45-
If we use an SDK from a cloud provider that does not support the latest S3, MinIO, or RustFS, how should we handle it?
46-
Please replace the SDK as soon as possible and re-match and upgrade on the business side.
45+
We recommend switching to a standard AWS S3 SDK.

0 commit comments

Comments
 (0)