From 89678950ae890499af50d02455472ce1db07a70f Mon Sep 17 00:00:00 2001 From: Brian Cain Date: Thu, 4 Jun 2020 13:20:00 -0700 Subject: [PATCH] Update hyper-v website docs for new website format --- website/data/docs-navigation.js | 1 + .../docs/disks/hyperv/common-issues.mdx} | 6 ++-- website/pages/docs/disks/hyperv/index.mdx | 33 +++++++++++++++++ .../docs/disks/hyperv/usage.mdx} | 32 ++++++++--------- .../source/docs/disks/hyperv/index.html.md | 35 ------------------- 5 files changed, 52 insertions(+), 55 deletions(-) rename website/{source/docs/disks/hyperv/common-issues.html.md => pages/docs/disks/hyperv/common-issues.mdx} (88%) create mode 100644 website/pages/docs/disks/hyperv/index.mdx rename website/{source/docs/disks/hyperv/usage.html.md => pages/docs/disks/hyperv/usage.mdx} (75%) delete mode 100644 website/source/docs/disks/hyperv/index.html.md diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index 5a8ff9137..3c6e9e72e 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -119,6 +119,7 @@ export default [ 'configuration', 'usage', { category: 'virtualbox', content: ['usage', 'common-issues'] }, + { category: 'hyperv', content: ['usage', 'common-issues'] }, ], }, 'multi-machine', diff --git a/website/source/docs/disks/hyperv/common-issues.html.md b/website/pages/docs/disks/hyperv/common-issues.mdx similarity index 88% rename from website/source/docs/disks/hyperv/common-issues.html.md rename to website/pages/docs/disks/hyperv/common-issues.mdx index 9028985dd..467a276cc 100644 --- a/website/source/docs/disks/hyperv/common-issues.html.md +++ b/website/pages/docs/disks/hyperv/common-issues.mdx @@ -1,7 +1,7 @@ --- -layout: "docs" -page_title: "Common Issues - Disks Hyper-V Provider" -sidebar_current: "disks-providers-hyperv-issues" +layout: docs +page_title: Common Issues - Disks Hyper-V Provider +sidebar_title: Common Issues description: |- This page lists some common issues people run into with Vagrant and Hyper-V as well as solutions for those issues. diff --git a/website/pages/docs/disks/hyperv/index.mdx b/website/pages/docs/disks/hyperv/index.mdx new file mode 100644 index 000000000..c64998b21 --- /dev/null +++ b/website/pages/docs/disks/hyperv/index.mdx @@ -0,0 +1,33 @@ +--- +layout: docs +page_title: Disks for Hyper-V Provider +sidebar_title: Hyper-V +description: |- + Vagrant comes with support out of the box for Hyper-V, a free, + cross-platform consumer virtualization product. +--- + +# Hyper-V + +~> **Warning!** 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. + +This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to: + +``` +VAGRANT_EXPERIMENTAL="disks" +``` + +Please note that `VAGRANT_EXPERIMENTAL` is an environment variable. For more +information about this flag visit the [Experimental docs page](/docs/experimental/) +for more info. Without this flag enabled, any disks defined will not be configured. + +Because of how Hyper-V handles disk management, a Vagrant guest _must_ be powered +off for any changes to be applied to a guest. If you make a configuration change +with a guests disk, you will need to `vagrant reload` the guest for any changes +to be applied. + +For more information on how to use VirtualBox to configure disks for a guest, refer +to the [general usage](/docs/disks/usage) and [configuration](/docs/disks/configuration) +guide for more information. diff --git a/website/source/docs/disks/hyperv/usage.html.md b/website/pages/docs/disks/hyperv/usage.mdx similarity index 75% rename from website/source/docs/disks/hyperv/usage.html.md rename to website/pages/docs/disks/hyperv/usage.mdx index 94046a50e..0aaf51d1a 100644 --- a/website/source/docs/disks/hyperv/usage.html.md +++ b/website/pages/docs/disks/hyperv/usage.mdx @@ -1,7 +1,7 @@ --- -layout: "docs" -page_title: "Usage - Disks Hyper-V Provider" -sidebar_current: "disks-providers-hyperv-usage" +layout: docs +page_title: Usage - Disks Hyper-V Provider +sidebar_title: Usage description: |- The Vagrant Hyper-V provider is used just like any other provider. Please read the general basic usage page for providers. @@ -9,24 +9,22 @@ description: |- # Usage -
- Warning! 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. +~> **Warning!** 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. - This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to: +This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to: - ``` - VAGRANT_EXPERIMENTAL="disks" - ``` +``` +VAGRANT_EXPERIMENTAL="disks" +``` - Please note that `VAGRANT_EXPERIMENTAL` is an environment variable. For more - information about this flag visit the [Experimental docs page](/docs/experimental/) - for more info. Without this flag enabled, any disks defined will not be configured. -
+Please note that `VAGRANT_EXPERIMENTAL` is an environment variable. For more +information about this flag visit the [Experimental docs page](/docs/experimental/) +for more info. Without this flag enabled, any disks defined will not be configured. For examples of how to use the disk feature with Hyper-V, please refer to the -[general disk usage guide](/docs/disks/usage.html) for more examples. +[general disk usage guide](/docs/disks/usage) for more examples. ## provider_config options @@ -35,7 +33,7 @@ Vagrant supports most options for these operations. You should be able to define the powershell specific argument to a given Hyper-V command in the provider_config hash, and Vagrant should properly pass it along to the command. -To define a provider specific option, please refer to the [Disk Options documentation page](/docs/disks/configuration.html) for more info. +To define a provider specific option, please refer to the [Disk Options documentation page](/docs/disks/configuration) for more info. ### Note about options defined below diff --git a/website/source/docs/disks/hyperv/index.html.md b/website/source/docs/disks/hyperv/index.html.md deleted file mode 100644 index b83640319..000000000 --- a/website/source/docs/disks/hyperv/index.html.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: "docs" -page_title: "Disks for Hyper-V Provider" -sidebar_current: "disks-providers-hyperv" -description: |- - Vagrant comes with support out of the box for Hyper-V, a free, - cross-platform consumer virtualization product. ---- - -# Hyper-V - -
- Warning! 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. - - This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to: - - ``` - VAGRANT_EXPERIMENTAL="disks" - ``` - - Please note that `VAGRANT_EXPERIMENTAL` is an environment variable. For more - information about this flag visit the [Experimental docs page](/docs/experimental/) - for more info. Without this flag enabled, any disks defined will not be configured. -
- -Because of how Hyper-V handles disk management, a Vagrant guest _must_ be powered -off for any changes to be applied to a guest. If you make a configuration change -with a guests disk, you will need to `vagrant reload` the guest for any changes -to be applied. - -For more information on how to use VirtualBox to configure disks for a guest, refer -to the [general usage](/docs/disks/usage.html) and [configuration](/docs/disks/configuration.html) -guide for more information.