Skip to content

docs: fix security references, defaults, and localized links - #140

Merged
majinghe merged 1 commit into
mainfrom
fix/untranslated-docs-audit
Sep 9, 2026
Merged

docs: fix security references, defaults, and localized links#140
majinghe merged 1 commit into
mainfrom
fix/untranslated-docs-audit

Conversation

@GatewayJ

@GatewayJ GatewayJ commented Sep 8, 2026

Copy link
Copy Markdown
Member

Summary

Correct security and configuration guidance that disagrees with the current RustFS implementation, and fix credential-management links that render with duplicate locale prefixes.

  • Describe Vault KV2 key storage and local data-key wrapping, document its effective mount/prefix variables, and distinguish the unused KV2 mount option from the Transit mount.
  • Clarify root bucket-policy deny exceptions, regular-user STS deny-only authorization and policy-binding requirements, and Object Lock enablement on existing versioned buckets.
  • Correct four scanner defaults to 1800 seconds, 14 seconds, 4 set scans, and 4 disk scans; list all six server binary subcommands.
  • Keep credential links in the current language and synchronize all seven affected pages across en, zh, de, fr, and ja (35 files). Preserve the intentional English-body fallback documented in the README for German, French, and Japanese.

Source verification

Rechecked against rustfs/rustfs at 72e85210f136da936b27f83faf4a4f0054f1bb32:

Validation

  • git diff --check — passed.
  • npm run docs:check — passed for 600 pages and 155 navigation files, including locale parity and technical code-block consistency.
  • env -u ALGOLIA_ADMIN_API_KEY npm run build — passed; generated 2415 files and skipped production search-index upload.
  • node .agents/skills/localize-rustfs-docs/scripts/audit-locales.mjs --locales zh,de,fr,ja --json — removed all three source-locale-link errors with no added findings. Existing findings remain: 359 errors and 39 warnings, down from 362 errors and 39 warnings, including the repository's intentional English fallbacks and existing comparison warnings.
  • npm run types:check — still fails with 13 existing implicit-any errors in worker.mjs and scripts/add-language-redirects.mjs. Both files, the TypeScript configuration, and dependency manifests are unchanged from main.
  • Checked generated internal page paths across all five languages: no missing locale page targets, and every quick-start credential link resolves within its locale. Browser preview verified the English/Chinese KMS pages, language switching, and the German quick-start link.

Scope

Documentation only; no RustFS runtime changes or full translation rollout. The separate readonly policy explanation remains covered by #139.

@vercel

vercel Bot commented Sep 8, 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 Sep 8, 2026 8:49am UTC

@cloudflare-workers-and-pages

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 3b8dd1e Commit Preview URL

Branch Preview URL
Sep 08 2026, 08:49 AM

@GatewayJ
GatewayJ requested a review from overtrue September 8, 2026 10:24
@overtrue
overtrue requested a review from majinghe September 8, 2026 12:39
@majinghe
majinghe merged commit 4d06182 into main Sep 9, 2026
4 checks passed
@majinghe
majinghe deleted the fix/untranslated-docs-audit branch September 9, 2026 03:49
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