Skip to content

Commit

Permalink
chore: Reorganize Getting Started Guide (#3632)
Browse files Browse the repository at this point in the history
* wip: Reworking getting started

* feat: Reworked `Getting Started` guide

* feat: Adding html-proofer and addressing some markdownlint errors

* fix: Addressing some RFC related issues

* fix: Getting rid of `html-proofer`
  • Loading branch information
yhakbar authored Dec 9, 2024
1 parent fd2f8ea commit 5f5e91c
Show file tree
Hide file tree
Showing 13 changed files with 1,282 additions and 2,267 deletions.
462 changes: 0 additions & 462 deletions docs/_docs/01_getting-started/add-to-opentofu-project.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/_docs/01_getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ category: getting-started
excerpt: >-
Learn how to configure Terragrunt.
tags: ["config", "formatting"]
order: 104
order: 105
nav_title: Documentation
nav_title_link: /docs/
---
Expand Down
34 changes: 30 additions & 4 deletions docs/_docs/01_getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Install
category: getting-started
excerpt: Learn how to install Terragrunt on Windows, Mac OS, Linux, FreeBSD and manually from source.
tags: ["install"]
order: 101
order: 103
nav_title: Documentation
nav_title_link: /docs/
---
Expand All @@ -16,12 +16,12 @@ nav_title_link: /docs/
1. Go to the [Releases Page](https://github.com/gruntwork-io/terragrunt/releases).
2. Downloading the binary for your operating system: e.g., if you're on a Mac, download `terragrunt_darwin_amd64`; if you're on Windows, download `terragrunt_windows_amd64.exe`, etc.
3. Rename the downloaded file to `terragrunt`.
4. Add execute permissions to the binary. E.g., On Linux and Mac: `chmod u+x terragrunt`.
5. Put the binary somewhere on your `PATH`. E.g., On Linux and Mac: `mv terragrunt /usr/local/bin/terragrunt`.
4. Add execute permissions to the binary: e.g., On Linux and Mac: `chmod u+x terragrunt`.
5. Put the binary somewhere on your `PATH`: e.g., On Linux and Mac: `mv terragrunt /usr/local/bin/terragrunt`.

### Install via a package manager

Note that all the different package managers are third party.The third party Terragrunt packages may not be updated with the latest version, but are often close. Please check your version against the latest available on the [Releases Page](https://github.com/gruntwork-io/terragrunt/releases).
Note that all the different package managers are third party. The third party Terragrunt packages may not be updated with the latest version, but are often close. Please check your version against the latest available on the [Releases Page](https://github.com/gruntwork-io/terragrunt/releases).
If you want the latest version, the recommended installation option is to [download from the releases page](https://github.com/gruntwork-io/terragrunt/releases).

* **Windows**: You can install Terragrunt on Windows using [Chocolatey](https://chocolatey.org/): `choco install terragrunt`.
Expand All @@ -32,6 +32,32 @@ If you want the latest version, the recommended installation option is to [down

* **FreeBSD**: You can install Terragrunt on FreeBSD using [Pkg](https://www.freebsd.org/cgi/man.cgi?pkg(7)): `pkg install terragrunt`.

### Install via tool manager

A best practice when using Terragrunt is to pin the version you are using to ensure that you, your colleagues and your CI/CD pipelines are all using the same version. This also allows you to easily upgrade to new versions and rollback to previous versions if needed.

You can use a tool manager to install and manage Terragrunt versions.

* **mise**: You can install Terragrunt using [mise](https://mise.jdx.dev): `mise install terragrunt <version>`.
* **asdf**: You can install Terragrunt using [asdf](https://asdf-vm.com): `asdf plugin add terragrunt && asdf install terragrunt <version>`.

Both of these tools allow you to pin the version of Terragrunt you are using in a `.tool-versions` (and `.mise.toml` for mise) file in your project directory.

Colleagues and CI/CD pipelines can then install the associated tool manager, and run using the pinned version.

Note that the tools Terragrunt integrates with, such as OpenTofu and Terraform, can also be managed by these tool managers, so you can also pin the versions of those tools in the same file.

### Building from source

If you'd like to build from source, you can use `go` to build Terragrunt yourself, and install it:

```shell
git clone https://github.com/gruntwork-io/terragrunt.git
cd terragrunt
# Feel free to checkout a particular tag, etc if you want here.
go install
```

### Enable tab completion

If you use either Bash or Zsh, you can enable tab completion for Terragrunt commands. To enable autocomplete, first ensure that a config file exists for your chosen shell.
Expand Down
Loading

0 comments on commit 5f5e91c

Please sign in to comment.