Skip to content

Commit

Permalink
Migrating links to new format
Browse files Browse the repository at this point in the history
  • Loading branch information
Ashlee Boyer committed Jan 12, 2023
1 parent 49dea21 commit bd3a8b2
Show file tree
Hide file tree
Showing 119 changed files with 293 additions and 293 deletions.
16 changes: 8 additions & 8 deletions website/content/docs/boxes/base.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ following:
- SSH user so Vagrant can connect
- Perhaps Chef, Puppet, etc. but not strictly required.

In addition to this, each [provider](/docs/providers/) may require
In addition to this, each [provider](/vagrant/docs/providers/) may require
additional software. For example, if you are making a base box for VirtualBox,
you will want to include the VirtualBox guest additions so that shared folders
work properly. But if you are making an AWS base box, this is not required.
Expand All @@ -58,16 +58,16 @@ boxes.

Provider-specific guides for creating base boxes are linked below:

- [Docker Base Boxes](/docs/providers/docker/boxes)
- [Hyper-V Base Boxes](/docs/providers/hyperv/boxes)
- [VMware Base Boxes](/docs/providers/vmware/boxes)
- [VirtualBox Base Boxes](/docs/providers/virtualbox/boxes)
- [Docker Base Boxes](/vagrant/docs/providers/docker/boxes)
- [Hyper-V Base Boxes](/vagrant/docs/providers/hyperv/boxes)
- [VMware Base Boxes](/vagrant/docs/providers/vmware/boxes)
- [VirtualBox Base Boxes](/vagrant/docs/providers/virtualbox/boxes)

### Packer and Vagrant Cloud

