From 7f200b96b6b8f5aa510cd6c02bfc8fe39b9713b6 Mon Sep 17 00:00:00 2001 From: Daryl White <53910321+djwfyi@users.noreply.github.com> Date: Wed, 7 Jun 2023 15:01:25 -0500 Subject: [PATCH] Correcting build warning messages (#875) This corrects several build errors that had accrued in the docs. --- source/developers/file-transfer-protocol.rst | 4 ++-- .../configure-keycloak-identity-management.rst | 2 +- .../minio-mc-admin/mc-admin-bucket-remote.rst | 12 +++++------- .../reference/minio-mc-admin/mc-admin-idp-openid.rst | 4 ++-- source/reference/minio-mc/mc-replicate-ls.rst | 7 ++++--- source/url-excludes.yaml | 4 ++++ 6 files changed, 18 insertions(+), 15 deletions(-) diff --git a/source/developers/file-transfer-protocol.rst b/source/developers/file-transfer-protocol.rst index 8bd1be08..3e4487e4 100644 --- a/source/developers/file-transfer-protocol.rst +++ b/source/developers/file-transfer-protocol.rst @@ -189,7 +189,7 @@ Download an Object over FTP This example lists items in a bucket, then downloads the contents of the bucket. -.. code-block:: shell +.. code-block:: console > ftp localhost -P 8021 Connected to localhost. @@ -220,7 +220,7 @@ Connect to MinIO Using SFTP The following example connects to an SSH FTP server, lists the contents of a bucket named ``runner``, and downloads an object. -.. code-block:: shell +.. code-block:: console > sftp -P 8022 minio@localhost minio@localhost's password: diff --git a/source/operations/external-iam/configure-keycloak-identity-management.rst b/source/operations/external-iam/configure-keycloak-identity-management.rst index 1940ed4e..a92f3642 100644 --- a/source/operations/external-iam/configure-keycloak-identity-management.rst +++ b/source/operations/external-iam/configure-keycloak-identity-management.rst @@ -241,7 +241,7 @@ MinIO supports multiple methods for configuring Keycloak Admin API Support: keycloak_realm="REALM" - Replace ``KEYCLOAK_IDENTIFIER`` with the name of the configured Keycloak IDP. - You can use :mc-cmd:`mc admin idp openid list` to view all configured IDP configurations on the MinIO deployment + You can use :mc-cmd:`mc admin idp openid ls` to view all configured IDP configurations on the MinIO deployment - Specify the Keycloak admin URL in the :mc-conf:`keycloak_admin_url ` configuration setting diff --git a/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst b/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst index 9baa4688..b26a79b7 100644 --- a/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst +++ b/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst @@ -91,18 +91,16 @@ Removing the target halts all in-progress Retrieve Configured Replication Targets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use :mc-cmd:`mc admin bucket remote ls` to list a bucket's configured -replication targets: +Use :mc-cmd:`mc replicate ls` to list a bucket's configured replication targets: .. code-block:: shell :class: copyable - mc admin bucket remote ls SOURCE/BUCKET + mc replicate ls ALIAS/PATH -- Replace :mc-cmd:`SOURCE ` with the - :mc-cmd:`alias ` of the MinIO deployment being used as the - replication source. Replace ``BUCKET`` with the full path of the bucket from - which MinIO replicates objects. +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of the MinIO deployment being used as the + replication source. + Replace ``PATH`` with the full path of the bucket from which MinIO replicates objects. Syntax ------ diff --git a/source/reference/minio-mc-admin/mc-admin-idp-openid.rst b/source/reference/minio-mc-admin/mc-admin-idp-openid.rst index 09d26fb9..4482ffb6 100644 --- a/source/reference/minio-mc-admin/mc-admin-idp-openid.rst +++ b/source/reference/minio-mc-admin/mc-admin-idp-openid.rst @@ -39,10 +39,10 @@ The :mc-cmd:`mc admin idp openid` command has the following subcommands: * - :mc-cmd:`mc admin idp openid update` - Modify an existing OpenID IDP server configuration. - * - :mc-cmd:`mc admin idp openid remove` + * - :mc-cmd:`mc admin idp openid rm` - Remove an OpenID IDP server configuration from a deployment. - * - :mc-cmd:`mc admin idp openid list` + * - :mc-cmd:`mc admin idp openid ls` - Outputs a list of the existing OpenID server configurations for a deployment. * - :mc-cmd:`mc admin idp openid info` diff --git a/source/reference/minio-mc/mc-replicate-ls.rst b/source/reference/minio-mc/mc-replicate-ls.rst index b5ed7396..72e00476 100644 --- a/source/reference/minio-mc/mc-replicate-ls.rst +++ b/source/reference/minio-mc/mc-replicate-ls.rst @@ -61,8 +61,9 @@ Parameters ~~~~~~~~~~ .. mc-cmd:: ALIAS + :required: - *Required* the :ref:`alias ` of the MinIO deployment and full path to + The :ref:`alias ` of the MinIO deployment and full path to the bucket or bucket prefix for which to list the replication rules. For example: @@ -72,9 +73,9 @@ Parameters .. mc-cmd:: --status - + :optional: - *Optional* Filter replication rules on the bucket based on their status. + Filter replication rules on the bucket based on their status. Specify one of the following values: - ``enabled`` - Show only enabled replication rules. diff --git a/source/url-excludes.yaml b/source/url-excludes.yaml index c89db14c..57842f28 100644 --- a/source/url-excludes.yaml +++ b/source/url-excludes.yaml @@ -2,6 +2,7 @@ tag: linux excludes: - 'operations/install-deploy-manage/deploy-minio-tenant.rst' - 'operations/install-deploy-manage/modify-minio-tenant.rst' +- 'operations/install-deploy-manage/deploy-operator-helm.rst' - 'operations/install-deploy-manage/expand-minio-tenant.rst' - 'operations/install-deploy-manage/upgrade-minio-tenant.rst' - 'operations/install-deploy-manage/upgrade-minio-operator.rst' @@ -26,6 +27,7 @@ excludes: tag: macos excludes: - 'operations/install-deploy-manage/deploy-minio-tenant.rst' +- 'operations/install-deploy-manage/deploy-operator-helm.rst' - 'operations/install-deploy-manage/modify-minio-tenant.rst' - 'operations/install-deploy-manage/expand-minio-tenant.rst' - 'operations/install-deploy-manage/upgrade-minio-tenant.rst' @@ -51,6 +53,7 @@ excludes: - 'operations/install-deploy-manage/deploy-minio-single-node-single-drive.rst' - 'operations/install-deploy-manage/deploy-minio-single-node-multi-drive.rst' - 'operations/install-deploy-manage/deploy-minio-multi-node-multi-drive.rst' +- 'operations/install-deploy-manage/deploy-operator-helm.rst' - 'operations/install-deploy-manage/multi-site-replication.rst' - 'operations/install-deploy-manage/deploy-minio-tenant.rst' - 'operations/install-deploy-manage/modify-minio-tenant.rst' @@ -70,6 +73,7 @@ excludes: tag: container excludes: - 'operations/install-deploy-manage/deploy-minio-tenant.rst' +- 'operations/install-deploy-manage/deploy-operator-helm.rst' - 'operations/install-deploy-manage/modify-minio-tenant.rst' - 'operations/install-deploy-manage/expand-minio-tenant.rst' - 'operations/install-deploy-manage/upgrade-minio-tenant.rst'