Skip to content

docs: revise non-native English in content/en - #175

Merged
overtrue merged 3 commits into
mainfrom
cursor/en-docs-wording-1408
Oct 19, 2026
Merged

overtrue merged 3 commits into
mainfrom
cursor/en-docs-wording-1408

Conversation

@loverustfs

@loverustfs loverustfs commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Revises English prose under content/en/ so it reads like US technical documentation (AWS / Kubernetes style). The edits follow the merged wording audit (323 items, baseline 8814682; originals were matched by quoted text because line numbers had drifted).

Technical facts, commands, code samples, API identifiers, license text, and other locales are unchanged, except for the launcher port correction below. Claims that still need a product decision were only lightly reworded, or left as written, and are listed under Needs maintainer review.

Maintainer confirmed the default ports: the S3 API listens on 9000 and the Console on 9001. English pages that mentioned launcher port 7001 now use those defaults.

Patterns fixed

  • Translationese and missing subjects: “Recommend …”, “on the business side”, “data security” where durability was meant, “dual-active”, “popup dialog”, “this article mainly explains”.
  • Voice: second person, and “We recommend” for guidance.
  • Overclaims the style guide already bans, such as “fully compatible” / “every S3-compatible call works the same way”. Those lines now say S3-compatible and point at the S3 compatibility page where the blanket sentence was repeated.
  • Terminology: Drive instead of Driver for disks, Console instead of “RustFS UI”, access key / secret key instead of AK/SK, active-active, virtual-hosted–style, Object Lock, sentence-case headings on the pages that were rewritten.
  • Structure: a manual table of contents was removed from the drive-failure page (the site generates one), and a few bold “Note” / “Warning” lines that were rewritten became titled admonitions.
  • Ports: Windows and macOS desktop launchers use the same defaults as other installs (S3 API 9000, Console 9001).

Files touched

English pages only (55 files), including:

  • Installation: Linux modes, prerequisites, hardware / network / software / security checklists, Windows launcher troubleshooting, container and cloud-native intros
  • Troubleshooting: drive failures, node failures, section index
  • Developer: SDK overview and language guides, MCP, homepage lede
  • Administration (including the Console page), IAM access keys, TLS, virtual-hosted–style requests, and a handful of operations pages

Needs maintainer review

These were not corrected as facts. Wording was left alone or edited only enough to fix grammar:

  • Higher-spec hardware and cluster performance (content/en/troubleshooting/node.md). The page still says a higher-spec replacement node does not affect cluster performance. That absolute claim was not verified.
  • “RustFS only supports HTTP” (content/en/developer/sdk/java.md troubleshooting table). Grammar was fixed. The claim is still there, even though the TLS guide documents HTTPS.
  • max_object_size and max_part_size (content/en/developer/sdk/java.md). The missing subject was added. The settings were not removed; they may not be real RustFS options.
  • ext4 vs XFS (content/en/installation/requirement/checklists/software-checklists.md still allows XFS or ext4; content/en/installation/linux/prerequisites-and-service.md says to avoid ext4). Only Ext4 → ext4 was changed. The contradiction remains.
  • “Disk order” (content/en/troubleshooting/driver.md). Mount-by-label/UUID advice was rewritten, but “disk order” was kept rather than restating it as “device names can change”.
  • Unnamed healing tool (content/en/troubleshooting/driver.md). The sentence still says “the tool” reports success or lists failed objects. The product name was not guessed.
  • Node healing scope (content/en/troubleshooting/node.md). Still attributed to community testing: a rejoining node is healed without a full cluster rebalance. Not promoted to a guaranteed product behavior.
  • Container UID. The TLS note was rewritten for clarity and does not add UID 10001, which was not in the original sentence.
  • Apache license heading (content/en/developer/license.md). Not edited.
  • Numeric planning figures (2–3 weeks, 500 active buckets, 72-hour tests, 110% and 120% of peak) were kept as written and were not re-validated.

Verification

  • npm run docs:check — passed (orphans, links, fences, banned strings, locale parity, technical code-block parity), including after the port correction.
  • npm run build — passed on Node.js 24.21.0 for the wording revision (static site generated). Algolia sync skipped because ALGOLIA_ADMIN_API_KEY is not set.
Open in Web Open in Cursor 

Rewrite translated wording under content/en so it reads like US technical documentation, without changing commands, code samples, or technical claims that still need maintainer confirmation.

Co-authored-by: RustFS <hello@rustfs.com>
@vercel

vercel Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs-rustfs-com Ready Ready Preview Oct 19, 2026 12:39am UTC

Replace the outdated launcher port 7001 with the confirmed defaults: S3 API on 9000 and the Console on 9001.

Co-authored-by: RustFS <hello@rustfs.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
rustfs-docs c175eb0 Commit Preview URL

Branch Preview URL
Oct 14 2026, 04:30 AM

@overtrue
overtrue marked this pull request as ready for review October 19, 2026 00:20
@overtrue
overtrue merged commit 783c1bd into main Oct 19, 2026
3 of 4 checks passed
@overtrue
overtrue deleted the cursor/en-docs-wording-1408 branch October 19, 2026 00:24

This branch was successfully deployed

1 active deployment
Preview — 826386d1 Deployed Oct 19, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants