From ecde75f9112f8410cb6cacb4b76193f1475b587e Mon Sep 17 00:00:00 2001 From: Frank Elsinga Date: Sat, 24 May 2025 19:08:30 +0200 Subject: [PATCH] docs: use github-style-notes in the readme (#21308) use notes in the readme --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5a926655b..9a854a523 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,9 @@ You can also connect using any S3-compatible tool, such as the MinIO Client `mc` [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, see to view MinIO SDKs for supported languages. -> NOTE: To deploy MinIO on with persistent storage, you must map local persistent directories from the host OS to the container using the `podman -v` option. For example, `-v /mnt/data:/data` maps the host OS drive at `/mnt/data` to `/data` on the container. +> [!NOTE] +> To deploy MinIO on with persistent storage, you must map local persistent directories from the host OS to the container using the `podman -v` option. +> For example, `-v /mnt/data:/data` maps the host OS drive at `/mnt/data` to `/data` on the container. ## macOS @@ -51,7 +53,8 @@ brew install minio/stable/minio minio server /data ``` -> NOTE: If you previously installed minio using `brew install minio` then it is recommended that you reinstall minio from `minio/stable/minio` official repo instead. +> [!NOTE] +> If you previously installed minio using `brew install minio` then it is recommended that you reinstall minio from `minio/stable/minio` official repo instead. ```sh brew uninstall minio @@ -98,7 +101,8 @@ The MinIO deployment starts using default root credentials `minioadmin:minioadmi You can also connect using any S3-compatible tool, such as the MinIO Client `mc` commandline tool. See [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, see to view MinIO SDKs for supported languages. -> NOTE: Standalone MinIO servers are best suited for early development and evaluation. Certain features such as versioning, object locking, and bucket replication require distributed deploying MinIO with Erasure Coding. For extended development and production, deploy MinIO with Erasure Coding enabled - specifically, with a *minimum* of 4 drives per MinIO server. See [MinIO Erasure Code Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html#) for more complete documentation. +> [!NOTE] +> Standalone MinIO servers are best suited for early development and evaluation. Certain features such as versioning, object locking, and bucket replication require distributed deploying MinIO with Erasure Coding. For extended development and production, deploy MinIO with Erasure Coding enabled - specifically, with a *minimum* of 4 drives per MinIO server. See [MinIO Erasure Code Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html#) for more complete documentation. ## Microsoft Windows @@ -118,7 +122,8 @@ The MinIO deployment starts using default root credentials `minioadmin:minioadmi You can also connect using any S3-compatible tool, such as the MinIO Client `mc` commandline tool. See [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, see to view MinIO SDKs for supported languages. -> NOTE: Standalone MinIO servers are best suited for early development and evaluation. Certain features such as versioning, object locking, and bucket replication require distributed deploying MinIO with Erasure Coding. For extended development and production, deploy MinIO with Erasure Coding enabled - specifically, with a *minimum* of 4 drives per MinIO server. See [MinIO Erasure Code Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html#) for more complete documentation. +> [!NOTE] +> Standalone MinIO servers are best suited for early development and evaluation. Certain features such as versioning, object locking, and bucket replication require distributed deploying MinIO with Erasure Coding. For extended development and production, deploy MinIO with Erasure Coding enabled - specifically, with a *minimum* of 4 drives per MinIO server. See [MinIO Erasure Code Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html#) for more complete documentation. ## Install from Source @@ -132,7 +137,8 @@ The MinIO deployment starts using default root credentials `minioadmin:minioadmi You can also connect using any S3-compatible tool, such as the MinIO Client `mc` commandline tool. See [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, see to view MinIO SDKs for supported languages. -> NOTE: Standalone MinIO servers are best suited for early development and evaluation. Certain features such as versioning, object locking, and bucket replication require distributed deploying MinIO with Erasure Coding. For extended development and production, deploy MinIO with Erasure Coding enabled - specifically, with a *minimum* of 4 drives per MinIO server. See [MinIO Erasure Code Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html) for more complete documentation. +> [!NOTE] +> Standalone MinIO servers are best suited for early development and evaluation. Certain features such as versioning, object locking, and bucket replication require distributed deploying MinIO with Erasure Coding. For extended development and production, deploy MinIO with Erasure Coding enabled - specifically, with a *minimum* of 4 drives per MinIO server. See [MinIO Erasure Code Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html) for more complete documentation. MinIO strongly recommends *against* using compiled-from-source MinIO servers for production environments. @@ -170,7 +176,8 @@ This command gets the active zone(s). Now, apply port rules to the relevant zone firewall-cmd --zone=public --add-port=9000/tcp --permanent ``` -Note that `permanent` makes sure the rules are persistent across firewall start, restart or reload. Finally reload the firewall for changes to take effect. +> [!NOTE] +> `permanent` makes sure the rules are persistent across firewall start, restart or reload. Finally reload the firewall for changes to take effect. ```sh firewall-cmd --reload @@ -199,7 +206,8 @@ service iptables restart MinIO Server comes with an embedded web based object browser. Point your web browser to to ensure your server has started successfully. -> NOTE: MinIO runs console on random port by default, if you wish to choose a specific port use `--console-address` to pick a specific interface and port. +> [!NOTE] +> MinIO runs console on random port by default, if you wish to choose a specific port use `--console-address` to pick a specific interface and port. ### Things to consider @@ -221,7 +229,8 @@ For example, consider a MinIO deployment behind a proxy `https://minio.example.n Upgrades require zero downtime in MinIO, all upgrades are non-disruptive, all transactions on MinIO are atomic. So upgrading all the servers simultaneously is the recommended way to upgrade MinIO. -> NOTE: requires internet access to update directly from , optionally you can host any mirrors at +> [!NOTE] +> requires internet access to update directly from , optionally you can host any mirrors at - For deployments that installed the MinIO server binary by hand, use [`mc admin update`](https://min.io/docs/minio/linux/reference/minio-mc-admin/mc-admin-update.html)