Skip to content

About

Website of Silo

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Repository files navigation

Silo Documentation

English · 简体中文

This repository contains the bilingual documentation for Silo, a community fork of MinIO. It uses Hugo and OINK 1.4.0, pinned to the exact release in go.mod, with English at / and Simplified Chinese at /zh/.

Release state and publication

The current coordinated release is SILO Server, mcli and KES 20261026 (RELEASE.2026-10-26T00-00-00Z, package 20261026000000.0.0), with SILO Console v2.5.1 and silo-pkg v3.15.2, built with Go 1.27.3. Server source is c3ad836aed0d8a7d23c2e44a5eaa3009d08525e3; its selected graph uses the released Console and mcli sources, pkg v3.15.2 and upstream minio-go v7.4.2-0.20261025165926-320af050c445. KES is an optional external key service.

Release notes English 简体中文
Server / mcli / KES 20261026 Release notes 发布说明
Console 2.5 series, through 2.5.1 Release notes 发布说明
silo-pkg 3.15 series, through 3.15.2 Release notes 发布说明

These bilingual notes consolidate the October 24–25 placeholders and cover all changes since 20261018. See the component matrix for exact sources, upgrade order and compatibility boundaries. A storage timeout does not prove that underlying I/O stopped; the final Server release retains existing timeout behavior and does not ship the draft's mutation guards or ownership-checked rollback scheme.

data/releases.yaml drives the homepage and download templates. server.published: true enables public asset links; published_server records the current public release. For a future candidate, keep the flag false until its Server artifacts and Docker images are public and verified. windows_archive_format follows each released component: all current Windows archives use ZIP; Linux and macOS use tar.gz. Historical links retain their original archive formats. Publishing an artifact and deploying it to a production cluster are separate steps.

The homepage Docker Pulls card links to pgsty/silo. Its counter combines the historical pgsty/minio and current pgsty/silo repositories.

Before publishing, run python3 bin/metrics.py, review its generated metrics diff, then run make check. Cloudflare Pages deploys the main branch; verify its commit check and the live English/Chinese pages after publication.

Local development

Use Hugo Extended 0.168.0, Go 1.27.3, Git, and Python 3.10 or newer with venv support. Hugo's built-in LibSass compiles the styles, and OINK vendors the browser and styling assets. No separate Sass compiler or Node.js toolchain is needed.

CI uses Go 1.27.3 and Hugo Extended 0.168.0; use the same versions on Cloudflare Pages. Keep this build combination until a theme upgrade preserves the build without a separate Sass compiler. Keep diagnostics visible and review them; Hugo 0.168's upstream LibSass deprecation warning is accepted.

The Make targets use the published OINK version in go.mod, with local module replacements and workspaces disabled.

make dev

Build the static site with:

make build

Run the module verification and production build with:

make check

The first check creates .venv-check and installs the pinned test dependencies from bin/requirements-test.txt. Subsequent checks reuse that environment. make test runs the link-checker and replica-audit regression tests without rebuilding the site.

OINK is pinned as a Hugo Module in go.mod. Its wordmark, featured-image cascade, and Markdown-first steps are configured or used directly by this site. The project keeps only Silo-specific layouts and styles: the product homepage, download matrix, shared product footer, provenance notice, and imported-document ordering. Documentation chrome, search, content components, blog feeds, and blocks come from the theme. The theme's footer entry point renders the same SILO footer on every page, with language-specific links in data/footer/en.yaml and data/footer/zh.yaml.

The appearance menu offers Paper (default), Slate, Ink, and Terminal in both languages, independently of light/dark mode. Configure the default and available styles through params.ui.preset and params.ui.preset_menu in hugo.yaml.

Content convention

Contributor records

The reviewed roster in data/home/contributors.yaml drives the homepage and generates both contributor pages, the five software repositories' CONTRIBUTORS.md files (Server, Console, mcli, silo-pkg and KES), and their README sections. Include every human issue / PR author, in any state; retain acknowledged security disclosures and distinguish incorporated work from the original PR's merge status. Preserve historical release credits.

