Need help with cookbook?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

minio
487 Stars 200 Forks Apache License 2.0 17 Commits 4 Opened issues

Description

Source for future MinIO Documentation Site.

Services available

!
?

Need anything else?

Contributors list

No Data

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 to
    git 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

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
    , and
    minio
    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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.