We strongly recommend using [Packer](https://www.packer.io) to create reproducible
We strongly recommend using [Packer](/packer) to create reproducible
builds for your base boxes, as well as automating the builds. Read more about
[automating Vagrant box creation with Packer](https://www.packer.io/guides/packer-on-cicd/build-image-in-cicd)
[automating Vagrant box creation with Packer](/packer/guides/packer-on-cicd/build-image-in-cicd)
in the Packer documentation.

### Disk Space
Expand Down Expand Up @@ -282,7 +282,7 @@ provider-specific guides are linked to towards the top of this page.
You can distribute the box file however you would like. However, if you want
to support versioning, putting multiple providers at a single URL, pushing
updates, analytics, and more, we recommend you add the box to
[HashiCorp's Vagrant Cloud](/vagrant-cloud).
[HashiCorp's Vagrant Cloud](/vagrant/vagrant-cloud).

You can upload both public and private boxes to this service.

Expand Down
12 changes: 6 additions & 6 deletions website/content/docs/boxes/format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

In the past, boxes were just [tar files](<https://en.wikipedia.org/wiki/Tar_(computing)>)
of VirtualBox exports. With Vagrant supporting multiple
[providers](/docs/providers/) and [versioning](/docs/boxes/versioning)
[providers](/vagrant/docs/providers/) and [versioning](/vagrant/docs/boxes/versioning)
now, box files are slightly more complicated.

Box files made for Vagrant 1.0.x (the VirtualBox export `tar` files) continue
Expand All @@ -26,7 +26,7 @@ Today, there are three different components:
box file and so on.

- Box Catalog Metadata - This is a JSON document (typically exchanged
during interactions with [HashiCorp's Vagrant Cloud](/vagrant-cloud))
during interactions with [HashiCorp's Vagrant Cloud](/vagrant/vagrant-cloud))
that specifies the name of the box, a description, available
versions, available providers, and URLs to the actual box files
(next component) for each provider and version. If this catalog
Expand All @@ -35,7 +35,7 @@ Today, there are three different components:

- Box Information - This is a JSON document that can provide additional
information about the box that displays when a user runs
`vagrant box list -i`. More information is provided [here](/docs/boxes/info).
`vagrant box list -i`. More information is provided [here](/vagrant/docs/boxes/info).

The first two components are covered in more detail below.

Expand All @@ -47,7 +47,7 @@ are supported for legacy reasons in Vagrant.

Box files are compressed using `tar`, `tar.gz`, or `zip`. The contents of the
archive can be anything, and is specific to each
[provider](/docs/providers/). Vagrant core itself only unpacks
[provider](/vagrant/docs/providers/). Vagrant core itself only unpacks
the boxes for use later.

Within the archive, Vagrant does expect a single file:
Expand Down Expand Up @@ -80,11 +80,11 @@ file.
## Box Metadata

The metadata is an optional component for a box (but highly recommended)
that enables [versioning](/docs/boxes/versioning), updating, multiple
that enables [versioning](/vagrant/docs/boxes/versioning), updating, multiple
providers from a single file, and more.

-> **You do not need to manually make the metadata.** If you
have an account with [HashiCorp's Vagrant Cloud](/vagrant-cloud), you
have an account with [HashiCorp's Vagrant Cloud](/vagrant/vagrant-cloud), you
can create boxes there, and HashiCorp's Vagrant Cloud automatically creates
the metadata for you. The format is still documented here.

Expand Down
12 changes: 6 additions & 6 deletions website/content/docs/boxes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ description: |-

# Vagrant boxes

Boxes are the package format for Vagrant environments. You specify a box environment and operating configurations in your [Vagrantfile](/docs/vagrantfile). You can use a box on any [supported platform](https://www.vagrantup.com/downloads) to bring up identical working environments. To enable teams to use and manage the same boxes, [versions are supported](/docs/boxes/versioning).
Boxes are the package format for Vagrant environments. You specify a box environment and operating configurations in your [Vagrantfile](/vagrant/docs/vagrantfile). You can use a box on any [supported platform](/vagrant/downloads) to bring up identical working environments. To enable teams to use and manage the same boxes, [versions are supported](/vagrant/docs/boxes/versioning).

~> **Note**: Boxes require a provider, a virtualization product, to operate. Before you can use a box,
ensure that you have properly installed a supported [provider](/docs/providers).
ensure that you have properly installed a supported [provider](/vagrant/docs/providers).

The quickest way to get started is to select a pre-defined box environment from the
[publicly available catalog on Vagrant Cloud](https://vagrantcloud.com/boxes/search).
You can also add and share your own customized boxes on Vagrant Cloud.

The `vagrant box` CLI utility provides all the functionality for box management. You can read the documentation on the [vagrant box](/docs/cli/box)
The `vagrant box` CLI utility provides all the functionality for box management. You can read the documentation on the [vagrant box](/vagrant/docs/cli/box)
command for more information.

## Discover boxes
Expand All @@ -30,7 +30,7 @@ systems as bases, as well as specialized boxes to get you started with common
configurations such as LAMP stacks, Ruby, and Python.

The boxes on the public catalog work with many different
[providers](/docs/providers/). The list of supported providers is located in the box descriptions.
[providers](/vagrant/docs/providers/). The list of supported providers is located in the box descriptions.

### Add a box

Expand Down Expand Up @@ -72,7 +72,7 @@ It is often a point of confusion but Canonical, the company that makes the Ubunt

## Create a box

If you are unable to find a box that meets your specific use case, you can create one. We recommend that you first create a [base box](/docs/boxes/base) to have a clean slate to start from when you build future development environments.
If you are unable to find a box that meets your specific use case, you can create one. We recommend that you first create a [base box](/vagrant/docs/boxes/base) to have a clean slate to start from when you build future development environments.

Learn more about [box formats](/docs/boxes/format) to get started.
Learn more about [box formats](/vagrant/docs/boxes/format) to get started.

4 changes: 2 additions & 2 deletions website/content/docs/boxes/info.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ hashicorp/bionic64 (virtualbox, 1.0.0)
## Box Info

To accomplish this, you simply need to include a file named `info.json` when
creating a [base box](/docs/boxes/base) which is a JSON document containing
creating a [base box](/vagrant/docs/boxes/base) which is a JSON document containing
any and all relevant information that will be displayed to the user when the
`-i` option is used with `vagrant box list`.

Expand All @@ -37,5 +37,5 @@ any and all relevant information that will be displayed to the user when the
There are no special keys or values in `info.json`, and Vagrant will print each
key and value on its own line.

The [Box File Format](/docs/boxes/format) provides more information about what
The [Box File Format](/vagrant/docs/boxes/format) provides more information about what
else goes into a Vagrant box.
8 changes: 4 additions & 4 deletions website/content/docs/boxes/versioning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ to Vagrant makes it easy to use and fit nicely into the Vagrant workflow.

This page will cover how to use versioned boxes. It does _not_ cover how
to update your own custom boxes with versions. That is covered in
[creating a base box](/docs/boxes/base).
[creating a base box](/vagrant/docs/boxes/base).

## Viewing Versions and Updating

`vagrant box list` only shows _installed_ versions of boxes. If you want
to see all available versions of a box, you will have to find the box
on [HashiCorp's Vagrant Cloud](/vagrant-cloud). An easy way to find a box
on [HashiCorp's Vagrant Cloud](/vagrant/vagrant-cloud). An easy way to find a box
is to use the url `https://vagrantcloud.com/$USER/$BOX`. For example, for
the `hashicorp/bionic64` box, you can find information about it at
`https://vagrantcloud.com/hashicorp/bionic64`.
Expand All @@ -47,7 +47,7 @@ command just downloads these updates locally.
## Version Constraints

You can constrain a Vagrant environment to a specific version or versions
of a box using the [Vagrantfile](/docs/vagrantfile/) by specifying
of a box using the [Vagrantfile](/vagrant/docs/vagrantfile/) by specifying
the `config.vm.box_version` option.

If this option is not specified, the latest version is always used. This is
Expand Down Expand Up @@ -76,7 +76,7 @@ of the format `X.Y.Z` where `X`, `Y`, and `Z` are all positive integers.

## Automatic Update Checking

Using the [Vagrantfile](/docs/vagrantfile/), you can also configure
Using the [Vagrantfile](/vagrant/docs/vagrantfile/), you can also configure
Vagrant to automatically check for updates during any `vagrant up`. This is
enabled by default, but can easily be disabled with
`config.vm.box_check_update = false` in your Vagrantfile.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/cli/box.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: |-

**Command: `vagrant box`**

This is the command used to manage (add, remove, etc.) [boxes](/docs/boxes).
This is the command used to manage (add, remove, etc.) [boxes](/vagrant/docs/boxes).

The main functionality of this command is exposed via even more subcommands:

Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/cli/cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Vagrant Cloud.

**Command: `vagrant cloud auth login`**

The login command is used to authenticate with [HashiCorp's Vagrant Cloud](/vagrant-cloud)
The login command is used to authenticate with [HashiCorp's Vagrant Cloud](/vagrant/vagrant-cloud)
server. Logging in is only necessary if you are accessing protected boxes.

**Logging in is not a requirement to use Vagrant.** The vast majority
Expand Down Expand Up @@ -171,7 +171,7 @@ The provider create command is used to create a new provider entry on Vagrant Cl
The `url` argument is expected to be a remote URL that Vagrant Cloud can use
to download the provider. If no `url` is specified, the provider entry can be updated
later with a url or the [upload](#cloud-provider-upload) command can be used to
upload a Vagrant [box file](/docs/boxes).
upload a Vagrant [box file](/vagrant/docs/boxes).

## Cloud Provider Delete

Expand All @@ -191,7 +191,7 @@ Vagrant Cloud with the given options.

**Command: `vagrant cloud provider upload ORGANIZATION/BOX-NAME PROVIDER-NAME VERSION BOX-FILE`**

The provider upload command will upload a Vagrant [box file](/docs/boxes) to Vagrant Cloud for
The provider upload command will upload a Vagrant [box file](/vagrant/docs/boxes) to Vagrant Cloud for
the specified version and provider.

# Cloud Publish
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/cli/connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ description: |-
**Command: `vagrant connect NAME`**

The connect command complements the
[share command](/docs/cli/share) by enabling access to shared
[share command](/vagrant/docs/cli/share) by enabling access to shared
environments. You can learn about all the details of Vagrant Share in the
[Vagrant Share section](/docs/share/).
[Vagrant Share section](/vagrant/docs/share/).

The reference of available command-line flags to this command
is available below.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/cli/destroy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ the box installed in the system will still be present on the hard drive. To
return your computer to the state as it was before `vagrant up` command, you
need to use `vagrant box remove`.

For more information, read about the [`vagrant box remove`](/docs/cli/box) command.
For more information, read about the [`vagrant box remove`](/vagrant/docs/cli/box) command.
2 changes: 1 addition & 1 deletion website/content/docs/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ available by reading the appropriate sub-section available in the left
navigational area of this site.

You may also wish to consult the
[documentation](/docs/other/environmental-variables) regarding the
[documentation](/vagrant/docs/other/environmental-variables) regarding the
environmental variables that can be used to configure and control
Vagrant in a global way.

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/cli/init.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: |-
**Command: `vagrant init [name [url]]`**

This initializes the current directory to be a Vagrant environment
by creating an initial [Vagrantfile](/docs/vagrantfile/) if
by creating an initial [Vagrantfile](/vagrant/docs/vagrantfile/) if
one does not already exist.

If a first argument is given, it will prepopulate the `config.vm.box`
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/cli/login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ description: |-
**Command: `vagrant login`**

The login command is used to authenticate with the
[HashiCorp's Vagrant Cloud](/vagrant-cloud) server. Logging in is only
[HashiCorp's Vagrant Cloud](/vagrant/vagrant-cloud) server. Logging in is only
necessary if you are accessing protected boxes or using
[Vagrant Share](/docs/share/).
[Vagrant Share](/vagrant/docs/share/).

**Logging in is not a requirement to use Vagrant.** The vast majority
of Vagrant does _not_ require a login. Only certain features such as protected
boxes or [Vagrant Share](/docs/share/) require a login.
boxes or [Vagrant Share](/vagrant/docs/share/) require a login.

The reference of available command-line flags to this command
is available below.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/cli/machine-readable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ is replaced with machine-friendly output.

This mode makes it easy to programmatically execute Vagrant and read data
out of it. This output format is protected by our
[backwards compatibility](/docs/installation/backwards-compatibility)
[backwards compatibility](/vagrant/docs/installation/backwards-compatibility)
policy. Until Vagrant 2.0 is released, however, the machine readable output
may change as we determine more use cases for it. But the backwards
compatibility promise should make it safe to write client libraries to
Expand Down
10 changes: 5 additions & 5 deletions website/content/docs/cli/non-primary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ non-primary subcommands. They're executed just like any other subcommand:
The list of non-primary commands is below. Click on any command to learn
more about it.

- [docker-exec](/docs/providers/docker/commands)
- [docker-logs](/docs/providers/docker/commands)
- [docker-run](/docs/providers/docker/commands)
- [rsync](/docs/cli/rsync)
- [rsync-auto](/docs/cli/rsync-auto)
- [docker-exec](/vagrant/docs/providers/docker/commands)
- [docker-logs](/vagrant/docs/providers/docker/commands)
- [docker-run](/vagrant/docs/providers/docker/commands)
- [rsync](/vagrant/docs/cli/rsync)
- [rsync-auto](/vagrant/docs/cli/rsync-auto)
10 changes: 5 additions & 5 deletions website/content/docs/cli/package.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ description: |-
**Command: `vagrant package [name|id]`**

This packages a currently running _VirtualBox_ or _Hyper-V_ environment into a
re-usable [box](/docs/boxes). This command can only be used with
other [providers](/docs/providers/) based on the provider implementation
re-usable [box](/vagrant/docs/boxes). This command can only be used with
other [providers](/vagrant/docs/providers/) based on the provider implementation
and if the provider supports it.

## Options
Expand All @@ -30,15 +30,15 @@ and if the provider supports it.
tasks.

- `--info path/to/info.json` - The package will include a custom JSON file containing
information to be displayed by the [list](/docs/cli/box#box-list) command when invoked
information to be displayed by the [list](/vagrant/docs/cli/box#box-list) command when invoked
with the `-i` flag

- `--vagrantfile FILE` - Packages a Vagrantfile with the box, that is loaded
as part of the [Vagrantfile load order](/docs/vagrantfile/#load-order)
as part of the [Vagrantfile load order](/vagrant/docs/vagrantfile/#load-order)
when the resulting box is used.

-> **A common misconception** is that the `--vagrantfile`
option will package a Vagrantfile that is used when `vagrant init`
is used with this box. This is not the case. Instead, a Vagrantfile
is loaded and read as part of the Vagrant load process when the box is
used. For more information, read about the [Vagrantfile load order](/docs/vagrantfile/#load-order).
used. For more information, read about the [Vagrantfile load order](/vagrant/docs/vagrantfile/#load-order).
4 changes: 2 additions & 2 deletions website/content/docs/cli/plugin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

**Command: `vagrant plugin`**

This is the command used to manage [plugins](/docs/plugins/).
This is the command used to manage [plugins](/vagrant/docs/plugins/).

The main functionality of this command is exposed via another level
of subcommands:
Expand Down Expand Up @@ -104,7 +104,7 @@ This command accepts optional command-line flags:
**Command: `vagrant plugin license <name> <license-file>`**

This command installs a license for a proprietary Vagrant plugin,
such as the [VMware Fusion provider](/docs/providers/vmware).
such as the [VMware Fusion provider](/vagrant/docs/providers/vmware).

# Plugin List

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/cli/port.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ $ vagrant port my-machine

- `--machine-readable` - This tells Vagrant to display machine-readable output
instead of the human-friendly output. More information is available in the
[machine-readable output](/docs/cli/machine-readable) documentation.
[machine-readable output](/vagrant/docs/cli/machine-readable) documentation.
2 changes: 1 addition & 1 deletion website/content/docs/cli/provision.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

**Command: `vagrant provision [vm-name]`**

Runs any configured [provisioners](/docs/provisioning/)
Runs any configured [provisioners](/vagrant/docs/provisioning/)
against the running Vagrant managed machine.

This command is a great way to quickly test any provisioners, and is especially
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/cli/reload.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: |-

**Command: `vagrant reload [name|id]`**

The equivalent of running a [halt](/docs/cli/halt) followed by an
[up](/docs/cli/up).
The equivalent of running a [halt](/vagrant/docs/cli/halt) followed by an
[up](/vagrant/docs/cli/up).

This command is usually required for changes made in the Vagrantfile to
take effect. After making any modifications to the Vagrantfile, a `reload`
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/cli/resume.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: |-
**Command: `vagrant resume [name|id]`**

This resumes a Vagrant managed machine that was previously suspended,
perhaps with the [suspend command](/docs/cli/suspend).
perhaps with the [suspend command](/vagrant/docs/cli/suspend).

The configured provisioners will not run again, by default. You can force
the provisioners to re-run by specifying the `--provision` flag.
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/cli/rsync-auto.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: |-
**Command: `vagrant rsync-auto`**

This command watches all local directories of any
[rsync synced folders](/docs/synced-folders/rsync) and automatically
[rsync synced folders](/vagrant/docs/synced-folders/rsync) and automatically
initiates an rsync transfer when changes are detected. This command does
not exit until an interrupt is received.

Expand Down Expand Up @@ -41,7 +41,7 @@ To ensure that the command works properly, you should start `rsync-auto`
only when the machine is running, and shut it down before any machine
state changes.

You can always force a resync with the [rsync](/docs/cli/rsync) command.
You can always force a resync with the [rsync](/vagrant/docs/cli/rsync) command.

## Vagrantfile Changes

Expand Down
Loading

0 comments on commit bd3a8b2

Please sign in to comment.