- Adds landing pages for all two-word `mc` commands
- Nests three+ word commands under appropriate two-word commands
- Updates MinIO Client doc
- Uses description from each command to populate list of subcommand
descriptions
- Modifies toctree for MinIO Client doc and each command/subcommand to
improve left nav experienc
Closes#710
Updates related to [mc
RELEASE.2023-01-28T20-29-38Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-01-28T20-29-38Z)
- new `--comment` flag for `mc admin user add` service accounts
- new `--airgap` flag for `mc license unregister`
- new `--encrypt-key` flag for `mc ilm restore`
- removed `--duration` flag for `mc support perf`
- new `--api-key` flag for `mc license register`
No doc issue for tracking this release.
Closes#715 for ilm restore flag
Two releases for MinIO in December 2022 and Jan 2023 affected the docs.
Updates for Dec 2022 minio updates
- Adds 500,000 as the recommended but not hard limit to number of
buckets
- Adds info on encrypting list of file names in zip archives
Closes#684
Updates for Jan 2 2023 release
- Adds info about setting server to listen on multiple IP addresses
- Updates list of available metrics
Closes#689
This PR applies updates to numerous files to address changes in the two
December 2022 `mc` releases.
- Deprecates `mc admin bucket quota` and links to new commands
- Adds `mc quota set | clear | info` commands
- Adds `attach | detach` subcommands to `mc admin idp ldap policy`
- Updates list of call types available to `mc admin trace`
- Updates `mc` page with new commands
- Fixes minor errors in `mc cp`
- Adds `--limit-*` flags to global flag options
- Adds `--versions` flag to `mc find`
Closes#685
- Updates ilm commands for new structure for tiers and rules
- Deprecates `mc admin tier`
- Deprecates `mc ilm add | edit | export | import | ls | rm` commands
- Adds new `mc ilm rule` and six subcommands
- Adds new `mc ilm tier` and six subcommands
- Updates references to ilm and admin tier commands throughout docs
- Adds new deprecated commands page
- Adds `mc ilm rule` and `mc ilm tier` holding pages with toctrees
- Closes#691
- Closes#662
## Updates for `console` early Dec22 releases
- Updated the instructions for registering for SUBNET from an airgapped
Console environment
- Minor typo in IAM doc.
Closes#664
Two of the items in that issue did not actually impact the docs. One
item is just a screenshot update that will be addressed later.
## Updates for `minio` early Dec22 releases
- Adds info about `mc` installed with container images
- Adds new envvar for KES enclaves
Closes#665
- Updates `mc support inspect` to correct alias to target in command
syntax
Updates mc docs for
[RELEASE.2022-12-02T23-48-47Z](623de88abd)
and closes several issues:
- Adds `mc support callhome`
- Simplifies and moves `mc support logs` to `mc admin logs`
- Adds `mc support proxy` command
- Adds `mc admin replicate resync` command
Closes#655Closes#663Closes#644
Updates docs for various releases through November 2022.
## Updates for mc RELEASE.2022-11-17T21-20-39Z
- Creates `mc admin idp ldap policy entities` section
- Corrects incorrect `--tier` flag in `mc ilm add`
- Adds info to `mc ilm ls` about new tabular format of output
Closes#645
- Adds info about modifying endpoints for distributed endpoits.
Partially addresses #644
## Updates for Bugfix [minio
RELEASE.2022-11-29T23-40-49Z](https://github.com/minio/minio/releases/tag/RELEASE.2022-11-29T23-40-49Z)
- Adds information about the --remove flag dropping data directories as
well and running on a per-drive basis [PR
16122](https://github.com/minio/minio/pull/16122)
- Adds note that MinIO only supports one JWT based OpenID provider [PR
#16145](https://github.com/minio/minio/pull/16145)
Note: There was no Docs issue to track this release.
## Other fix:
- Minor correction to Admin Trace
- Clarifies that mc admin idp ldap policy entities command is
cumulative, not exclusive when using multiple flags
## Add additional `mc admin config` commands
- Adds three additional commands.
- Notes under several commands that environment variables override
config keys.
Closes#653
- Adds info on multiple IDPs and logging in to the MinIO Console
- Updates Configuration section of MinIO Console to Settings
- Adds info about validation check when creating a bucket
- Adds info about adding certificates when creating a tenant in the
operator
Closes#545
# Updates for Operator 4.5.0
- Add --interactive flag info to kubectl create tenant docs
- Adds flag to kubectl minio tenant create doc
- Softens wording on bucket limit to be recommended in the MinIO console
doc for PR#649
# Updates for Console v0.20.5
- Adds environment variable option to create tenant
- Creates Audit Log section to create tenant page and moves some options
there
# Updates for console v0.21.0
- Adding info about the tiers status column when in the console
- Reworking site replication section for new changes to the layout in
Console
- Skips documenting support for editing raw YAML for encryption page
when creating a tenant, as that seems to not be supported any longer
# Updates for operator 4.5.4
- Adds --pool flag to kubectl minio tenant create
- Adds --pool flag to kubectl minio tenant expand
Closes#634Closes#615Closes#590Closes#569
Applies changes in Operator 4.5.0 release.
- Adds flag to `kubectl minio tenant create` doc
- Softens wording on bucket limit to be recommended in the MinIO console
doc for PR#649
Closes#569
Doc updates related to for minio RELEASE.2022-08-22T23-53-06Z
- Adds note about idempotent delete markers, which diverges from
standard S3
- Adds info about queueing and re-attempting failed bucket replication
tasks
- Cleans up `mc ilm add` examples throughout the docs that did not
reflect recent flag name changes
- Adds a missing metric to Metrics and Alerts
Closes#537
Updates `mc` reference docs for several releases of the MinIO Client.
- Adds missing flags to `mc admin trace`
- Updates `disk` -> `drive` throughout the docs, but not in all cases.
- Adds `--airgap flag` to `mc support profile` and `mc support perf`
commands.
- Updates the flags for `mc ilm add` command
- Adds `mc license unregister` command.
Closes#571Closes#614Closes#627Closes#633
Changes to the docs related to mc
[RELEASE.2022-11-07T23-47-39Z](https://github.com/minio/mc/releases/tag/RELEASE.2022-11-07T23-47-39Z)
- Replaces `mc replicate edit` with `mc replicate update`
- Adds `mc admin idp oidc | ldap` commands
- Update to `mc support inspect` format
- Adds `mc admin rebalance` command
- Updates mc replicate edit references throughout docs to point to mc
replicate update.
- Adds a rebalance pools section to the expand deployment doc.
- Clarifies precedence for environment variables vs config settings.
Closes#636Closes#632
- Utilizes mc admin cluster commands to export/import bucket and IAM
settings.
- Adds export and import to the mc admin config command reference doc.
- Applies additional feedback from #628 that was added after that PR was
merged.
Updates for mc release 2022-08-23
Closes#536
- Thoroughly updated the `mc ilm add` reference page and added --prefix and --newer** flags.
- Updates the `mc ilm edit` reference page to add the --prefix, --disable, and --enable flags.
- Adds `mc od` command
- Adds `--with-versioning` flag to `mc mb`
- Adds `--api-key` to `mc support diag`
- Adds clarification to --airgap flag on `mc license` and `mc support` topics that flag is not required if the local device has network access, even if the deployment is airgapped.
Closes#529
Release RELEASE.2022-08-11T04-37-28Z optimized when site healing
requeues.
Updated bucket replication and site replication docs to reflect this
change.
Addresses five outstanding Issues in the `mc` reference docs.
- Adds `--disable-multipart` flag for `mc mv` (Closes#516 )
- Adds `mc pipe` to reference docs (Closes#517 )
- Adds `mc undo` to reference docs (Closes#520 )
- Adds `mc support top` commands to replace `mc admin top` (Closes#526)
- Updates `mc cp`, `mc mirror`, `mc replicate`, and `mc admin replicate`
to clarify the differences in what copies (Closes#532)
Adds four reference docs for the subcommands of `mc support logs`.
Adds a section to the troubleshooting doc for using `mc support logs` to
send error logs to SUBNET.
Closes#511 .
Closes#523
This PR
- adds the three commands for `mc license` to the reference docs for
`mc`.
- Replaces `mc support register` with `mc license register`.
- Updates references to `mc support register` to point to `mc license
register` instead.
This adds content to the three stub files.
Corrects the Makefile for incorrect importing of Javascript docs into the Haskell folder.
Corrects community Slack URLs to point to slack.min.io.
This commit also generally cleans up the Installation docs and uses /includes/<platform>/steps-*.rst as a pattern for storing platform-specific tutorials within a single root URL.
Finally, due to API rate limits, this commit adds some Makefile magic to allow skipping of sync'ing dependencies. Pass `make BUILD_DEPENDENCIES=FALSE <platform>` to skip building any deps and use what is already in the branch.
