minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-08-06 14:42:56 +03:00
Code Activity

Fix syntax in mc version reference page (#917)

Browse Source 
Fix incorrect commands syntax detail.

Includes a general reformat. For just the items noted in the issue, see
the first commit.

Staged:

http://192.241.195.202:9000/staging/DOCS-916/linux/html/reference/minio-mc/mc-version.html
Fixes  https://github.com/minio/docs/issues/916
This commit is contained in:
Andrea Longo
2023-07-14 16:20:45 -06:00
committed by GitHub
parent e90d64bb32
commit 6227f8b736
1 changed files with 27 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
source/reference/minio-mc/mc-version.rst
View File

@@ -15,8 +15,7 @@ Description
.. start-mc-version-desc .. start-mc-version-desc
The :mc:`mc version` command enables, suspends, and retrieves the The :mc:`mc version` command enables, suspends, and retrieves the :ref:`versioning <minio-bucket-versioning>` status for a MinIO bucket.
:ref:`versioning <minio-bucket-versioning>` configuration for a MinIO bucket.
.. end-mc-version-desc .. end-mc-version-desc
@@ -24,15 +23,14 @@ The :mc:`mc version` command enables, suspends, and retrieves the
.. tab-item:: EXAMPLE .. tab-item:: EXAMPLE
The following command enables, suspends, and retrieves versioning The following command enables, suspends, and retrieves versioning status for the ``mydata`` bucket on the ``myminio`` MinIO deployment:
for the ``mydata`` bucket on the ``myminio`` MinIO deployment:
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc version enable myminio/mydata mc version enable myminio/mydata
mc version info myminio/mydata
mc version suspend myminio/mydata mc version suspend myminio/mydata
mc version info myminio/mydata
.. tab-item:: SYNTAX .. tab-item:: SYNTAX
@@ -55,8 +53,7 @@ Parameters
.. mc-cmd:: ALIAS .. mc-cmd:: ALIAS
:required: :required:
The :ref:`alias <alias>` of a MinIO deployment and the full path The :ref:`alias <alias>` of a MinIO deployment and the full path to the bucket for which to set the versioning configuration. For example:
to the bucket for which to set the versioning configuration. For example:
.. code-block:: shell .. code-block:: shell
@@ -65,11 +62,9 @@ Parameters
.. mc-cmd:: enable .. mc-cmd:: enable
:optional: :optional:
Enables versioning on the MinIO bucket specified to Enables versioning on the MinIO bucket specified to :mc-cmd:`ALIAS <mc version ALIAS>`.
:mc-cmd:`ALIAS <mc version ALIAS>`.
Mutually exclusive with :mc-cmd:`~mc version suspend` and Mutually exclusive with :mc-cmd:`~mc version suspend` and :mc-cmd:`~mc version info`
:mc-cmd:`~mc version info`
.. mc-cmd:: --exclude-folders .. mc-cmd:: --exclude-folders
:optional: :optional:
@@ -93,20 +88,16 @@ Parameters
.. mc-cmd:: info .. mc-cmd:: info
:optional: :optional:
Returns the versioning configuration for the MinIO bucket specified to Returns the versioning status for the MinIO bucket specified to :mc-cmd:`ALIAS <mc version ALIAS>`.
:mc-cmd:`ALIAS <mc version ALIAS>`.
Mutually exclusive with :mc-cmd:`~mc version suspend` and Mutually exclusive with :mc-cmd:`~mc version suspend` and :mc-cmd:`~mc version enable`
:mc-cmd:`~mc version info`
.. mc-cmd:: suspend .. mc-cmd:: suspend
:optional: :optional:
Disables versioning on the MinIO bucket specified to Disables versioning on the MinIO bucket specified to :mc-cmd:`ALIAS <mc version ALIAS>`.
:mc-cmd:`ALIAS <mc version ALIAS>`.
Mutually exclusive with :mc-cmd:`~mc version suspend` and Mutually exclusive with :mc-cmd:`~mc version enable` and :mc-cmd:`~mc version info`
:mc-cmd:`~mc version info`
Global Flags Global Flags
~~~~~~~~~~~~ ~~~~~~~~~~~~
@@ -121,18 +112,16 @@ Examples
Enable Bucket Versioning Enable Bucket Versioning
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc version suspend` to enable versioning on a bucket: Use :mc:`mc version enable` to enable versioning on a bucket:
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc version ALIAS/PATH mc version enable ALIAS/PATH
- Replace :mc-cmd:`ALIAS <mc version ALIAS>` with the - Replace :mc-cmd:`ALIAS <mc version ALIAS>` with the :mc:`alias <mc alias>` of a configured MinIO deployment.
:mc:`alias <mc alias>` of a configured MinIO deployment.
- Replace :mc-cmd:`PATH <mc version ALIAS>` with the bucket on which - Replace :mc-cmd:`PATH <mc version ALIAS>` with the bucket on which to enable versioning.
to enable versioning.
Disable Bucket Versioning Disable Bucket Versioning
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -142,29 +131,25 @@ Use :mc:`mc version suspend` to suspend versioning on a bucket:
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc version ALIAS/PATH mc version suspend ALIAS/PATH
- Replace :mc-cmd:`ALIAS <mc version ALIAS>` with the - Replace :mc-cmd:`ALIAS <mc version ALIAS>` with the :mc:`alias <mc alias>` of a configured MinIO deployment.
:mc:`alias <mc alias>` of a configured MinIO deployment.
- Replace :mc-cmd:`PATH <mc version ALIAS>` with the bucket on which - Replace :mc-cmd:`PATH <mc version ALIAS>` with the bucket on which to suspend versioning.
to suspend versioning.
Get Bucket Versioning Status Get Bucket Versioning Status
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc version info` to enable versioning on a bucket: Use :mc:`mc version info` to retrieve the versioning status for a bucket:
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc version ALIAS/PATH mc version info ALIAS/PATH
- Replace :mc-cmd:`ALIAS <mc version ALIAS>` with the - Replace :mc-cmd:`ALIAS <mc version ALIAS>` with the :mc:`alias <mc alias>` of a configured MinIO deployment.
:mc:`alias <mc alias>` of a configured MinIO deployment.
- Replace :mc-cmd:`PATH <mc version ALIAS>` with the bucket on which - Replace :mc-cmd:`PATH <mc version ALIAS>` with the bucket on which to retrieve the versioning status.
to retrieve the versioning status.
Behavior Behavior
-------- --------
@@ -172,22 +157,17 @@ Behavior
Object Locking Enables Bucket Versioning Object Locking Enables Bucket Versioning
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
While bucket versioning is disabled by default, configuring While bucket versioning is disabled by default, configuring object locking on a bucket or an object in that bucket automatically enables versioning for the bucket.
object locking on a bucket or an object in that bucket automatically See :mc:`mc retention` for more information on configuring object locking.
enables versioning for the bucket. See
:mc:`mc retention` for more information on configuring object locking.
Bucket Versioning with Existing Data Bucket Versioning with Existing Data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Enabling bucket versioning on a bucket with existing data immediately applies Enabling bucket versioning on a bucket with existing data immediately applies a versioning ID to any unversioned object.
a versioning ID to any unversioned object.
Disabling bucket versioning on a bucket with existing versioned data does Disabling bucket versioning on a bucket with existing versioned data does *not* remove any versioned objects.
*not* remove any versioned objects. Applications can continue to access Applications can continue to access versioned data after disabling bucket versioning.
versioned data after disabling bucket versioning. Use Use :mc-cmd:`mc rm --versions ALIAS/BUCKET/OBJECT <mc rm --versions>` to delete an object *and* all its versions.
:mc-cmd:`mc rm --versions ALIAS/BUCKET/OBJECT <mc rm --versions>` to delete an
object *and* all its versions.
S3 Compatibility S3 Compatibility
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~