docs: turn-on more markdown rules and fix them (#14301)

This commit is contained in:
Harshavardhana
2022-02-14 08:50:42 -08:00
committed by GitHub
parent 27dec42ad6
commit f088e8960b
13 changed files with 37 additions and 54 deletions

View File

@@ -124,7 +124,7 @@ const (
The "Metadata" section contains a single version, encoded in similar fashion as each version in the `Versions` array
of the previous version.
# Inline Data
## Inline Data
Inline data is optional. If no inline data is present, it is encoded as 0 bytes.

View File

@@ -36,7 +36,7 @@ In the example above this means that `MINIO_CACHE_WATERMARK_LOW` is effectively
To test this setup, access the MinIO gateway via browser or [`mc`](https://docs.min.io/docs/minio-client-quickstart-guide). Youll see the uploaded files are accessible from all the MinIO endpoints.
# Explore Further
## Explore Further
- [Disk cache design](https://github.com/minio/minio/blob/master/docs/disk-caching/DESIGN.md)
- [Use `mc` with MinIO Server](https://docs.min.io/docs/minio-client-quickstart-guide)

View File

@@ -26,15 +26,15 @@ MinIO follows strict **read-after-write** and **list-after-write** consistency m
**If MinIO distributed setup is using NFS volumes underneath it is not guaranteed MinIO will provide these consistency guarantees since NFS is not consistent filesystem by design (If you must use NFS we recommend that you atleast use NFSv4 instead of NFSv3).**
# Get started
## Get started
If you're aware of stand-alone MinIO set up, the process remains largely the same. MinIO server automatically switches to stand-alone or distributed mode, depending on the command line parameters.
## 1. Prerequisites
### 1. Prerequisites
Install MinIO - [MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide).
## 2. Run distributed MinIO
### 2. Run distributed MinIO
To start a distributed MinIO instance, you just need to pass drive locations as parameters to the minio server command. Then, youll need to run the same command on all the participating nodes.

View File

@@ -63,7 +63,7 @@ Distributed MinIO can be deployed via [Docker Compose](https://docs.min.io/docs/
To override MinIO's auto-generated keys, you may pass secret and access keys explicitly as environment variables. MinIO server also allows regular strings as access and secret keys.
#### GNU/Linux and macOS
#### GNU/Linux and macOS (custom access and secret keys)
```sh
docker run \
@@ -76,7 +76,7 @@ docker run \
quay.io/minio/minio server /data --console-address ":9001"
```
#### Windows
#### Windows (custom access and secret keys)
```powershell
docker run \
@@ -93,7 +93,7 @@ docker run \
Docker provides standardized mechanisms to run docker containers as non-root users.
#### GNU/Linux and macOS
#### GNU/Linux and macOS (regular user)
On Linux and macOS you can use `--user` to run the container as regular user.
@@ -112,7 +112,7 @@ docker run \
quay.io/minio/minio server /data
```
#### Windows
#### Windows (regular user)
On windows you would need to use [Docker integrated windows authentication](https://success.docker.com/article/modernizing-traditional-dot-net-applications#integratedwindowsauthentication) and [Create a container with Active Directory Support](https://blogs.msdn.microsoft.com/containerstuff/2017/01/30/create-a-container-with-active-directory-support/)

View File

@@ -78,7 +78,7 @@ it is randomized which cluster might provision the bucket.
To test this setup, access the MinIO server via browser or [`mc`](https://docs.min.io/docs/minio-client-quickstart-guide). Youll see the uploaded files are accessible from the all the MinIO endpoints.
# Explore Further
## Explore Further
- [Use `mc` with MinIO Server](https://docs.min.io/docs/minio-client-quickstart-guide)
- [Use `aws-cli` with MinIO Server](https://docs.min.io/docs/aws-cli-with-minio)

View File

@@ -113,7 +113,7 @@ export MINIO_KMS_KES_KEY_NAME=my-minio-key
minio gateway s3
```
### Using Docker
### Using Docker (double encryption)
```
podman run -p 9000:9000 --name minio-s3 \
@@ -122,7 +122,7 @@ podman run -p 9000:9000 --name minio-s3 \
quay.io/minio/minio gateway s3 https://s3_compatible_service_endpoint:port
```
### Using Binary
### Using Binary (double encryption)
```
export MINIO_ROOT_USER=access_key

View File

@@ -23,19 +23,19 @@ Parquet is DISABLED by default since hostile crafted input can easily crash the
If you are in a controlled environment where it is safe to assume no hostile content can be uploaded to your cluster you can safely enable Parquet.
To enable Parquet set the environment variable `MINIO_API_SELECT_PARQUET=on`.
# Example using Python API
## Example using Python API
## 1. Prerequisites
### 1. Prerequisites
- Install MinIO Server from [here](https://docs.min.io/docs/minio-quickstart-guide).
- Familiarity with AWS S3 API.
- Familiarity with Python and installing dependencies.
## 2. Install boto3
### 2. Install boto3
Install `aws-sdk-python` from AWS SDK for Python official docs [here](https://aws.amazon.com/sdk-for-python/)
## 3. Example
### 3. Example
As an example, let us take a gzip compressed CSV file. Without S3 Select, we would need to download, decompress and process the entire CSV to get the data you needed. With Select API, can use a simple SQL expression to return only the data from the CSV youre interested in, instead of retrieving the entire object. Following Python example shows how to retrieve the first column `Location` from an object containing data in CSV format.

View File

@@ -12,7 +12,7 @@ MinIO shared mode is developed to solve several real world use cases, without an
With a proxy running in front of multiple, shared mode MinIO servers, it is very easy to create a Highly Available, load balanced, AWS S3 compatible storage system.
# Get started
## Get started
If you're aware of stand-alone MinIO set up, the installation and running remains the same.

View File

@@ -237,7 +237,7 @@ MinIO can connect to other servers, including MinIO nodes or other server types
* **Linux:** `~/.minio/certs/CAs/`
* **Windows**: `C:\Users\<Username>\.minio\certs\CAs`
# Explore Further
## Explore Further
* [TLS Configuration for MinIO server on Kubernetes](https://github.com/minio/minio/tree/master/docs/tls/kubernetes)
* [MinIO Client Complete Guide](https://docs.min.io/docs/minio-client-complete-guide)