Refresh the complete paginated GitHub records for every repository listed in the data file (gh api --paginate --slurp 'repos/pgsty/REPO/issues?state=all&per_page=100'). Review descriptions, adoption evidence, account deduplication, bot exclusions, status lists, repository totals, ordering, and the audit date together. Then, with sibling software checkouts present and Python's PyYAML package available:

python3 bin/contributors.py
python3 bin/contributor_avatars.py
python3 bin/contributors.py --check
make check

Use --workspace /path/to/checkouts for a different sibling-checkout location. Publish new site pages and avatar assets before publishing source-repository updates that reference their public URLs.

Bilingual content

English is the default language. Keep translations next to each other:

content/operations/concepts/_index.md
content/operations/concepts/_index.zh.md

The product homepage lives at /; the documentation overview lives at /docs/. The migrated content tree preserves the established MinIO documentation URL families:

/
├── operations/
├── administration/
├── developers/
├── reference/
├── integrations/
└── glossary/

Silo-specific migration and compatibility guidance lives in content/compatibility/, the advisory ledger in content/about/security-advisories.*, and design, security investigations written for readers, and release articles in content/blog/. Raw investigation plans, prompts, session transcripts, execution logs, and private security evidence stay outside both this checkout and the server checkout. When retiring server-side documents, preserve useful knowledge here, repair incoming links, and publish new routes before publishing the source cleanup. Repository maintenance rules are in AGENTS.md; CLAUDE.md imports that same guide.

The English and Chinese corpus was converted deterministically from frozen Sphinx RST/MyST source. The upstream revisions it was frozen from are recorded in NOTICE.md.

URL policy

Use https://silo.pgsty.com/ as the canonical public origin for Silo pages. English pages live at the site root and Chinese pages use the /zh/ prefix. Within this repository, prefer root-relative links for site content so local previews and both language trees remain portable; use absolute https://silo.pgsty.com/... URLs in downloadable examples, repository READMEs, service metadata, and other content consumed outside the rendered site.

Do not rewrite primary external sources as Silo URLs. AWS specifications, SDK API references, source repositories, releases, and third-party products should continue to link to their authoritative upstream locations.

Page provenance

Pages carried over from the MinIO documentation declare their source in front matter, which drives the attribution notice rendered at the bottom of the page:

upstream_link: https://github.com/minio/docs # material this page is derived from
upstream_modified: true # set true when Silo changes substance beyond the format conversion

upstream_link identifies the source and upstream_modified records whether its substance has changed. Shared attribution metadata — the work's name, the copyright notice, the license, and the attribution page — is declared once in hugo.yaml (upstream_name, upstream_copyright, upstream_license, upstream_notice); the theme fails the build if a page names a source without that metadata.

Set upstream_modified: true when you change the substance of a MinIO-derived page. The notice then links to that file's change history. Pages written from scratch by Silo — the blog, download and release pages, Silo-specific content — carry neither field. A page under a section that cascades the upstream keys opts out with upstream_link: "".

Attribution and license

All documentation content is licensed under the Creative Commons Attribution 4.0 International license (CC BY 4.0), the same license as upstream. Portions of it are derived from the MinIO Object Storage Documentation, © 2020–Present MinIO, Inc., and have been modified.

See LICENSE for the full license text and NOTICE.md for the copyright stack, frozen upstream revisions, material changes, translation notice, and trademark notice.

The same notices are published for readers under content/about/, rendered at /about/:

Page Covers
/about/license/ AGPLv3 for the software, CC BY 4.0 for the documentation
/about/trademark/ How the MinIO name is used, and the non-affiliation statement
/about/attribution/ Copyright stack, derivation, translation notice, credit line
/about/security/ How to report a vulnerability, and where fixes are published

About

Website of Silo

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages