Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Oct 5, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
264709e
mc deprecations: tidy formatting, move mc admin top
feorlen Oct 4, 2023
c6965c5
more alphabetizing
feorlen Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion source/reference/deprecated/mc-admin-bucket-quota.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion source/reference/deprecated/mc-admin-idp-ldap-policy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion source/reference/deprecated/mc-admin-idp-ldap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion source/reference/deprecated/mc-admin-idp-openid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
4 changes: 1 addition & 3 deletions source/reference/deprecated/mc-admin-speedtest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
6 changes: 2 additions & 4 deletions ...reference/minio-mc-admin/mc-admin-top.rst → source/reference/deprecated/mc-admin-top.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,9 @@

.. mc:: mc admin top

.. note::
.. versionchanged:: RELEASE.2022-08-11T00-30-48Z
feorlen marked this conversation as resolved.
Show resolved Hide resolved

.. versionchanged:: RELEASE.2022-08-11T00-30-48Z

:mc-cmd:`mc support top` replaces the ``mc admin top`` command.
``mc admin top`` replaced by :mc-cmd:`mc support top`.

Description
-----------
Expand Down
2 changes: 1 addition & 1 deletion source/reference/deprecated/mc-ilm-add.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
------
Expand Down
2 changes: 1 addition & 1 deletion source/reference/deprecated/mc-ilm-edit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/reference/deprecated/mc-ilm-export.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/reference/deprecated/mc-ilm-import.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/reference/deprecated/mc-ilm-ls.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/reference/deprecated/mc-ilm-rm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 0 additions & 6 deletions source/reference/minio-mc-admin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,6 @@ The following table lists :mc:`mc admin` commands:
:start-after: start-mc-admin-service-desc
:end-before: end-mc-admin-service-desc

* - :mc-cmd:`mc admin top`
- .. include:: /reference/minio-mc-admin/mc-admin-top.rst
:start-after: start-mc-admin-top-desc
:end-before: end-mc-admin-top-desc

* - :mc-cmd:`mc admin trace`
- .. include:: /reference/minio-mc-admin/mc-admin-trace.rst
:start-after: start-mc-admin-trace-desc
Expand Down Expand Up @@ -212,7 +207,6 @@ See :ref:`minio-mc-global-options`.
/reference/minio-mc-admin/mc-admin-rebalance
/reference/minio-mc-admin/mc-admin-replicate
/reference/minio-mc-admin/mc-admin-service
/reference/minio-mc-admin/mc-admin-top
/reference/minio-mc-admin/mc-admin-trace
/reference/minio-mc-admin/mc-admin-update
/reference/minio-mc-admin/mc-admin-user
Expand Down
56 changes: 30 additions & 26 deletions source/reference/minio-mc-deprecated.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,6 @@ Table of Deprecated Commands
- Replacement Command
- Version of Change

* - ``mc replicate diff``
- :mc-cmd:`mc replicate backlog`
- mc RELEASE.2023-07-18T21-05-38Z

* - ``mc ilm add``
- :mc-cmd:`mc ilm rule add`
- mc RELEASE.2022-12-24T15-21-38Z
Expand All @@ -55,6 +51,10 @@ Table of Deprecated Commands
- :mc-cmd:`mc ilm rule rm`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc replicate diff``
feorlen marked this conversation as resolved.
Show resolved Hide resolved
- :mc-cmd:`mc replicate backlog`
- mc RELEASE.2023-07-18T21-05-38Z


Table of Deprecated Admin Commands
----------------------------------
Expand All @@ -68,6 +68,26 @@ Table of Deprecated Admin Commands
- Replacement Command
- Version of Change

* - ``mc admin bucket remote add``
- :mc-cmd:`mc replicate add`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc admin bucket remote ls``
- :mc-cmd:`mc replicate ls`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc admin bucket remote rm``
- :mc-cmd:`mc replicate rm`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc admin bucket remote update``
- :mc-cmd:`mc replicate update`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc admin bucket quota``
- :mc-cmd:`mc quota clear`, :mc-cmd:`mc quota info`, :mc-cmd:`mc quota set`
- mc RELEASE.2022-12-13T00-23-28Z

* - ``mc admin idp ldap add``
- :mc-cmd:`mc idp ldap add`
- mc RELEASE.2023-05-26T23-31-54Z
Expand Down Expand Up @@ -168,26 +188,9 @@ Table of Deprecated Admin Commands
- :mc:`mc ilm tier ls`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc admin bucket remote add``
- :mc-cmd:`mc replicate add`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc admin bucket remote rm``
- :mc-cmd:`mc replicate rm`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc admin bucket remote ls``
- :mc-cmd:`mc replicate ls`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc admin bucket remote update``
- :mc-cmd:`mc replicate update`
- mc RELEASE.2022-12-24T15-21-38Z

* - ``mc admin bucket quota``
- :mc-cmd:`mc quota clear`, :mc-cmd:`mc quota info`, :mc-cmd:`mc quota set`
- mc RELEASE.2022-12-13T00-23-28Z

* - ``mc admin top``
- :mc:`mc support top`
- mc RELEASE.2022-08-11T00-30-48Z

.. toctree::
:titlesonly:
Expand All @@ -199,9 +202,10 @@ Table of Deprecated Admin Commands
/reference/deprecated/mc-ilm-import
/reference/deprecated/mc-ilm-ls
/reference/deprecated/mc-ilm-rm
/reference/deprecated/mc-admin-bucket-quota
/reference/deprecated/mc-admin-idp-ldap
/reference/deprecated/mc-admin-idp-ldap-policy
/reference/deprecated/mc-admin-idp-openid
/reference/deprecated/mc-admin-tier
/reference/deprecated/mc-admin-bucket-quota
/reference/deprecated/mc-admin-speedtest
/reference/deprecated/mc-admin-tier
/reference/deprecated/mc-admin-top