mirror of
https://github.com/minio/docs.git
synced 2025-06-08 18:02:00 +03:00
201b13324e
Addresses five outstanding Issues in the `mc` reference docs. - Adds `--disable-multipart` flag for `mc mv` (Closes #516 ) - Adds `mc pipe` to reference docs (Closes #517 ) - Adds `mc undo` to reference docs (Closes #520 ) - Adds `mc support top` commands to replace `mc admin top` (Closes #526) - Updates `mc cp`, `mc mirror`, `mc replicate`, and `mc admin replicate` to clarify the differences in what copies (Closes #532)
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.