mirror of
https://github.com/minio/docs.git
synced 2025-08-08 01:43:18 +03:00
cleanup README.md build instructions
- remove Windows, macOS instructions just mandate GNU/Linux for all. GNU/Linux instructions work macOS as well. - introduce 'make all' to build all targets.
This commit is contained in:
3
Makefile
3
Makefile
@@ -15,8 +15,9 @@ help:
|
|||||||
|
|
||||||
.PHONY: help Makefile
|
.PHONY: help Makefile
|
||||||
|
|
||||||
# dry-run build command to double check output build dirs
|
all: linux windows macos container kubernetes
|
||||||
|
|
||||||
|
# dry-run build command to double check output build dirs
|
||||||
dryrun:
|
dryrun:
|
||||||
@echo "$(SPHINXBUILD) -M $@ '$(SOURCEDIR)' '$(BUILDDIR)/$(GITDIR)' $(SPHINXOPTS) $(O)"
|
@echo "$(SPHINXBUILD) -M $@ '$(SOURCEDIR)' '$(BUILDDIR)/$(GITDIR)' $(SPHINXOPTS) $(O)"
|
||||||
|
|
||||||
|
137
README.md
137
README.md
@@ -1,124 +1,51 @@
|
|||||||
# MinIO Docs
|
# MinIO Documentation
|
||||||
|
|
||||||
# Build Instructions
|
## Build Instructions
|
||||||
|
|
||||||
MinIO uses [Sphinx](https://www.sphinx-doc.org/en/master/index.html) to generate
|
MinIO uses [Sphinx](https://www.sphinx-doc.org/en/master/index.html) to generate static HTML pages using ReSTructured Text (rST).
|
||||||
static HTML pages using ReSTructured Text (rST).
|
|
||||||
|
|
||||||
## Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Python 3.10.X and pip
|
|
||||||
|
|
||||||
- Sphinx 4.3.2
|
|
||||||
|
|
||||||
- NodeJS 14.5.0 or later and npm
|
|
||||||
|
|
||||||
- gulp.js
|
|
||||||
|
|
||||||
|
- Any GNU/Linux Operating System.
|
||||||
|
- python 3.10.x and python-pip
|
||||||
|
- sphinx 4.3.2
|
||||||
|
- nodejs 14.5.0 or later
|
||||||
- `git` or a git-compatible client
|
- `git` or a git-compatible client
|
||||||
|
|
||||||
- Access to https://github.com/minio/docs
|
### Build
|
||||||
|
|
||||||
## Build Process
|
> NOTE: following instructions do work on macOS for testing purposes, however for production builds GNU/Linux is recommended.
|
||||||
|
|
||||||
### Linux
|
1. Clone docs repository locally.
|
||||||
|
|
||||||
1. Run `git clone https://github.com/minio/docs` and `cd docs` to move into
|
```
|
||||||
the working directory.
|
git clone https://github.com/minio/docs && cd docs/
|
||||||
|
```
|
||||||
|
|
||||||
2. Create a new virtual environment `python3 -m venv venv`. Activate it using
|
2. Create a new Python virtual environment.
|
||||||
`source venv/bin/activate`.
|
|
||||||
|
|
||||||
3. Run `pip install -r requirements.txt` to setup the Python environment.
|
```
|
||||||
|
python3 -m venv venv && source venv/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
4. Run `make` to see the available build targets:
|
3. Install all the python and nodejs dependencies
|
||||||
|
|
||||||
- `make linux`
|
|
||||||
- `make macos`
|
|
||||||
- `make windows`
|
|
||||||
- `make k8s`
|
|
||||||
|
|
||||||
5. Use `python -m http.server --directory build/GIT_BRANCH/<PLATFORM>/html`
|
```
|
||||||
|
pip install -r requirements.txt && npm install && npm run build
|
||||||
Open your browser to http://localhost:8000 to view the staged output.
|
```
|
||||||
|
|
||||||
### MacOS
|
4. Build all targets at once:
|
||||||
|
|
||||||
1. Run `git clone https://github.com/minio/docs` and `cd docs` to move into
|
```
|
||||||
the working directory.
|
make all
|
||||||
|
```
|
||||||
|
|
||||||
2. Create a new virtual environment `python3 -m venv venv`. Activate it using
|
5. View the generated documentation visit http://localhost:8000:
|
||||||
`source venv/bin/activate`.
|
|
||||||
|
|
||||||
3. Run `pip install -r requirements.txt` to setup the Python environment.
|
```
|
||||||
|
python -m http.server --directory build/YOUR_BRANCH/<PLATFORM>/html
|
||||||
|
```
|
||||||
|
|
||||||
4. Run `npm install`
|
# License
|
||||||
|
|
||||||
5. Run `npm run build`
|
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.
|
||||||
|
|
||||||
6. Run `make` to see the available build targets:
|
|
||||||
|
|
||||||
- `make linux`
|
|
||||||
- `make macos`
|
|
||||||
- `make windows`
|
|
||||||
- `make k8s`
|
|
||||||
|
|
||||||
7. Use `python -m http.server --directory build/GIT_BRANCH/<PLATFORM>/html`
|
|
||||||
|
|
||||||
Open your browser to http://localhost:8000 to view the staged output.
|
|
||||||
|
|
||||||
### Windows
|
|
||||||
|
|
||||||
Note: The MinIO Docs builder is designed around the Makefile.
|
|
||||||
Windows users may have issues in build output.
|
|
||||||
Consider running Sphinx in a virtual machine or Windows Subsystem for Linux.
|
|
||||||
|
|
||||||
Prereq:
|
|
||||||
|
|
||||||
- Checkout the MinIO docs repository using your preferred `git` method
|
|
||||||
|
|
||||||
`git clone https://github.com/minio/docs`
|
|
||||||
|
|
||||||
All instructions use PowerShell running as an administrator.
|
|
||||||
|
|
||||||
1. Set policies
|
|
||||||
|
|
||||||
`Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`
|
|
||||||
2. Navigate to the folder with the cloned docs
|
|
||||||
3. Start virtual environment
|
|
||||||
|
|
||||||
`python -m venv venv`
|
|
||||||
4. Activate virtual environment
|
|
||||||
|
|
||||||
`.\venv\Scripts\Activate.ps1`
|
|
||||||
5. Install docs requirements
|
|
||||||
|
|
||||||
`pip install -r requirements.txt`
|
|
||||||
6. (optional) Delete the Build directory
|
|
||||||
|
|
||||||
`Remove-Item build\`
|
|
||||||
7. Generate CSS from SCSS files
|
|
||||||
|
|
||||||
`npm run build`
|
|
||||||
8. Build the docs
|
|
||||||
|
|
||||||
`sphinx-build -M html source\ build\GITBRANCH\TAG\ -n -t TAG`
|
|
||||||
|
|
||||||
Replace `TAG` with one of the following supported values:
|
|
||||||
|
|
||||||
- `k8s`
|
|
||||||
- `linux`
|
|
||||||
- `macos`
|
|
||||||
- `windows`
|
|
||||||
|
|
||||||
9. Start the http server
|
|
||||||
|
|
||||||
`python -m http.server --directory build\GITBRANCH\TAG\html`
|
|
||||||
10. View the staged output in a browser by going to `localhost:8000`
|
|
||||||
|
|
||||||
License
|
|
||||||
-------
|
|
||||||
|
|
||||||
This project is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/legalcode).
|
|
||||||
|
|
||||||
See [CONTRIBUTIONS](https://github.com/minio/docs/tree/master/CONTRIBUTING.md) for more information on contributing content to the MinIO Documentation project.
|
|
||||||
|
@@ -1,13 +1,14 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
branch=$(git branch --show-current)
|
branch=$(git branch --show-current)
|
||||||
|
export NVM_DIR="/home/minio/.nvm"
|
||||||
|
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh" # This loads nvm
|
||||||
|
nvm use stable
|
||||||
|
|
||||||
|
export PATH=${PATH}:${HOME}/.local/bin
|
||||||
|
|
||||||
make clean-all
|
make clean-all
|
||||||
make k8s
|
make all
|
||||||
make linux
|
|
||||||
make container
|
|
||||||
make windows
|
|
||||||
make macos
|
|
||||||
|
|
||||||
sudo mkdir -p /var/www/docs/minio/windows
|
sudo mkdir -p /var/www/docs/minio/windows
|
||||||
sudo mkdir -p /var/www/docs/minio/macos
|
sudo mkdir -p /var/www/docs/minio/macos
|
||||||
|
Reference in New Issue
Block a user