From ab9d2ecd334fdc96fadcf850015f3c016137579f Mon Sep 17 00:00:00 2001 From: kaitlincart Date: Wed, 5 Oct 2022 09:42:00 -0700 Subject: [PATCH 1/9] copy edits --- website/content/docs/installation/source.mdx | 57 ++++++++++---------- 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/website/content/docs/installation/source.mdx b/website/content/docs/installation/source.mdx index 0cc7cb612..185336006 100644 --- a/website/content/docs/installation/source.mdx +++ b/website/content/docs/installation/source.mdx @@ -2,78 +2,81 @@ layout: docs page_title: Installing Vagrant from Source description: |- - Installing Vagrant from source is an advanced topic and is only recommended - when using the official installer is not an option. This page details the - steps and prerequisites for installing Vagrant from source. + Vagrant installations from source is an advanced operation. It is only recommended + if you cannot use the official installer. --- -# Installing Vagrant from Source +# Install Vagrant from source -Installing Vagrant from source is an advanced topic and is only recommended -when using the official installer is not an option. This page details the -steps and prerequisites for installing Vagrant from source. +Vagrant installations from source is an advanced operation. It is only recommended +if you cannot use the official installer. This page details the prerequisites and three +steps to install Vagrant from source. + +1. Install Ruby +1. Clone Vagrant +1. Configure locally ## Install Ruby -You must have a modern Ruby (>= 2.2) in order to develop and build Vagrant. The -specific Ruby version is documented in the Vagrant's `gemspec`. Please refer to -the `vagrant.gemspec` in the repository on GitHub, as it will contain the most -up-to-date requirement. This guide will not discuss how to install and manage Ruby. -However, beware of the following pitfalls: +You must install Ruby 2.2 or newer to develop and build Vagrant. The +specific Ruby version that you will need is documented in `vagrant.gemspec`, located in the repository on GitHub. It contains the most +up-to-date requirements. -- Do **NOT** use the system Ruby - use a Ruby version manager like rvm or chruby -- Vagrant plugins are configured based on current environment. If plugins are installed - using Vagrant from source, they will not work from the package based Vagrant installation. +~> Note that it is not recommended that you use the system Ruby. You need a Ruby version manager like RVM or chruby. + +You will also need to be aware of plugin compatibility between Vagrant source installations and package based installations. Since Vagrant plugins are configured based on the current environment, plugins installed with Vagrant from source will not work with the package based Vagrant installation. ## Clone Vagrant -Clone Vagrant's repository from GitHub into the directory where you keep code on your machine: +Clone Vagrant's repository from GitHub into the directory where you keep code on your machine. ```shell-session $ git clone https://github.com/hashicorp/vagrant.git ``` -Next, `cd` into that path. All commands will be run from this path: +Next, `cd` into that path. All commands need to be initiated from this directory. ```shell-session $ cd /path/to/your/vagrant/clone ``` -Run the `bundle` command with a required version\* to install the requirements: +Use the `bundle` command with a required version\* to install the requirements. ```shell-session $ bundle install ``` -You can now run Vagrant by running `bundle exec vagrant` from inside that -directory. +You can now start Vagrant with the `bundle` command. -## Use Locally +```shell-session +$ bundle exec vagrant +``` + +## Configure locally In order to use your locally-installed version of Vagrant in other projects, you will need to create a binstub and add it to your path. -First, run the following command from the Vagrant repo: +First, use the `bundle` command from your Vagrant directory. ```shell-session $ bundle --binstubs exec ``` This will generate files in `exec/`, including `vagrant`. You can now specify -the full path to the `exec/vagrant` anywhere on your operating system: +the full path to the `exec/vagrant` anywhere on your operating system. ```shell-session $ /path/to/vagrant/exec/vagrant init -m hashicorp/bionic64 ``` -Note that you _will_ receive warnings that running Vagrant like this is not -supported. It's true. It's not. You should listen to those warnings. +~> Warning messages are expected when you use a local Vagrant from source installation, since it is not supported or recommend. If you do not want to specify the full path to Vagrant (i.e. you just want to -run `vagrant`), you can create a symbolic link to your exec: +run `vagrant`), you can create a symbolic link to your exec. ```shell-session $ ln -sf /path/to/vagrant/exec/vagrant /usr/local/bin/vagrant ``` -When you want to switch back to the official Vagrant version, simply +When you want to switch back to the official Vagrant version, remove the symlink. From 709897f8c30c3319ca487e5ad62fc7c48adbcb47 Mon Sep 17 00:00:00 2001 From: kaitlincart Date: Wed, 5 Oct 2022 16:41:52 -0700 Subject: [PATCH 2/9] copy edits to uninstall --- .../docs/installation/uninstallation.mdx | 56 ++++++++++--------- 1 file changed, 30 insertions(+), 26 deletions(-) diff --git a/website/content/docs/installation/uninstallation.mdx b/website/content/docs/installation/uninstallation.mdx index d3dcf900f..6862f26d3 100644 --- a/website/content/docs/installation/uninstallation.mdx +++ b/website/content/docs/installation/uninstallation.mdx @@ -7,53 +7,57 @@ description: |- do this on every platform. --- -# Uninstalling Vagrant +# Uninstall Vagrant -Uninstalling Vagrant is easy and straightforward. You can either uninstall -the Vagrant binary, the user data, or both. The sections below cover how to -do this on every platform. +To uninstall Vagrant, you can either uninstall +the Vagrant binary, the user data, or both. The two sections below detail how to +uninstall Vagrant on any platform. -## Removing the Vagrant Program +## Remove the Vagrant program -Removing the Vagrant program will remove the `vagrant` binary and all -dependencies from your machine. After uninstalling the program, you can -always [reinstall](/docs/installation/) again using standard -methods. Uninstalling Vagrant will _not_ remove user data. The section below this -one gives more detailed instructions on how to remove that directory from your -system. +When you remove the Vagrant program, it will remove the `vagrant` binary and all +dependencies from your machine. It will _not_ remove user data. The next section provides more details on how to remove that directory from your system. -On **Windows** +### Windows machines -> Uninstall using the add/remove programs section of the control panel +Uninstall using the "add/remove programs" section of the control panel. -On **Mac OS X**: +### Mac OS X machines -```sh +As a super user, force remove the directory and remove it from your path with `pkgutil`.\ + +```shell-session sudo rm -rf /opt/vagrant /usr/local/bin/vagrant sudo pkgutil --forget com.vagrant.vagrant ``` -On **Linux**: +### Linux machines -```sh +As a super user, force remove the Vagrant directories. + +```shell-session rm -rf /opt/vagrant rm -f /usr/bin/vagrant ``` -## Removing User Data +## Remove user data -Removing the user data will remove all [boxes](/docs/boxes), +The removal of user data will remove all [boxes](/docs/boxes), [plugins](/docs/plugins/), license files, and any stored state that may be used by Vagrant. Removing the user data effectively makes Vagrant think it is a fresh install. -On all platforms, this directory is located in the root of your home directory, -and is named `vagrant.d`. Simply remove the `~/.vagrant.d` directory to delete the user data. If on -Windows, this directory is located at `C:\Users\YourUsername\.vagrant.d`, where +On all platforms, the user data directory location is in the root of your home directory, `vagrant.d`. Remove the `~/.vagrant.d` directory to delete all the user data. If on +Windows, this directory is, `C:\Users\YourUsername\.vagrant.d`, where `YourUsername` is the username of your local user. -When debugging, the Vagrant support team may ask you to remove this -directory. Before removing this directory, please make a backup. +If the Vagrant support team asks you to remove this +directory to debug, you should make a backup. -Running Vagrant will automatically regenerate any data necessary to run, -so it is safe to remove the user data at any time. +When you use Vagrant again, Vagrant will automatically regenerate any data necessary to operate. + +## Reinstall Vagrant + +If you decide to reinstall Vagrant, you can +follow the [installation docs](/docs/installation/) again for any standard +method. From 35bd397982140e827ea7de6f5d9857911200066b Mon Sep 17 00:00:00 2001 From: kaitlincart Date: Thu, 6 Oct 2022 09:13:26 -0700 Subject: [PATCH 3/9] copy edits to upgrade page --- .../docs/installation/upgrading-from-1-0.mdx | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/website/content/docs/installation/upgrading-from-1-0.mdx b/website/content/docs/installation/upgrading-from-1-0.mdx index 74913328b..90a94e89e 100644 --- a/website/content/docs/installation/upgrading-from-1-0.mdx +++ b/website/content/docs/installation/upgrading-from-1-0.mdx @@ -1,29 +1,29 @@ --- layout: docs -page_title: Upgrading from Vagrant 1.0 +page_title: Upgrade from Vagrant 1.0 description: |- - The upgrade process from 1.0.x to 1.x is straightforward. Vagrant is - backwards compatible with Vagrant 1.0.x, so you can simply reinstall Vagrant - over your previous installation by downloading the latest package and - installing it using standard procedures for your operating system. + The upgrade process from 1.0.x to 1.x is straightforward, Vagrant is + backwards compatible with Vagrant 1.0.x. To reinstall Vagrant + over your previous installation download the latest package and + install it with standard procedures for your operating system. --- -# Upgrading From Vagrant 1.0.x +# Upgrade from Vagrant 1.0.x -The upgrade process from 1.0.x to 1.x is straightforward. Vagrant is quite +The upgrade process from 1.0.x to 1.x is straightforward, Vagrant is [backwards compatible](/docs/installation/backwards-compatibility) -with Vagrant 1.0.x, so you can simply reinstall Vagrant -over your previous installation by downloading the latest package and -installing it using standard procedures for your operating system. +with Vagrant 1.0.x. To reinstall Vagrant +over your previous installation download the latest package and +install it with standard procedures for your operating system. As the [backwards compatibility](/docs/installation/backwards-compatibility) page says, **Vagrant 1.0.x plugins will not work with Vagrant 1.1+**. Many of these plugins have been updated to work with newer versions of Vagrant, -so you can look to see if they've been updated. If not however, you will have -to remove them before upgrading. +you will need to verify if they've been updated. If not however, you will have +to remove them before the upgrade. -It is recommended you remove _all_ plugins before upgrading, and then slowly -add back the plugins. This usually makes for a smoother upgrade process. +We recommend that you remove _all_ plugins before the upgrade and then slowly +add them back. This usually makes for a smoother upgrade process. ~> **If your version of Vagrant was installed via Rubygems**, you must uninstall the old version prior to installing the package for the From 306e0de17145589e1f9986ea8a5d0f137a346d91 Mon Sep 17 00:00:00 2001 From: kaitlincart <43049322+kaitlincart@users.noreply.github.com> Date: Wed, 12 Oct 2022 08:57:58 -0700 Subject: [PATCH 4/9] Apply suggestions from code review Co-authored-by: Anthony --- website/content/docs/installation/source.mdx | 6 +++--- website/content/docs/installation/uninstallation.mdx | 4 ++-- website/content/docs/installation/upgrading-from-1-0.mdx | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/website/content/docs/installation/source.mdx b/website/content/docs/installation/source.mdx index 185336006..b31e886e1 100644 --- a/website/content/docs/installation/source.mdx +++ b/website/content/docs/installation/source.mdx @@ -22,7 +22,7 @@ You must install Ruby 2.2 or newer to develop and build Vagrant. The specific Ruby version that you will need is documented in `vagrant.gemspec`, located in the repository on GitHub. It contains the most up-to-date requirements. -~> Note that it is not recommended that you use the system Ruby. You need a Ruby version manager like RVM or chruby. +~> **Note:** It is not recommended that you use the system Ruby. You need a Ruby version manager like RVM or chruby. You will also need to be aware of plugin compatibility between Vagrant source installations and package based installations. Since Vagrant plugins are configured based on the current environment, plugins installed with Vagrant from source will not work with the package based Vagrant installation. @@ -34,7 +34,7 @@ Clone Vagrant's repository from GitHub into the directory where you keep code on $ git clone https://github.com/hashicorp/vagrant.git ``` -Next, `cd` into that path. All commands need to be initiated from this directory. +Next, `cd` into that path. You must initiate all commands from this directory. ```shell-session $ cd /path/to/your/vagrant/clone @@ -69,7 +69,7 @@ the full path to the `exec/vagrant` anywhere on your operating system. $ /path/to/vagrant/exec/vagrant init -m hashicorp/bionic64 ``` -~> Warning messages are expected when you use a local Vagrant from source installation, since it is not supported or recommend. +-> **Tip:** Warning messages are expected when you use a local Vagrant from source installation, since it is not supported or recommend. If you do not want to specify the full path to Vagrant (i.e. you just want to run `vagrant`), you can create a symbolic link to your exec. diff --git a/website/content/docs/installation/uninstallation.mdx b/website/content/docs/installation/uninstallation.mdx index 6862f26d3..9ea839267 100644 --- a/website/content/docs/installation/uninstallation.mdx +++ b/website/content/docs/installation/uninstallation.mdx @@ -20,7 +20,7 @@ dependencies from your machine. It will _not_ remove user data. The next section ### Windows machines -Uninstall using the "add/remove programs" section of the control panel. +Uninstall using the **Add/Remove Programs** section of the control panel. ### Mac OS X machines @@ -47,7 +47,7 @@ The removal of user data will remove all [boxes](/docs/boxes), by Vagrant. Removing the user data effectively makes Vagrant think it is a fresh install. -On all platforms, the user data directory location is in the root of your home directory, `vagrant.d`. Remove the `~/.vagrant.d` directory to delete all the user data. If on +On all platforms, the user data directory location is in the root of your home directory under `vagrant.d`. Remove the `~/.vagrant.d` directory to delete all the user data. On Windows, this directory is, `C:\Users\YourUsername\.vagrant.d`, where `YourUsername` is the username of your local user. diff --git a/website/content/docs/installation/upgrading-from-1-0.mdx b/website/content/docs/installation/upgrading-from-1-0.mdx index 90a94e89e..ecc7174f2 100644 --- a/website/content/docs/installation/upgrading-from-1-0.mdx +++ b/website/content/docs/installation/upgrading-from-1-0.mdx @@ -4,7 +4,7 @@ page_title: Upgrade from Vagrant 1.0 description: |- The upgrade process from 1.0.x to 1.x is straightforward, Vagrant is backwards compatible with Vagrant 1.0.x. To reinstall Vagrant - over your previous installation download the latest package and + over your previous installation, download the latest package and install it with standard procedures for your operating system. --- @@ -13,7 +13,7 @@ description: |- The upgrade process from 1.0.x to 1.x is straightforward, Vagrant is [backwards compatible](/docs/installation/backwards-compatibility) with Vagrant 1.0.x. To reinstall Vagrant -over your previous installation download the latest package and +over your previous installation, download the latest package and install it with standard procedures for your operating system. As the [backwards compatibility](/docs/installation/backwards-compatibility) From ef0bd8b583915cca345c9840526c98282bf13686 Mon Sep 17 00:00:00 2001 From: kaitlincart Date: Mon, 17 Oct 2022 13:18:15 -0700 Subject: [PATCH 5/9] update ruby version and fix sentence wrap --- website/content/docs/installation/source.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/website/content/docs/installation/source.mdx b/website/content/docs/installation/source.mdx index b31e886e1..7ec978b43 100644 --- a/website/content/docs/installation/source.mdx +++ b/website/content/docs/installation/source.mdx @@ -18,9 +18,10 @@ steps to install Vagrant from source. ## Install Ruby -You must install Ruby 2.2 or newer to develop and build Vagrant. The -specific Ruby version that you will need is documented in `vagrant.gemspec`, located in the repository on GitHub. It contains the most -up-to-date requirements. +You must install Ruby 2.7 or newer to develop and build Vagrant. The +specific Ruby version that you will need is documented +in `vagrant.gemspec`, located in the repository on GitHub. +It contains the most up-to-date requirements. ~> **Note:** It is not recommended that you use the system Ruby. You need a Ruby version manager like RVM or chruby. From c88c142b158bf7d8bd8a6cd2e04c741aa1fbbafc Mon Sep 17 00:00:00 2001 From: kaitlincart <43049322+kaitlincart@users.noreply.github.com> Date: Wed, 16 Nov 2022 09:23:12 -0800 Subject: [PATCH 6/9] Apply suggestions from code review Co-authored-by: Anthony --- website/content/docs/installation/source.mdx | 4 ++-- website/content/docs/installation/uninstallation.mdx | 2 +- website/content/docs/installation/upgrading-from-1-0.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/website/content/docs/installation/source.mdx b/website/content/docs/installation/source.mdx index 7ec978b43..50076eac5 100644 --- a/website/content/docs/installation/source.mdx +++ b/website/content/docs/installation/source.mdx @@ -8,7 +8,7 @@ description: |- # Install Vagrant from source -Vagrant installations from source is an advanced operation. It is only recommended +Vagrant installations from source is an advanced operation. We only recommended if you cannot use the official installer. This page details the prerequisites and three steps to install Vagrant from source. @@ -70,7 +70,7 @@ the full path to the `exec/vagrant` anywhere on your operating system. $ /path/to/vagrant/exec/vagrant init -m hashicorp/bionic64 ``` --> **Tip:** Warning messages are expected when you use a local Vagrant from source installation, since it is not supported or recommend. +-> **Tip:** Warning messages are expected when you use a local Vagrant from source installation, since it is not supported or recommended. If you do not want to specify the full path to Vagrant (i.e. you just want to run `vagrant`), you can create a symbolic link to your exec. diff --git a/website/content/docs/installation/uninstallation.mdx b/website/content/docs/installation/uninstallation.mdx index 9ea839267..5ef55653d 100644 --- a/website/content/docs/installation/uninstallation.mdx +++ b/website/content/docs/installation/uninstallation.mdx @@ -47,7 +47,7 @@ The removal of user data will remove all [boxes](/docs/boxes), by Vagrant. Removing the user data effectively makes Vagrant think it is a fresh install. -On all platforms, the user data directory location is in the root of your home directory under `vagrant.d`. Remove the `~/.vagrant.d` directory to delete all the user data. On +On Linux and Mac OS platforms, the user data directory location is in the root of your home directory under `vagrant.d`. Remove the `~/.vagrant.d` directory to delete all the user data. On Windows, this directory is, `C:\Users\YourUsername\.vagrant.d`, where `YourUsername` is the username of your local user. diff --git a/website/content/docs/installation/upgrading-from-1-0.mdx b/website/content/docs/installation/upgrading-from-1-0.mdx index ecc7174f2..02578f8c4 100644 --- a/website/content/docs/installation/upgrading-from-1-0.mdx +++ b/website/content/docs/installation/upgrading-from-1-0.mdx @@ -19,7 +19,7 @@ install it with standard procedures for your operating system. As the [backwards compatibility](/docs/installation/backwards-compatibility) page says, **Vagrant 1.0.x plugins will not work with Vagrant 1.1+**. Many of these plugins have been updated to work with newer versions of Vagrant, -you will need to verify if they've been updated. If not however, you will have +so you will need to verify if they've been updated. If not however, you will have to remove them before the upgrade. We recommend that you remove _all_ plugins before the upgrade and then slowly From 0e6685adb0b798fd4130dcec31015b982c2a7765 Mon Sep 17 00:00:00 2001 From: kaitlincart <43049322+kaitlincart@users.noreply.github.com> Date: Wed, 16 Nov 2022 09:30:56 -0800 Subject: [PATCH 7/9] Apply suggestions from code review --- website/content/docs/installation/source.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/website/content/docs/installation/source.mdx b/website/content/docs/installation/source.mdx index 50076eac5..2e0172af3 100644 --- a/website/content/docs/installation/source.mdx +++ b/website/content/docs/installation/source.mdx @@ -23,7 +23,6 @@ specific Ruby version that you will need is documented in `vagrant.gemspec`, located in the repository on GitHub. It contains the most up-to-date requirements. -~> **Note:** It is not recommended that you use the system Ruby. You need a Ruby version manager like RVM or chruby. You will also need to be aware of plugin compatibility between Vagrant source installations and package based installations. Since Vagrant plugins are configured based on the current environment, plugins installed with Vagrant from source will not work with the package based Vagrant installation. From eb07f39174c0fe54641f6aa0004e2b219a7529c7 Mon Sep 17 00:00:00 2001 From: Ashlee Boyer Date: Fri, 20 Jan 2023 17:46:23 -0500 Subject: [PATCH 8/9] Migrating 1 link's format --- website/content/docs/installation/uninstallation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/installation/uninstallation.mdx b/website/content/docs/installation/uninstallation.mdx index 6bb697d5e..1c75bb8c3 100644 --- a/website/content/docs/installation/uninstallation.mdx +++ b/website/content/docs/installation/uninstallation.mdx @@ -59,5 +59,5 @@ When you use Vagrant again, Vagrant will automatically regenerate any data neces ## Reinstall Vagrant If you decide to reinstall Vagrant, you can -follow the [installation docs](/docs/installation/) again for any standard +follow the [installation docs](/vagrant/docs/installation) again for any standard method. From b217b01ddb16131bde76878a5bd31ceeb6c48eba Mon Sep 17 00:00:00 2001 From: kaitlincart Date: Wed, 25 Jan 2023 12:21:14 -0800 Subject: [PATCH 9/9] remove ruby version so that the doc doesnt become outdated quickly --- website/content/docs/installation/source.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/installation/source.mdx b/website/content/docs/installation/source.mdx index 2e0172af3..1bbee138e 100644 --- a/website/content/docs/installation/source.mdx +++ b/website/content/docs/installation/source.mdx @@ -18,7 +18,7 @@ steps to install Vagrant from source. ## Install Ruby -You must install Ruby 2.7 or newer to develop and build Vagrant. The +To develop and build Vagrant, you must install a specific version of Ruby. The specific Ruby version that you will need is documented in `vagrant.gemspec`, located in the repository on GitHub. It contains the most up-to-date requirements.