minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Code Activity

Doc updates for mc RELEASE.2024-01-11T05-49-32Z (#1110)

Browse Source 
Doc updates for the following:

- Document alias naming requirements, including new minimum length rules
- `mc tag set --exclude-folders` modifies the behavior of `--recursive`

Staged:

http://192.241.195.202:9000/staging/DOCS-1106/linux/reference/minio-mc/mc-alias-set.html#mc.alias.set.ALIAS

http://192.241.195.202:9000/staging/DOCS-1106/linux/reference/minio-mc/mc-tag-set.html#mc.tag.set.-exclude-folders

Fixes https://github.com/minio/docs/issues/1106

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
This commit is contained in:
Andrea Longo
2024-01-18 16:14:24 -07:00
committed by GitHub
parent 6367e30fb4
commit 1e1c4c73f8
2 changed files with 34 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
source/reference/minio-mc/mc-alias-set.rst
View File

@ -68,6 +68,22 @@ Parameters
.. mc-cmd:: ALIAS
*Required* The name to associate to the S3-compatible service.
Aliases are case-sensitive and must meet the following requirements:
- Contain only `ASCII <https://en.wikipedia.org/wiki/ASCII>`__ lower case letters (``a-z``), upper case letters (``A-Z``), numbers (``[0-9]``), hyphen (``-``), or underscore (``_``).
- 2 or more characters in length.
- The first character must be a letter.
.. versionchanged:: RELEASE.2024-01-11T05-49-32Z
An alias may also be a single letter (``a-z`` or ``A-Z``).
Examples of some valid alias values include:
- ``myminio``
- ``Test-1``
- ``A``
- ``a``
.. mc-cmd:: URL

17
source/reference/minio-mc/mc-tag-set.rst
View File

@ -86,6 +86,23 @@ Parameters
mc tag set myminio/mybucket/object.txt "key1=value1&key2=value2"
.. mc-cmd:: --exclude-folders
:optional:
.. versionadded:: RELEASE.2024-01-11T05-49-32Z
When used with :mc-cmd:`~mc tag set --recursive`, causes :mc:`mc tag set` to **not** traverse child prefixes.
Tags are only applied to objects at the specified path.
Requires :mc-cmd:`~mc tag set --recursive`.
The following example applies the tag ``destination=international`` to objects at ``vacation-photos/cancun/`` but not ``vacation-photos/cancun/ocean/`` or other prefixes.
For example, the above would add the tags to the object at``vacation-photos/cancun/pretty-beach.jpg`` but not to the object at``vacation-photos/cancun/ocean/tropical-fish.jpg``.
.. code-block:: shell
mc tag set myminio/vacation-photos/cancun "destination=international" --exclude-folders --recursive
.. mc-cmd:: --recursive, r
:optional: