Skip to content

Repository files navigation

Silo Documentation

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

Local development

Install Hugo Extended 0.160.1 or newer, Go, and Git. OINK vendors the browser and styling dependencies required by the site, so a Node.js toolchain is not needed.

make dev

Build the static site with:

make build

Run the module verification and warning-strict production build with:

make check

OINK is pinned as a Hugo Module in go.mod. The project keeps only Silo-specific layouts and styles: the product homepage, download matrix, provenance notice, and imported-document ordering. Documentation chrome, search, footer, content components, blog feeds, and blocks come from the theme.

Content convention

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/

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 it in their front matter, which drives the attribution notice rendered at the bottom of the page:

minio_origin: true # page is derived from the MinIO documentation
silo_modified: false # page has been changed by Silo beyond the format conversion

Set silo_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.

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

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages