Skip to content

docs: revise remaining US English in the English docs - #184

Merged
majinghe merged 1 commit into
mainfrom
cursor/en-docs-editorial-dfa2
Oct 19, 2026
Merged

majinghe merged 1 commit into
mainfrom
cursor/en-docs-editorial-dfa2

Conversation

@majinghe

Copy link
Copy Markdown
Collaborator

Summary

The US English audit (en-language-audit.md, 321 issues against 8814682) was already applied in #173 and #175 for most quoted lines. This PR finishes the items that were only paraphrased, or that still failed STYLE.md and the credibility checks.

English prose is edited under content/en. German, French, Japanese, and Chinese pages are not retranslated. Their code fences were copied from the English pages where a command, comment, or example changed, so docs:check locale parity still passes.

Critical fixes

  • Java SDK no longer says RustFS only supports HTTP. Plain HTTP is described as one deployment mode; TLS is configured separately.
  • Removed the fictional max_object_size and max_part_size settings, and the advice to disable TLS validation for HTTP.
  • Object scanner no longer cites a 1-in-1024 sample, a daily default, or metric names that are not in the observability reference. It now uses the documented scanner variables and the verified rustfs_scanner_* series.
  • Drive replacement uses the same XFS command as disk preparation (mkfs.xfs -f -i size=512 -n ftype=1 -L RUSTFS0) and mounts by UUID.
  • Software checklist no longer recommends ext4 beside the XFS-only Linux prerequisites.
  • "RustFS UI" on the bucket and object task pages is now Console. Instructional "log in" for the Console is sign in. "In the Console" headings are on the Console.
  • "Apple Silicon" is Apple silicon. The Intel Mac note is a package limit, not a "boundary".
  • Apache 2.0 heading capitalization matches the license wording requested by the audit.

Rewritten or thoroughly edited pages

  • Hardware checklist: sentence-case headings, workload wording, and a pointer to disk preparation instead of a second mkfs recipe.
  • Network, software, and security checklists, plus hardware selection.
  • Linux install index, SNSD, SNMD, MNMD, and prerequisites (sentence case, Console, no unverified RAID-throughput claim).
  • SDK index, Other SDKs, Java, JavaScript, Python, Rust, and TypeScript guides: task headings, no outline numbers such as 4.1 / 5.1.1, no "highly optimized".
  • MCP, access keys, virtual-hosted–style requests, and node failures.

Remaining low-priority items

  • Integration guides were already close to native English and were not rewritten. Link text "Access Key Management" on those pages still points at the Access keys page.
  • The hardware checklist still includes the planning matrix and memory formula from the audit’s suggested wording. Those figures are planning examples, not values verified in rustfs/rustfs.
  • Some newer pages still use Title Case for product-procedure headings that the audit did not list (for example IAM "Managing Users"). Sentence case is applied on the pages this PR rewrote.

Verification

  • npm run docs:check — pass (orphans, relative links, fence languages, banned strings, image size, locale parity, technical code blocks).
  • npm run build — pass (3785 files generated). A one-line prose clarification on the virtual-hosted–style page was made after that build; it does not change code fences, and docs:check passed again afterward.
Open in Web Open in Cursor 

Apply the leftover editorial fixes from the US English audit: correct the HTTP-only and max_object_size claims, rewrite the scanner and drive-replacement pages against documented behavior, and sentence-case the older install, SDK, and checklist pages. Sync changed code fences in de, fr, ja, and zh so locale parity still holds.

Co-authored-by: hector <majinghe@users.noreply.github.com>
@vercel

vercel Bot commented Oct 19, 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:34pm UTC

@majinghe
majinghe merged commit 8d4806d into main Oct 19, 2026
5 checks passed
@majinghe
majinghe deleted the cursor/en-docs-editorial-dfa2 branch October 19, 2026 12:35

This branch was successfully deployed

1 active deployment
Preview — 24dd9e5b 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.

2 participants