diff --git a/website/source/docs/enterprise/vcs/git.html.md b/website/source/docs/enterprise/vcs/git.html.md index 3aa50501b..1a348b425 100755 --- a/website/source/docs/enterprise/vcs/git.html.md +++ b/website/source/docs/enterprise/vcs/git.html.md @@ -1,28 +1,27 @@ --- -layout: "vcs" -page_title: "Git Integration" -sidebar_current: "docs-enterprise-vcs-git" +layout: "enterprise" +page_title: "Git - VCS Integrations - Terraform Enterprise" +sidebar_current: "docs-enterprise-vcs-git-" description: |- Git repositories can be integrated with Terraform Enterprise by using push command. --- -# Git Integation +# Git Integration Git repositories can be integrated with Terraform Enterprise by using -[`terraform push`](https://www.terraform.io/docs/commands/push.html) to import -Terraform configuration when changes are committed. When Terraform -configuration is imported using `terraform push` a plan is automatically queued. +[`terraform push`](/docs/commands/push.html) to import Terraform configuration +when changes are committed. When Terraform configuration is imported using +`terraform push` a plan is automatically queued. -_**Note:** This integration is for Git repositories **not** hosted on GitHub. -For repositories on GitHub, there is native [GitHub Integration](/docs/enterprise/vcs/github.html). +-> This integration is for Git repositories **not** hosted on GitHub. For GitHub, please see the GitHub documentation instead. ## Setup Terraform configuration can be manually imported by running `terraform push` like below: -``` -$ terraform push -name=$ATLAS_USERNAME/ENV_NAME +```shell +$ terraform push -name=$USERNAME/ENV_NAME ``` A better option than having to manually run `terraform push` is to run it @@ -36,7 +35,7 @@ The script below will execute `terraform push` when you push local changes to your Git server. Place the script at `.git/pre-push` in your local Git repository, set the necessary variables, and ensure the script is executable. -``` +```shell #!/bin/bash # # An example hook script to push Terraform configuration to Terraform Enterprise. diff --git a/website/source/docs/enterprise/vcs/github.html.md b/website/source/docs/enterprise/vcs/github.html.md index 40778358d..70a19b686 100755 --- a/website/source/docs/enterprise/vcs/github.html.md +++ b/website/source/docs/enterprise/vcs/github.html.md @@ -1,6 +1,6 @@ --- -layout: "vcs" -page_title: "GitHub Integration" +layout: "enterprise" +page_title: "GitHub - VCS Integrations - Terraform Enterprise" sidebar_current: "docs-enterprise-vcs-github" description: |- GitHub repositories can be integrated with Terraform Enterprise by using push command. @@ -8,28 +8,31 @@ description: |- # GitHub Integration -GitHub can be used to import Terraform configuration, automatically queuing -runs when changes are merged into a repository's default branch. Additionally, -plans are run when a pull request is created or updated. Terraform Enterprise will update the -pull request with the result of the Terraform plan providing quick feedback on -proposed changes. +GitHub can be used to import Terraform configuration, automatically queuing runs +when changes are merged into a repository's default branch. Additionally, plans +are run when a pull request is created or updated. Terraform Enterprise will +update the pull request with the result of the Terraform plan providing quick +feedback on proposed changes. ## Setup -Terraform Enterprise environments are linked to individual GitHub repositories. However, a -single GitHub repository can be linked to multiple environments allowing -a single set of Terraform configuration to be used across multiple environments. +Terraform Enterprise environments are linked to individual GitHub repositories. +However, a single GitHub repository can be linked to multiple environments +allowing a single set of Terraform configuration to be used across multiple +environments. -Environments can be linked when they're initially created using the New Environment process. -Existing environments can be linked by setting GitHub details in their -**Integrations**. +Environments can be linked when they're initially created using the New +Environment process. Existing environments can be linked by setting GitHub +details in their **Integrations**. -To link a Terraform Enterprise environment to a GitHub repository, you need three pieces of -information: +To link a Terraform Enterprise environment to a GitHub repository, you need +three pieces of information: - **GitHub repository** - The location of the repository being imported in the format _username/repository_. + - **GitHub branch** - The branch from which to ingress new versions. This defaults to the value GitHub provides as the default branch for this repository. + - **Path to directory of Terraform files** - The repository's subdirectory that contains its terraform files. This defaults to the root of the repository. diff --git a/website/source/docs/enterprise/vcs/index.html.md b/website/source/docs/enterprise/vcs/index.html.md index 19c21edc4..c88012641 100755 --- a/website/source/docs/enterprise/vcs/index.html.md +++ b/website/source/docs/enterprise/vcs/index.html.md @@ -1,6 +1,6 @@ --- layout: "enterprise" -page_title: "Integration with Version Control Software" +page_title: "VCS Integrations - Terraform Enterprise" sidebar_current: "docs-enterprise-vcs" description: |- Terraform Enterprise can integrate with version control software Git and GitHub. @@ -8,12 +8,10 @@ description: |- # Integration with Version Control Software -Terraform Enterprise can integrate with your version control software to automatically execute -Terraform with your latest Terraform configuration as you commit changes to -source control. +Terraform Enterprise can integrate with your version control software to +automatically execute Terraform with your latest Terraform configuration as you +commit changes to source control. -Different capabilities within Terraform Enterprise are available depending on the integration -in use. The available integration options are below. - -- [Git](/docs/enterprise/vcs/git.html) -- [GitHub](/docs/enterprise/vcs/github.html) +Different capabilities within Terraform Enterprise are available depending on +the integration in use. The available integration options are on the sidebar +navigation.