vaguerent/website/source/docs/getting-started/project_setup.html.md
Seth Vargo 5093f3120e Merge docs and www into a single static site
This is a big commit, and I apologize in advance for the future
git-blames all pointing to me. This commit does a few things:

1.  Merges the website/docs and website/www repo into a single website repo
    to be in line with other HashiCorp projects
2.  Updates to use middleman-hashicorp
3.  Converts less to scss to be in line with other projects
4.  Updates page styles to be in line with other projects
5.  Optimizes images
6.  Prepare for S3 + Fastly deployment with scripts, etc.
7.  Removes blog posts (they have been transferred to hashicorp.com with
    redirects in place
8.  Updated sitemap generation script for better SEO
9.  Fixed many broken links
10. Add description to all fields
2016-01-19 14:35:05 -05:00

47 lines
1.6 KiB
Markdown

---
layout: "docs"
page_title: "Project Setup - Getting Started"
sidebar_current: "gettingstarted-projectsetup"
description: |-
The first step in configuring any Vagrant project is to create a Vagrantfile.
---
# Project Setup
The first step in configuring any Vagrant project is to create a
[Vagrantfile](/docs/vagrantfile/). The purpose of the
Vagrantfile is twofold:
1. Mark the root directory of your project. Many of the configuration
options in Vagrant are relative to this root directory.
2. Describe the kind of machine and resources you need to run your project,
as well as what software to install and how you want to access it.
Vagrant has a built-in command for initializing a directory for usage
with Vagrant: `vagrant init`. For the purpose of this getting started guide,
please follow along in your terminal:
```
$ mkdir vagrant_getting_started
$ cd vagrant_getting_started
$ vagrant init
```
This will place a `Vagrantfile` in your current directory. You can
take a look at the Vagrantfile if you want, it is filled with comments
and examples. Do not be afraid if it looks intimidating, we will modify it
soon enough.
You can also run `vagrant init` in a pre-existing directory to
set up Vagrant for an existing project.
The Vagrantfile is meant to be committed to version control with
your project, if you use version control. This way, every person working
with that project can benefit from Vagrant without any upfront work.
## Next Steps
You have successfully created your first project environment. Read on to learn
more about [Vagrant boxes](/docs/getting-started/boxes.html).