minio / Docs
Licence: agpl-3.0
MinIO Object Storage Documentation
Stars: ✭ 488
Programming Languages
python
139335 projects - #7 most used programming language
Labels
Projects that are alternatives of or similar to Docs
Sphinx Automodapi
Sphinx extension for generating API documentation
Stars: ✭ 36 (-92.62%)
Mutual labels: documentation, sphinx
Awesome Sphinxdoc
A curated list of awesome tools for Sphinx Python Documentation Generator
Stars: ✭ 716 (+46.72%)
Mutual labels: documentation, sphinx
Sphinx Gallery
Sphinx extension for automatic generation of an example gallery
Stars: ✭ 239 (-51.02%)
Mutual labels: documentation, sphinx
Symbiflow Arch Defs
FOSS architecture definitions of FPGA hardware useful for doing PnR device generation.
Stars: ✭ 137 (-71.93%)
Mutual labels: documentation, sphinx
Awesome Docs With Static Site Generators
Pointers to all templates and implementations based on static site generators
Stars: ✭ 44 (-90.98%)
Mutual labels: documentation, sphinx
Doc2dash
Create docsets for Dash.app-compatible API browser.
Stars: ✭ 380 (-22.13%)
Mutual labels: documentation, sphinx
Flask Sphinx Themes
Sphinx themes for Pallets projects
Stars: ✭ 164 (-66.39%)
Mutual labels: documentation, sphinx
Sphinx
Main repository for the Sphinx documentation builder
Stars: ✭ 4,313 (+783.81%)
Mutual labels: documentation, sphinx
Sklearn Doc Zh
📖 [译] scikit-learn(sklearn) 中文文档
Stars: ✭ 4,520 (+826.23%)
Mutual labels: documentation
Testcontainers Spring Boot
Container auto-configurations for spring-boot based integration tests
Stars: ✭ 460 (-5.74%)
Mutual labels: minio
Mathjax Docs
MathJax documentation. Beautiful math in all browsers. Beautifully documented.
Stars: ✭ 437 (-10.45%)
Mutual labels: documentation
Flight Manual.atom.io
📖 Documentation for Atom, generated by nanoc, hosted by GitHub Pages
Stars: ✭ 435 (-10.86%)
Mutual labels: documentation
Purescript Jordans Reference
Learn PureScript with this "clone and play" repository
Stars: ✭ 434 (-11.07%)
Mutual labels: documentation
Rabbitmq Website
RabbitMQ website and documentation guides
Stars: ✭ 433 (-11.27%)
Mutual labels: documentation
MinIO Docs
Requirements
- python3 (any version should be fine, latest is ideal)
- suggest creating a virtual environment to keep things clean and simple:
- start by cloning the repository.
cd
into the cloned repo. You might need togit fetch
to refresh the repo. - once in the repository root, run the following.
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
nvm install v14.5.0
nvm use v14.5.0
npm install
To make the build, do:
make html
Artifacts output to the build/
directory as HTML. Just open index.html
to get started poking around.
If you modify things, I suggest doing clean builds to make sure all artifacts are fresh:
rm -rf build/ && make html
Still need to work out deployment steps, but this should work for testing locally.
The source
directory contains all of the source files, including css and js.
The sphinxext
directory contains some python stuff related to the custom directive/roles, and its a rats nest right now.
TODO
- Finish the remainder of the
mc
,mc admin
, andminio
reference material - Refine structure of reference pages
- Transition all MinIO Features from legacy documentation and format for RST
- Flesh out Kubernetes section (pending operator/plugin work completion)
- Flesh out introduction / concepts section
- Re-write security docs
- Create references for KES, Sidekick, MCS, Gateway
- Transition cookbook material as needed
- Flesh out Baremetal deployment section
- Scan for any remaining legacy material that needs migration
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].