mirror of
https://github.com/minio/docs.git
synced 2025-07-22 23:02:06 +03:00
b88a29a223
Updates for mc release 2022-08-23
Closes #536
- Thoroughly updated the `mc ilm add` reference page and added --prefix and --newer** flags.
- Updates the `mc ilm edit` reference page to add the --prefix, --disable, and --enable flags.
- Adds `mc od` command
- Adds `--with-versioning` flag to `mc mb`
- Adds `--api-key` to `mc support diag`
- Adds clarification to --airgap flag on `mc license` and `mc support` topics that flag is not required if the local device has network access, even if the deployment is airgapped.
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