Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minio/docs
MinIO Object Storage Documentation
https://github.com/minio/docs
documentation minio sphinx
Last synced: 10 days ago
JSON representation
MinIO Object Storage Documentation
- Host: GitHub
- URL: https://github.com/minio/docs
- Owner: minio
- License: cc-by-4.0
- Created: 2016-01-15T06:28:20.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:23:16.000Z (11 days ago)
- Last Synced: 2024-10-29T21:34:35.324Z (11 days ago)
- Topics: documentation, minio, sphinx
- Language: SCSS
- Homepage: https://docs.min.io/minio/baremetal
- Size: 26.2 MB
- Stars: 547
- Watchers: 27
- Forks: 298
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# MinIO Documentation
## Build Instructions
MinIO uses [Sphinx](https://www.sphinx-doc.org/en/master/index.html) to generate static HTML pages using ReSTructured Text (rST).
### Prerequisites
- Any GNU/Linux Operating System, or macOS 12.3 or later.
- python 3.10.x and python-pip
- python3.10-venv
- sphinx 6.2.1
- nodejs 14.5.0 or later
- npm 16.19.1 or later
- `git` or a git-compatible client
### Build
> NOTE: following instructions do work on macOS for testing purposes, however for production builds GNU/Linux is recommended.
1. Clone docs repository locally.
```
git clone https://github.com/minio/docs && cd docs/
```
2. Create a new Python virtual environment.
```
python3 -m venv venv && source venv/bin/activate
```
3. Install all the python and nodejs dependencies
```
pip install -r requirements.txt && npm install && npm run build
```
4. Build your desired platform targets.
```
make linux
```
```
make linux k8s container
```
5. View the generated documentation at http://localhost:8000.
```
python -m http.server --directory build/YOUR_BRANCH//html
```
### Stage
The `make stage-PLATFORM` command uses the `mc` utility to copy the contents of the current git branch build output for the specified `PLATFORM` to a configured MinIO or S3-compatible bucket.
For the command to work, you must have a configured `mc` alias `docs-staging` with general read/write (`s3:*`) permissions on the `staging` bucket.
The `staging` bucket should have public or anonymous access enabled.
For example:
```
make stage-linux
```
Does the following:
1. Check that the `build/GITDIR/linux` folder exists
2. Copies the contents of `build/GITDIR/linux/html/*` to `docs-staging/staging/GITDIR/linux`
# Syncing Operator CRD Docs
For importing the Operator CRD Docs specifically, you must have:
- pandoc (latest stable)
- asciidoc (latest stable)
In addition to all other prerequisites.
Run
```
make sync-operator-crd
```
This script does three things:
- Downloads and converts the `tenant-crd.adoc` from the MinIO Operator Github repository
- Downloads the Operator Helm `values.yaml` from the Operator Github repository
- Downloads the Tenant Helm `values.yaml` from the Operator Github repository
For the the `tenant-crd.adoc` , it converts the asciidoc to XML, then to markdown.
Finally, it does some `sed` find/replace to tidy up the file for Sphinx ingest.
You can run this when we have a new Operator release being documented, assuming there are changes to the CRD as part of that release.
It should make it somewhat easier to periodically sync these docs instead of pulling them down every single build, when we do not expect or need to doc changes in latest stable.
# License
This project is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/legalcode). See [CONTRIBUTING.md](https://github.com/minio/docs/tree/master/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](https://github.com/minio/docs/tree/73772c7f8485809446cc890188a89ece1afb93f6)