Improve mc deprecated reference: cleanup, move mc admin top (#1019)

First batch of mc deprecation cleanup: [x] Reorder section TOC: `mc` alphabetical, then `mc admin` alphabetical. [x] Standardize deprecation notice format and wording. [x] Move `mc admin top` to deprecated section. Staged http://192.241.195.202:9000/staging/DOCS-896-cleanup-mc-admin-top/linux/reference/minio-mc-deprecated.html Partially addresses https://github.com/minio/docs/issues/896
2025-07-31 18:04:52 +03:00 · 2023-10-05 10:29:02 -06:00
parent 3b5a7537a4
commit 091a321e32
14 changed files with 47 additions and 49 deletions
--- a/source/reference/deprecated/mc-admin-bucket-quota.rst
+++ b/source/reference/deprecated/mc-admin-bucket-quota.rst
@ -12,7 +12,11 @@

 .. versionchanged:: RELEASE.2022-12-13T00-23-28Z

-   ``mc admin bucket quota`` replaced by :mc-cmd:`mc quota set`, :mc-cmd:`mc quota info`, and :mc-cmd:`mc quota clear`.
+   ``mc admin bucket quota`` replaced by:
+
+   - :mc-cmd:`mc quota set`
+   - :mc-cmd:`mc quota info`
+   - :mc-cmd:`mc quota clear`

 Description
 -----------
--- a/source/reference/deprecated/mc-admin-idp-ldap-policy.rst
+++ b/source/reference/deprecated/mc-admin-idp-ldap-policy.rst
@ -14,7 +14,7 @@

 .. versionchanged:: RELEASE.2023-05-26T23-31-54Z

-   ``mc admin idp ldap policy`` has moved to  :mc-cmd:`mc idp ldap policy`.
+   ``mc admin idp ldap policy`` and its subcommands replaced by :mc-cmd:`mc idp ldap policy`.

 Description
 -----------
--- a/source/reference/deprecated/mc-admin-idp-ldap.rst
+++ b/source/reference/deprecated/mc-admin-idp-ldap.rst
@ -14,7 +14,7 @@

 .. versionchanged:: RELEASE.2023-05-26T23-31-54Z

-   ``mc admin idp ldap`` and its subcommands have moved to  :mc-cmd:`mc idp ldap`.
+   ``mc admin idp ldap`` and its subcommands replaced by :mc-cmd:`mc idp ldap`.

 Description
 -----------
--- a/source/reference/deprecated/mc-admin-idp-openid.rst
+++ b/source/reference/deprecated/mc-admin-idp-openid.rst
@ -14,7 +14,7 @@

 .. versionchanged:: RELEASE.2023-05-26T23-31-54Z

-   ``mc admin idp openid`` and its subcommands have moved to  :mc-cmd:`mc idp openid`.
+   ``mc admin idp openid`` and its subcommands replaced by :mc-cmd:`mc idp openid`.

 Description
 -----------
--- a/source/reference/deprecated/mc-admin-speedtest.rst
+++ b/source/reference/deprecated/mc-admin-speedtest.rst
@ -12,9 +12,7 @@

 .. versionchanged:: RELEASE.2022-07-24T02-25-13Z

-.. important:: 
-
-   The ``mc admin speedtest`` function has moved to the :mc:`mc support perf` command.
+   ``mc admin speedtest`` replaced by :mc:`mc support perf`.

 Description
 -----------
--- a/source/reference/deprecated/mc-admin-top.rst
+++ b/source/reference/deprecated/mc-admin-top.rst
@ -0,0 +1,59 @@
+================
+``mc admin top``
+================
+
+.. default-domain:: minio
+
+.. contents:: Table of Contents
+   :local:
+   :depth: 2
+
+.. mc:: mc admin top
+
+.. versionchanged:: RELEASE.2022-08-11T00-30-48Z
+
+   ``mc admin top`` replaced by :mc-cmd:`mc support top`.
+
+Description
+-----------
+
+.. start-mc-admin-top-desc
+
+The :mc-cmd:`mc admin top` command returns statistics for distributed
+MinIO deployments, similar to the output of the ``top`` command. 
+
+.. end-mc-admin-top-desc
+
+.. admonition:: Use ``mc admin`` on MinIO Deployments Only
+   :class: note
+
+   .. include:: /includes/facts-mc-admin.rst
+      :start-after: start-minio-only
+      :end-before: end-minio-only
+
+Syntax
+------
+
+.. mc-cmd:: locks
+   :fullpath:
+
+   Returns the 10 oldest locks on the MinIO deployment.
+
+   The command has the following syntax:
+
+   .. code-block:: shell
+      :class: copyable
+
+      mc admin top locks TARGET
+
+   The command supports the following arguments:
+
+   .. mc-cmd:: TARGET
+
+      The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment from which
+      the command retrieves statistics.
+
+      The alias *must* correspond to a distributed (multi-node) MinIO deployment.
+      The command returns an error for :term:`single-node single-drive` deployments.
+      
+
--- a/source/reference/deprecated/mc-ilm-add.rst
+++ b/source/reference/deprecated/mc-ilm-add.rst
@ -14,7 +14,7 @@

 .. versionchanged:: RELEASE.2022-12-24T15-21-38Z

-   ``mc ilm add`` replaced by :mc-cmd:`mc ilm rule add`
+   ``mc ilm add`` replaced by :mc-cmd:`mc ilm rule add`.

 Syntax
 ------
--- a/source/reference/deprecated/mc-ilm-edit.rst
+++ b/source/reference/deprecated/mc-ilm-edit.rst
@ -14,7 +14,7 @@

 .. versionchanged:: RELEASE.2022-12-24T15-21-38Z

-   ``mc ilm edit`` replaced by :mc-cmd:`mc ilm rule edit`
+   ``mc ilm edit`` replaced by :mc-cmd:`mc ilm rule edit`.


 Syntax
--- a/source/reference/deprecated/mc-ilm-export.rst
+++ b/source/reference/deprecated/mc-ilm-export.rst
@ -14,7 +14,7 @@

 .. versionchanged:: RELEASE.2022-12-24T15-21-38Z

-   ``mc ilm export`` replaced by :mc-cmd:`mc ilm rule export`
+   ``mc ilm export`` replaced by :mc-cmd:`mc ilm rule export`.


 Syntax
--- a/source/reference/deprecated/mc-ilm-import.rst
+++ b/source/reference/deprecated/mc-ilm-import.rst
@ -14,7 +14,7 @@

 .. versionchanged:: RELEASE.2022-12-24T15-21-38Z

-   ``mc ilm import`` replaced by :mc-cmd:`mc ilm rule import`
+   ``mc ilm import`` replaced by :mc-cmd:`mc ilm rule import`.


 Syntax
--- a/source/reference/deprecated/mc-ilm-ls.rst
+++ b/source/reference/deprecated/mc-ilm-ls.rst
@ -14,7 +14,7 @@

 .. versionchanged:: RELEASE.2022-12-24T15-21-38Z

-   ``mc ilm ls`` replaced by :mc-cmd:`mc ilm rule ls`
+   ``mc ilm ls`` replaced by :mc-cmd:`mc ilm rule ls`.


 Syntax
--- a/source/reference/deprecated/mc-ilm-rm.rst
+++ b/source/reference/deprecated/mc-ilm-rm.rst
@ -15,7 +15,7 @@

 .. versionchanged:: RELEASE.2022-12-24T15-21-38Z

-   ``mc ilm rm`` replaced by :mc-cmd:`mc ilm rule rm`
+   ``mc ilm rm`` replaced by :mc-cmd:`mc ilm rule rm`.


 Syntax