Skip to content

docs: make container index an overview and merge Docker guide content - #135

Merged
majinghe merged 1 commit into
rustfs:mainfrom
majinghe:docs/container-overview
Aug 31, 2026
Merged

docs: make container index an overview and merge Docker guide content#135
majinghe merged 1 commit into
rustfs:mainfrom
majinghe:docs/container-overview

Conversation

@majinghe

@majinghe majinghe commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Summary

Restructure the Container installation section so installation/container/index is a true overview instead of duplicating the Docker guide.

  • content/*/installation/container/index.mdxindex.md: rewritten as a Container overview (container runtimes, non-root container user UID 10001, Kubernetes alternatives).
  • content/*/installation/container/docker.md: merged the old index's unique content — Docker Compose with the rustfs_perms init container and observability services, multi-node --network host deployment, TLS certificate mounts, environment-variable vs command-line flag configuration — and added bind-mount permission guidance for the non-root container user (UID 10001).
  • content/*/installation/container/podman.md: added the same non-root / UID 10001 permission note.
  • Updated stale links pointing to container/index.mdx in installation/index.md and installation/linux/quick-start.md.

Locales covered

  • en: new / rewritten English content
  • zh: Chinese translation
  • de, ja, fr: kept in English to match their current state (these locale trees are still English placeholders)

Validation

  • npm run docs:check — PASS (orphans, broken links, code fences, banned strings, locale tree parity)
  • npm run build — PASS (static site generated; Algolia sync skipped because ALGOLIA_ADMIN_API_KEY is not configured)

No related issues.

- Rewrite installation/container/index as a Container overview (it previously
  duplicated the Docker guide), covering runtimes, the non-root container user
  (UID 10001), and Kubernetes alternatives.
- Merge Docker Compose, multi-node, TLS, and env-vs-CLI content from the old
  index into installation/container/docker, and add bind-mount permission
  guidance for the non-root user.
- Add the same non-root/10001 permission note to the Podman page.
- Update stale links that pointed to container/index.mdx.
- Locales: en (new text), zh (translated), de/ja/fr (English, as before).
@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

@majinghe is attempting to deploy a commit to the overtrue's projects Team on Vercel.

A member of the Team first needs to authorize it.

@majinghe
majinghe merged commit fe770fa into rustfs:main Aug 31, 2026
1 of 2 checks passed
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.

1 participant