MinIO Object Storage Documentation
MinIO uses Sphinx to generate static HTML pages using ReSTructured Text (rST).
git
or a git-compatible clientNOTE: following instructions do work on macOS for testing purposes, however for production builds GNU/Linux is recommended.
git clone https://github.com/minio/docs && cd docs/
python3 -m venv venv && source venv/bin/activate
pip install -r requirements.txt && npm install && npm run build
make linux
make linux k8s container
python -m http.server --directory build/YOUR_BRANCH/<PLATFORM>/html
The make stage-PLATFORM
command uses the mc
utility to copy the contents of the current git branch build output for the specified PLATFORM
to a configured MinIO or S3-compatible bucket.
For the command to work, you must have a configured mc
alias docs-staging
with general read/write (s3:*
) permissions on the staging
bucket.
The staging
bucket should have public or anonymous access enabled.
For example:
make stage-linux
Does the following:
build/GITDIR/linux
folder existsbuild/GITDIR/linux/html/*
to docs-staging/staging/GITDIR/linux
For importing the Operator CRD Docs specifically, you must have:
In addition to all other prerequisites.
Run
make sync-operator-crd
This script does three things:
tenant-crd.adoc
from the MinIO Operator Github repositoryvalues.yaml
from the Operator Github repositoryvalues.yaml
from the Operator Github repositoryFor the the tenant-crd.adoc
, it converts the asciidoc to XML, then to markdown.
Finally, it does some sed
find/replace to tidy up the file for Sphinx ingest.
You can run this when we have a new Operator release being documented, assuming there are changes to the CRD as part of that release. It should make it somewhat easier to periodically sync these docs instead of pulling them down every single build, when we do not expect or need to doc changes in latest stable.
This project is licensed under a Creative Commons Attribution 4.0 International License. See CONTRIBUTING.md guide for more information on contributing to the MinIO Documentation project.
NOTE: This work was previously licensed under AGPL3.0. You can find all AGPL3.0 licensed code at commit:73772c7f8485809446cc890188a89ece1afb93f6