{"id":13492329,"url":"https://github.com/minio/docs","last_synced_at":"2025-06-20T11:43:01.222Z","repository":{"id":37608988,"uuid":"49700913","full_name":"minio/docs","owner":"minio","description":"MinIO Object Storage Documentation","archived":false,"fork":false,"pushed_at":"2025-06-03T18:53:59.000Z","size":28228,"stargazers_count":554,"open_issues_count":50,"forks_count":313,"subscribers_count":27,"default_branch":"main","last_synced_at":"2025-06-04T04:06:41.179Z","etag":null,"topics":["documentation","minio","sphinx"],"latest_commit_sha":null,"homepage":"https://docs.min.io/minio/baremetal","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-01-15T06:28:20.000Z","updated_at":"2025-06-03T18:53:59.000Z","dependencies_parsed_at":"2023-10-26T19:39:07.677Z","dependency_job_id":"e2d32423-a44d-431d-bd22-7435d75709c4","html_url":"https://github.com/minio/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/minio/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minio","download_url":"https://codeload.github.com/minio/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260940246,"owners_count":23086281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","minio","sphinx"],"created_at":"2024-07-31T19:01:05.010Z","updated_at":"2025-06-20T11:42:56.212Z","avatar_url":"https://github.com/minio.png","language":"SCSS","funding_links":[],"categories":["SCSS"],"sub_categories":[],"readme":"# MinIO Documentation\n\n## Build Instructions\n\nMinIO uses [Sphinx](https://www.sphinx-doc.org/en/master/index.html) to generate static HTML pages using ReSTructured Text (rST).\n\n### Prerequisites\n\n- Any GNU/Linux Operating System, or macOS 12.3 or later.\n- python 3.10.x and python-pip\n- python3.10-venv\n- sphinx 6.2.1\n- nodejs 14.5.0 or later\n- npm 16.19.1 or later\n- `git` or a git-compatible client\n\n### Build\n\n\u003e NOTE: following instructions do work on macOS for testing purposes, however for production builds GNU/Linux is recommended.\n\n1. Clone docs repository locally.\n\n```\ngit clone https://github.com/minio/docs \u0026\u0026 cd docs/\n```\n\n2. Create a new Python virtual environment.\n\n```\npython3 -m venv venv \u0026\u0026 source venv/bin/activate\n```\n\n3. Install all the python and nodejs dependencies\n\n```\npip install -r requirements.txt \u0026\u0026 npm install \u0026\u0026 npm run build\n```\n\n4. Build your desired platform targets.\n\n```\nmake linux\n```\n```\nmake linux k8s container\n```\n\n5. View the generated documentation at http://localhost:8000.\n\n```\npython -m http.server --directory build/YOUR_BRANCH/\u003cPLATFORM\u003e/html\n```\n\n### Stage\n\nThe `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.\n\nFor the command to work, you must have a configured `mc` alias `docs-staging` with general read/write (`s3:*`) permissions on the `staging` bucket.\nThe `staging` bucket should have public or anonymous access enabled.\n\nFor example:\n\n```\nmake stage-linux\n```\n\nDoes the following:\n\n1. Check that the `build/GITDIR/linux` folder exists\n2. Copies the contents of `build/GITDIR/linux/html/*` to `docs-staging/staging/GITDIR/linux`\n\n# Syncing Operator CRD Docs\n\nFor importing the Operator CRD Docs specifically, you must have:\n\n- pandoc (latest stable)\n- asciidoc (latest stable)\n\nIn addition to all other prerequisites.\n\nRun \n\n```\nmake sync-operator-crd\n```\n\nThis script does three things:\n\n- Downloads and converts the `tenant-crd.adoc` from the MinIO Operator Github repository\n- Downloads the Operator Helm `values.yaml` from the Operator Github repository\n- Downloads the Tenant Helm `values.yaml` from the Operator Github repository\n\nFor the the `tenant-crd.adoc` , it converts the asciidoc to XML, then to markdown.\nFinally, it does some `sed` find/replace to tidy up the file for Sphinx ingest.\n\nYou can run this when we have a new Operator release being documented, assuming there are changes to the CRD as part of that release.\nIt 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.\n\n# License\n\nThis project is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/legalcode). See [CONTRIBUTING.md](https://github.com/minio/docs/tree/master/CONTRIBUTING.md) guide for more information on contributing to the MinIO Documentation project.\n\n\u003e NOTE: This work was previously licensed under AGPL3.0. You can find all AGPL3.0 licensed code at commit:[73772c7f8485809446cc890188a89ece1afb93f6](https://github.com/minio/docs/tree/73772c7f8485809446cc890188a89ece1afb93f6)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminio%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminio%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminio%2Fdocs/lists"}