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

Jump to bottom

mc command deprecation audit #896

Open
feorlen opened this issue Jun 26, 2023 · 3 comments
Open

mc command deprecation audit #896

feorlen opened this issue Jun 26, 2023 · 3 comments
Assignees
@feorlen

Comments

@feorlen
Copy link
Collaborator

feorlen commented Jun 26, 2023

Moving deprecated mc commands to a separate section is relatively recent, there are some additional ones that should also be there. For example, mc admin top.

Identify these earlier deprecated mc commands and relocate them to the Deprecated Commands section.
@ravindk89
Copy link
Collaborator

https://pypi.org/project/sphinx-reredirects/

goes into conf.py, but might be nice to yaml-ize and then convert to a dict

@feorlen feorlen self-assigned this Oct 2, 2023
@feorlen
Copy link
Collaborator Author

feorlen commented Oct 3, 2023 •
edited

Findings:

These are in the list of deprecated commands, no separate page

Mainly deprecated because they were renamed

  • mc admin policy set
  • mc admin policy set
  • mc admin policy unset
  • mc admin policy update
  • mc admin replicate diff
  • mc admin replicate edit
  • mc admin replicate remove
  • mc admin bucket remote add
  • mc admin bucket remote update
  • mc admin bucket remote ls
  • mc admin bucket remote bandwidth

Not in list, doesn't have page

  • mc admin top ✅

mc admin replicate update

This one is good, clearly marked

  • --sync

Streaming options for notify_nats configuration key deprecated, others ok

Move these to the end of the nats section

  • streaming
  • streaming_async
  • streaming_max_pub_acks_in_flight
  • streaming_cluster_id

mc admin heal deprecated options, others ok

Revisit removing these from docs in a few months #1029 ✅
But docs say we may still tell someone to use them?
Are there replacement commands?

  • --scan
  • --recursive, r
  • --dry-run
  • --force-start, f
  • --force-stop, s
  • --remove

mc admin user svcacct add (maybe edit as well but unclear)

This is ok, clearly marked

  • --comment

@feorlen feorlen mentioned this issue Oct 4, 2023
Merged
feorlen added a commit that referenced this issue Oct 5, 2023
@feorlen
Improve mc deprecated reference: cleanup, move mc admin top (#1019)
091a321 
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 #896
@feorlen feorlen mentioned this issue Oct 6, 2023
Merged
@feorlen
Copy link
Collaborator Author

feorlen commented Nov 30, 2023

Sticking this back in to-do for the moment. Partly complete, the long tail of tidying was always going to be a background task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@feorlen feorlen

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@feorlen @ravindk89