From 1a02c52852f3d4a2d5354e6c25ed6596bfadd02e Mon Sep 17 00:00:00 2001 From: Brian Cain Date: Wed, 13 Nov 2019 13:58:02 -0800 Subject: [PATCH] Add beginning of disk management docs for vagrant website --- .../source/docs/disks/configuration.html.md | 24 +++++++++++++++++++ website/source/docs/disks/index.html.md | 14 +++++++++++ website/source/docs/disks/usage.html.md | 13 ++++++++++ website/source/layouts/docs.erb | 8 +++++++ 4 files changed, 59 insertions(+) create mode 100644 website/source/docs/disks/configuration.html.md create mode 100644 website/source/docs/disks/index.html.md create mode 100644 website/source/docs/disks/usage.html.md diff --git a/website/source/docs/disks/configuration.html.md b/website/source/docs/disks/configuration.html.md new file mode 100644 index 000000000..33b9c8d69 --- /dev/null +++ b/website/source/docs/disks/configuration.html.md @@ -0,0 +1,24 @@ +--- +layout: "docs" +page_title: "Vagrant Disks Configuration" +sidebar_current: "disks-configuration" +description: |- + Documentation of various configuration options for Vagrant Disks +--- + +# Configuration + +Vagrant Disks has several options that allow users to define and attach disks to guests. + +## Disk Options + +* `name` (string) - Optional argument to give the disk a name +* `type` (symbol) - The type of disk to manage. This option defaults to `:disk`. Please read the provider specific documentation for supported types. +* `file` (string) - Optional argument that defines a path on disk pointing to the location of a disk file. +* `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. +* `provider_config` (hash) - Additional provider specific options for managing a given disk. + + **Note:** The `provider_config` option will depend on the provider you are using. Please read the provider specific documentation for disk management to learn about what options are available to use. + +## Disk Types + diff --git a/website/source/docs/disks/index.html.md b/website/source/docs/disks/index.html.md new file mode 100644 index 000000000..a3ffe1ccb --- /dev/null +++ b/website/source/docs/disks/index.html.md @@ -0,0 +1,14 @@ +--- +layout: "docs" +page_title: "Vagrant Disks" +sidebar_current: "disks" +description: |- + Introduction to Vagrant Disks +--- + +# Vagrant Disks + +As of version 2.3.0, Vagrant is capable managing what disks are available for a given guest. + +For more information about what options are available for configuring disks, see the +[configuration section](/docs/disks/configuration.html). diff --git a/website/source/docs/disks/usage.html.md b/website/source/docs/disks/usage.html.md new file mode 100644 index 000000000..09175f80c --- /dev/null +++ b/website/source/docs/disks/usage.html.md @@ -0,0 +1,13 @@ +--- +layout: "docs" +page_title: "Vagrant Disk Usage" +sidebar_current: "disk-usage" +description: |- + Various Vagrant Disk examples +--- + +# Basic Usage + +Below are some very simple examples of how to use Vagrant Disks. + +## Examples diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index d95ba8666..ff84ad238 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -128,6 +128,14 @@ + > + Disks + + + > Multi-Machine