1
0
mirror of https://github.com/minio/docs.git synced 2025-05-30 23:05:04 +03:00
docs/source/reference/minio-mc/mc-batch.rst
Daryl White 6482571bf2
Update mc reference docs for improved nav structure (#717)
- 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
2023-02-02 16:52:36 -06:00

70 lines
1.6 KiB
ReStructuredText

============
``mc batch``
============
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc batch
Description
-----------
.. start-mc-batch-desc
The :mc:`mc batch` commands allow you to run one or more job tasks on a MinIO deployment.
.. end-mc-batch-desc
Subcommands
-----------
:mc-cmd:`mc batch` includes the following subcommands:
.. list-table::
:header-rows: 1
:widths: 30 70
:width: 100%
* - Subcommand
- Description
* - :mc:`~mc batch describe`
- .. include:: /reference/minio-mc/mc-batch-describe.rst
:start-after: start-mc-batch-describe-desc
:end-before: end-mc-batch-describe-desc
* - :mc:`~mc batch generate`
- .. include:: /reference/minio-mc/mc-batch-generate.rst
:start-after: start-mc-batch-generate-desc
:end-before: end-mc-batch-generate-desc
* - :mc:`~mc batch list`
- .. include:: /reference/minio-mc/mc-batch-list.rst
:start-after: start-mc-batch-list-desc
:end-before: end-mc-batch-list-desc
* - :mc:`~mc batch start`
- .. include:: /reference/minio-mc/mc-batch-start.rst
:start-after: start-mc-batch-start-desc
:end-before: end-mc-batch-start-desc
* - :mc:`~mc batch status`
- .. include:: /reference/minio-mc/mc-batch-status.rst
:start-after: start-mc-batch-status-desc
:end-before: end-mc-batch-status-desc
.. toctree::
:titlesonly:
:hidden:
/reference/minio-mc/mc-batch-describe
/reference/minio-mc/mc-batch-generate
/reference/minio-mc/mc-batch-list
/reference/minio-mc/mc-batch-start
/reference/minio-mc/mc-batch-status