From ce6c23a360090fee242b6ce1fd490c5035ad78c0 Mon Sep 17 00:00:00 2001 From: daniel-bogusz95 <80654328+daniel-bogusz95@users.noreply.github.com> Date: Fri, 17 Jun 2022 15:20:30 -0700 Subject: [PATCH] docs: some grammatical, typo fixes includes #15104, #15105, #15106, #15107 --- docs/config/README.md | 13 +++++++------ docs/gateway/nas.md | 15 +++++++-------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index 3241867a1..2258739e5 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2,7 +2,7 @@ ## Configuration Directory -MinIO stores all its config as part of the server deployment, config is erasure coded on MinIO. On a fresh deployment MinIO automatically generates a new `config` and this config is available to be configured via `mc admin config` command. MinIO also encrypts all the config, IAM and policies content if KMS is configured. Please refer to how to encrypt your config and IAM credentials [here](https://github.com/minio/minio/blob/master/docs/kms/IAM.md) +MinIO stores all its config as part of the server deployment, config is erasure coded on MinIO. On a fresh deployment MinIO automatically generates a new `config` and this config is available to be configured via `mc admin config` command. MinIO also encrypts all the config, IAM and policies content if KMS is configured. Please refer to how to encrypt your config and IAM credentials [here](https://github.com/minio/minio/blob/master/docs/kms/IAM.md). ### Certificate Directory @@ -123,7 +123,7 @@ MINIO_CACHE_COMMENT (sentence) optionally add a comment to this setting #### Etcd -MinIO supports storing encrypted IAM assets in etcd, if KMS is configured. Please refer to how to encrypt your config and IAM credentials [here](https://github.com/minio/minio/blob/master/docs/kms/IAM.md) +MinIO supports storing encrypted IAM assets in etcd, if KMS is configured. Please refer to how to encrypt your config and IAM credentials [here](https://github.com/minio/minio/blob/master/docs/kms/IAM.md). > NOTE: if *path_prefix* is set then MinIO will not federate your buckets, namespaced IAM assets are assumed as isolated tenants, only buckets are considered globally unique but performing a lookup with a *bucket* which belongs to a different tenant will fail unlike federated setups where MinIO would port-forward and route the request to relevant cluster accordingly. This is a special feature, federated deployments should not need to set *path_prefix*. @@ -181,7 +181,7 @@ MINIO_API_REMOTE_TRANSPORT_DEADLINE (duration) set the deadline for API reques #### Notifications -Notification targets supported by MinIO are in the following list. To configure individual targets please refer to more detailed documentation [here](https://docs.min.io/docs/minio-bucket-notification-guide.html) +Notification targets supported by MinIO are in the following list. To configure individual targets please refer to more detailed documentation [here](https://docs.min.io/docs/minio-bucket-notification-guide.html). ``` notify_webhook publish bucket notifications to webhook endpoints @@ -244,7 +244,7 @@ MINIO_ETCD_CLIENT_CERT_KEY (path) client cert key for mTLS authentication MINIO_ETCD_COMMENT (sentence) optionally add a comment to this setting ``` -This behavior is consistent across all keys, each key self documents itself with valid examples. +This behavior is consistent across all keys; each key self-documents itself with valid examples. ## Dynamic systems without restarting server @@ -274,7 +274,7 @@ delay (float) scanner delay multiplier, defaults to '10.0' max_wait (duration) maximum wait time between operations, defaults to '15s' ``` -Example: Following setting will decrease the scanner speed by a factor of 3, reducing the system resource use, but increasing the latency of updates being reflected. +Example: the following setting will decrease the scanner speed by a factor of 3, reducing the system resource use, but increasing the latency of updates being reflected. ```sh ~ mc admin config set alias/ scanner delay=30.0 @@ -326,7 +326,8 @@ minio server /data ### Domain -By default, MinIO supports path-style requests that are of the format . `MINIO_DOMAIN` environment variable is used to enable virtual-host-style requests. If the request `Host` header matches with `(.+).mydomain.com` then the matched pattern `$1` is used as bucket and the path is used as object. More information on path-style and virtual-host-style [here](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAPI.html) +By default, MinIO supports path-style requests that are of the format . `MINIO_DOMAIN` environment variable is used to enable virtual-host-style requests. If the request `Host` header matches with `(.+).mydomain.com` then the matched pattern `$1` is used as bucket and the path is used as object. Read more about path-style and virtual-host-style [here](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAPI.html). + Example: ```sh diff --git a/docs/gateway/nas.md b/docs/gateway/nas.md index e1a160974..c0d25f38a 100644 --- a/docs/gateway/nas.md +++ b/docs/gateway/nas.md @@ -43,7 +43,7 @@ MinIO Gateway comes with an embedded web based object browser. Point your web br ## Test using MinIO Client `mc` -`mc` provides a modern alternative to UNIX commands such as ls, cat, cp, mirror, diff etc. It supports filesystems and Amazon S3 compatible cloud storage services. +`mc` provides a modern alternative to UNIX commands such as ls, cat, cp, mirror, diff, etc. It supports filesystems and Amazon S3 compatible cloud storage services. ### Configure `mc` @@ -88,25 +88,24 @@ export MINIO_NOTIFY_WEBHOOK_ENDPOINT_1=http://localhost:8080/ export MINIO_NOTIFY_WEBHOOK_QUEUE_DIR_1=/tmp/webhk ``` -> NOTE: Please check the docs for the corresponding ENV setting. Alternatively, We can obtain other ENVs in the form `mc admin config set alias/ --env` +> NOTE: Please check the docs for the corresponding ENV setting. Alternatively, we can obtain other ENVs in the form `mc admin config set alias/ --env` ## Symlink support -NAS gateway implementation allows symlinks on regular files, +NAS gateway implementation allows symlinks on regular files. ### Behavior -- For reads symlink resolves to file symlink points to. +- For reads symlinks resolve to the file the symlink points to. - For deletes - - Delete of symlink deletes the symlink but not the real file to which the symlink points. - - Delete of actual file automatically makes symlink'ed file invisible, dangling symlinks won't be visible. + - Deleting a symlink deletes the symlink but not the real file to which the symlink points. + - Deleting the real file a symlink points to automatically makes the dangling symlink invisible. #### Caveats - Disallows follow of directory symlinks to avoid security issues, and leaving them as is on namespace makes them very inconsistent. -- Dangling symlinks are ignored automatically. -*Directory symlinks is not and will not be supported as there are no safe ways to handle them.* +*Directory symlinks are not and will not be supported as there are no safe ways to handle them.* ## Explore Further