docs icon indicating copy to clipboard operation
docs copied to clipboard

List global flags under separate page.

Open bh4t opened this issue 3 years ago • 2 comments

While reviewing the mc command documentation, @abperiasamy suggested we should list the global flags(listed below) for each mc command under a separate page and add a reference to this page under the per mc command to avoid redundancy.

_Global Flags --debug Optional Enables verbose output to the console.

For example:

mc --debug COMMAND --config-dir Optional The path to a JSON formatted configuration file that mc uses for storing data. See Configuration File for more information on how mc uses the configuration file.

--JSON Optional Enables JSON lines formatted output to the console.

For example:

mc --JSON COMMAND --no-color Optional Disables the built-in color theme for console output. Useful for dumb terminals.

--quiet Optional Suppresses console output.

--insecure Optional Disables TLS/SSL certificate verification. Allows TLS connectivity to servers with invalid certificates. Exercise caution when using this option against untrusted S3 hosts.

--version Optional Displays the current version of mc.

--help Optional Displays a summary of command usage on the terminal._

bh4t avatar Jul 25 '22 20:07 bh4t

This shouldn't be too difficult ... we already have https://docs.min.io/minio/baremetal/reference/minio-mc.html#global-options , so it would be a question of removing the lists on each individual reference page and just linking up to the global options instead.

ravindk89 avatar Jul 25 '22 21:07 ravindk89

The scale here is pretty big, but its mostly removing and re-linking - I think this is still "tiny" from that perspective.

Once completed we should be able to cherry-pick this into docs-ia as well.

ravindk89 avatar Jul 25 '22 21:07 ravindk89

Closed by PR #541 .

djwfyi avatar Sep 19 '22 21:09 djwfyi