Disk doc updates

This commit is contained in:
Brian Cain 2020-01-30 15:31:49 -08:00
parent b2a89f8711
commit 567351a2af
No known key found for this signature in database
GPG Key ID: 9FC4639B2E4510A0
2 changed files with 6 additions and 4 deletions

View File

@ -18,7 +18,7 @@ supported disk extensions, please check the specific provider being used.
* `file` (string) - Optional argument that defines a path on disk pointing to
the location of a disk file that already exists.
* `name` (string) - Required option to give the disk a name. This name will be
used as a filename when creating the disk.
used as the filename when creating the disk.
* `primary` (boolean) - Optional argument that configures a given disk to be the
"primary" disk to manage on the guest. There can only be one `primary` disk per guest.
Defaults to `false` if not specified.

View File

@ -11,12 +11,14 @@ description: |-
<div class="alert alert-warning">
<strong>Warning!</strong> This feature is experimental and may break or
change in between releases. Use at your own risk. It currently is not officially
supported or functional.
supported or functional. Please refer to the providier specific disk documentation
for more information on how to use and enable this feature.
</div>
Vagrant Disks is a feature that allows users to define what mediums should be attached
to their guests, as well as allowing users to resize their primary disk. For examples
on how to achieve this, among other use cases, please refer to the [usage](/docs/disks/usage.html)
to their guests, as well as allowing users to resize their primary disk.
For examples on how to achieve this, among other use cases, please refer to the [usage](/docs/disks/usage.html)
guide for more information!
For more information about what options are available for configuring disks, see the