mirror of
https://github.com/minio/docs.git
synced 2025-09-02 00:02:14 +03:00
1cfda2e9dc
Closes #639 Closes #635 Partially Addresses #590 - MINIO #16026 https://github.com/minio/minio/pull/16026 - MINIO #16044 https://github.com/minio/minio/pull/16044 - MINIO #16035 https://github.com/minio/minio/pull/16035 - CONSOLE #2428 https://github.com/minio/console/pull/2428 Other Fixes: - Removes admonition about IDP interactions (multi-IDP support) - Update Console screenshots and overview page to cover layout changes - Partial fix for DOCS #590 (Policy now under Identity section)
MinIO Documentation
Build Instructions
MinIO uses Sphinx to generate static HTML pages using ReSTructured Text (rST).
Prerequisites
- Any GNU/Linux Operating System.
- python 3.10.x and python-pip
- sphinx 4.3.2
- nodejs 14.5.0 or later
gitor a git-compatible client
Build
NOTE: following instructions do work on macOS for testing purposes, however for production builds GNU/Linux is recommended.
- Clone docs repository locally.
git clone https://github.com/minio/docs && cd docs/
- Create a new Python virtual environment.
python3 -m venv venv && source venv/bin/activate
- Install all the python and nodejs dependencies
pip install -r requirements.txt && npm install && npm run build
- Build all targets at once:
make all
- View the generated documentation visit http://localhost:8000:
python -m http.server --directory build/YOUR_BRANCH/<PLATFORM>/html
License
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