Repository navigation
docs: revise non-native English in the English docs - #173
Merged
Merged
Conversation
Rewrite Chinglish, missing subjects, and inconsistent terminology in the English docs without changing commands, code samples, or other locales. Co-authored-by: RustFS <hello@rustfs.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
rustfs-docs | 5684574 | Commit Preview URL Branch Preview URL |
Oct 14 2026, 04:25 AM |
loverustfs
marked this pull request as ready for review
October 14, 2026 04:17
Add the blank lines FumaPress needs so callouts with lists and titles render. Co-authored-by: RustFS <hello@rustfs.com>
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites non-native English in
content/en/so the pages read like US technical documentation (AWS and Kubernetes style). This is a wording pass only. Commands, code samples, API identifiers, the Apache license text, and every other locale are unchanged.The edits follow the language audit, the repo style guide, and judgment where a suggestion would have changed a technical claim.
Categories of changes
Recommend using...becomesWe recommend...).rclonewas missing the opening of the Markdown link).Pages touched
content/en/index.mdxcontent/en/administration/index.mdcontent/en/administration/protocols/s3.mdcontent/en/administration/data/bucket/creation.mdcontent/en/administration/data/bucket/deletion.mdcontent/en/administration/data/object/creation.mdcontent/en/administration/data/object/deletion.mdcontent/en/administration/data/object/multipart-upload.mdcontent/en/administration/data/object/object-lock.mdcontent/en/administration/data/object/scanner.mdcontent/en/administration/data/object/versioning.mdcontent/en/administration/data/s3-tables.mdcontent/en/developer/integration/others/index.mdcontent/en/developer/mcp.mdcontent/en/developer/sdk/index.mdcontent/en/developer/sdk/java.mdcontent/en/developer/sdk/javascript.mdcontent/en/developer/sdk/go.mdcontent/en/developer/sdk/python.mdcontent/en/developer/sdk/rust.mdcontent/en/developer/sdk/typescript.mdcontent/en/developer/sdk/other.mdcontent/en/installation/index.mdcontent/en/installation/cloud-native/index.mdcontent/en/installation/container/docker.mdcontent/en/installation/container/index.mdcontent/en/installation/linux/index.mdcontent/en/installation/linux/quick-start.mdcontent/en/installation/linux/prerequisites-and-service.mdcontent/en/installation/linux/single-node-single-disk.mdcontent/en/installation/linux/single-node-multiple-disk.mdcontent/en/installation/linux/multiple-node-multiple-disk.mdcontent/en/installation/macos/index.mdcontent/en/installation/requirement/checklists/index.mdcontent/en/installation/requirement/checklists/hardware-checklists.mdcontent/en/installation/requirement/checklists/hardware-selection.mdcontent/en/installation/requirement/checklists/network-checklists.mdcontent/en/installation/requirement/checklists/security-checklists.mdcontent/en/installation/requirement/checklists/software-checklists.mdcontent/en/integration/tls-configured.mdcontent/en/integration/virtual.mdcontent/en/operations/cluster-lifecycle.mdcontent/en/operations/credentials.mdcontent/en/operations/observability.mdcontent/en/operations/scaling/storage-pool-decommission.mdcontent/en/operations/status-check.mdcontent/en/security-compliance/encryption/kms.mdcontent/en/security-compliance/encryption/sse-s.mdcontent/en/security-compliance/iam/index.mdcontent/en/security-compliance/iam/access-token.mdcontent/en/troubleshooting/index.mdcontent/en/troubleshooting/driver.mdcontent/en/troubleshooting/node.mdNeeds maintainer review
These claims were left in place. Surrounding grammar may have been smoothed, but the technical assertion was not rewritten.
content/en/developer/sdk/java.mdstill says that an upload with no response happens because the SDK defaults to HTTPS and RustFS only supports HTTP (or needs certificates). TLS for RustFS is documented elsewhere, so this row may be wrong.content/en/developer/sdk/java.mdstill recommendsmax_object_sizeandmax_part_size. Those setting names were not verified against the server.content/en/installation/requirement/checklists/software-checklists.mdstill allows XFS or ext4.content/en/installation/linux/prerequisites-and-service.mdsays to format data disks with XFS and to avoid ext4, Btrfs, and ZFS.content/en/administration/console/index.mdstill says Windows and macOS desktop launchers use port7001.content/en/installation/windows/index.mdsays port7001is not used by the current Launcher. The docs style guide lists7001as the desktop launcher port.content/en/troubleshooting/node.mdstill states that higher-spec hardware on a replacement node does not affect cluster performance.content/en/developer/sdk/index.md: "fully compatible with the S3 protocol" and "fully compatible with the MinIO SDKs"content/en/developer/sdk/go.md,rust.md, andtypescript.md: "fully S3-compatible"content/en/troubleshooting/driver.mdnow says to mount by label or UUID so mounts stay correct if device names change after a restart. That is a reading of the original "disk order is not affected by system restarts." Confirm that stable mount mappings, not physical disk order, are the intended requirement.Verification
npm run docs:check— passed (orphans, links, fences, banned strings, image size, locale parity, and translated code blocks).npm run build— passed on Node.js 24.21.0 (FumaPress static build, language redirects). Algolia sync was skipped becauseALGOLIA_ADMIN_API_KEYis not set.