From 04aa0d8ff8a12a6a1e13c9c1ce3e390776df742d Mon Sep 17 00:00:00 2001 From: Chris Riley Date: Thu, 23 Mar 2017 11:03:36 -0700 Subject: [PATCH] Fixed typos and broken links in TFE docs --- .../docs/enterprise/api/configuration-versions.html.md | 6 +++--- .../source/docs/enterprise/api/configurations.html.md | 8 ++++---- .../source/docs/enterprise/api/environments.html.md | 6 +++--- website/source/docs/enterprise/api/index.html.md | 2 +- website/source/docs/enterprise/api/runs.html.md | 4 ++-- website/source/docs/enterprise/api/states.html.md | 2 +- website/source/docs/enterprise/api/users.html.md | 4 ++-- .../docs/enterprise/artifacts/creating-amis.html.md | 2 +- website/source/docs/enterprise/glossary/index.html.md | 2 +- .../packer/artifacts/creating-vagrant-boxes.html.md | 2 +- .../enterprise/packer/builds/build-environment.html.md | 8 ++++---- .../source/docs/enterprise/packer/builds/index.html.md | 2 +- .../packer/builds/installing-software.html.md | 2 +- .../enterprise/packer/builds/scheduling-builds.html.md | 2 +- .../enterprise/packer/builds/troubleshooting.html.md | 10 +++++----- website/source/docs/enterprise/packer/index.html.md | 4 ++-- website/source/docs/enterprise/runs/starting.html.md | 2 +- website/source/docs/enterprise/support.html.md | 2 +- .../source/docs/enterprise/user-accounts/index.html.md | 2 +- website/source/layouts/docs.erb | 6 +++--- website/source/layouts/faq.erb | 2 +- 21 files changed, 40 insertions(+), 40 deletions(-) diff --git a/website/source/docs/enterprise/api/configuration-versions.html.md b/website/source/docs/enterprise/api/configuration-versions.html.md index b4804bd93..8d8fae650 100755 --- a/website/source/docs/enterprise/api/configuration-versions.html.md +++ b/website/source/docs/enterprise/api/configuration-versions.html.md @@ -3,12 +3,12 @@ layout: "api" page_title: "Configuration Versions API" sidebar_current: "docs-enterprise-api-configversions" description: |- - A configuration version represents versions of Terrraform configuration. + A configuration version represents versions of Terraform configuration. --- # Configuration Versions API -A configuration version represents versions of Terrraform configuration. +A configuration version represents versions of Terraform configuration. Each set of changes to Terraform HCL files or the scripts used in the files should have an associated configuration version. @@ -38,7 +38,7 @@ to include the necessary variables for the Terraform configuration. ### Actions -The following actions can be perfomed on this resource. +The following actions can be performed on this resource.
Create
diff --git a/website/source/docs/enterprise/api/configurations.html.md b/website/source/docs/enterprise/api/configurations.html.md index 0bfd29a9e..3af25c8e9 100755 --- a/website/source/docs/enterprise/api/configurations.html.md +++ b/website/source/docs/enterprise/api/configurations.html.md @@ -3,12 +3,12 @@ layout: "api" page_title: "Terraform Configuration API" sidebar_current: "docs-enterprise-api-configurations" description: |- - A configuration respresents settings associated with a resource that runs Terraform with versions of Terraform configuration.. + A configuration represents settings associated with a resource that runs Terraform with versions of Terraform configuration.. --- # Terraform Configuration API -A configuration respresents settings associated with a resource that +A configuration represents settings associated with a resource that runs Terraform with versions of Terraform configuration. Configurations have many [configuration versions](/docs/enterprise/api/configuration-versions.html) @@ -40,7 +40,7 @@ configuration. ### Actions -The following actions can be perfomed on this resource. +The following actions can be performed on this resource.
Show
@@ -63,7 +63,7 @@ Creates a configuration with the provided attributes. #### Retrieving a configuration -Returns the JSON respresentation of the latest configuration. +Returns the JSON representation of the latest configuration. $ curl %{ATLAS_URL}/api/v1/terraform/configurations/%{DEFAULT_USERNAME}/test/versions/latest \ -H "X-Atlas-Token: $ATLAS_TOKEN" diff --git a/website/source/docs/enterprise/api/environments.html.md b/website/source/docs/enterprise/api/environments.html.md index 8c3fe3b92..a52e9c424 100755 --- a/website/source/docs/enterprise/api/environments.html.md +++ b/website/source/docs/enterprise/api/environments.html.md @@ -24,7 +24,7 @@ This documentation covers the environment interactions with Terraform. variables A key/value map of Terraform variables to be updated. Existing - variables will only be removed when their value is empty. Varaibles + variables will only be removed when their value is empty. Variables of the same key will be overwritten. Yes @@ -39,11 +39,11 @@ This documentation covers the environment interactions with Terraform. ### Actions -The following actions can be perfomed on this resource. +The following actions can be performed on this resource.
Update variables
-
PUT /api/v1/enviromments/:username/:name/variables
+
PUT /api/v1/environments/:username/:name/variables
### Examples diff --git a/website/source/docs/enterprise/api/index.html.md b/website/source/docs/enterprise/api/index.html.md index 3d286dd94..baa930888 100755 --- a/website/source/docs/enterprise/api/index.html.md +++ b/website/source/docs/enterprise/api/index.html.md @@ -20,7 +20,7 @@ or requests for new API features please email [support@hashicorp.com](mailto:sup ## Authentication All requests must be authenticated with an `X-Atlas-Token` HTTP header. This -token can be generated or revoked on the [account tokens page](/settings/tokens). +token can be generated or revoked on the account tokens page. Your token will have access to all resources your account has access to. For organization level resources, we recommend creating a separate user account diff --git a/website/source/docs/enterprise/api/runs.html.md b/website/source/docs/enterprise/api/runs.html.md index 43ec3f1a1..2d10c6e66 100755 --- a/website/source/docs/enterprise/api/runs.html.md +++ b/website/source/docs/enterprise/api/runs.html.md @@ -31,11 +31,11 @@ can be configured to auto-apply to avoid this. ### Actions -The following actions can be perfomed on this resource. +The following actions can be performed on this resource.
Queue a run
-
POST /api/v1/enviromments/:username/:name/plan
+
POST /api/v1/environments/:username/:name/plan
### Examples diff --git a/website/source/docs/enterprise/api/states.html.md b/website/source/docs/enterprise/api/states.html.md index 7760a1ca5..69f03b618 100755 --- a/website/source/docs/enterprise/api/states.html.md +++ b/website/source/docs/enterprise/api/states.html.md @@ -27,7 +27,7 @@ State represents the status of your infrastructure at the last time Terraform wa ### Actions -The following actions can be perfomed on this resource. +The following actions can be performed on this resource.
Get a list of states accessible to a user
diff --git a/website/source/docs/enterprise/api/users.html.md b/website/source/docs/enterprise/api/users.html.md index e72ea5e3a..1f18a515c 100755 --- a/website/source/docs/enterprise/api/users.html.md +++ b/website/source/docs/enterprise/api/users.html.md @@ -11,13 +11,13 @@ description: |- Users are both users and organizations in Terraform Enterprise. They are the parent resource of all resources. -Currently, only the retrieval of users is avaiable on the API. Additionally, +Currently, only the retrieval of users is available on the API. Additionally, only Vagrant box resources will be listed. Boxes will be returned based on permissions over the organization, or user. ### Actions -The following actions can be perfomed on this resource. +The following actions can be performed on this resource.
Show
diff --git a/website/source/docs/enterprise/artifacts/creating-amis.html.md b/website/source/docs/enterprise/artifacts/creating-amis.html.md index 972bc8eee..c04b3ecc9 100755 --- a/website/source/docs/enterprise/artifacts/creating-amis.html.md +++ b/website/source/docs/enterprise/artifacts/creating-amis.html.md @@ -11,4 +11,4 @@ description: |- Currently, the best way to create AWS AMI artifacts is with Packer. -We detail how to do this in the [Packer section of the documentation](https://atlas.hashicorp.com/help/packer/artifacts/creating-amis). +We detail how to do this in the [Packer section of the documentation](/docs/enterprise/packer/artifacts/creating-amis.html). diff --git a/website/source/docs/enterprise/glossary/index.html.md b/website/source/docs/enterprise/glossary/index.html.md index dfdf9a111..af1b7ecdf 100755 --- a/website/source/docs/enterprise/glossary/index.html.md +++ b/website/source/docs/enterprise/glossary/index.html.md @@ -172,7 +172,7 @@ stores artifacts, be it images or IDs for cloud provider images. ### Run -A run epresents a two step Terraform plan and a subsequent apply. +A run represents a two step Terraform plan and a subsequent apply. ### Service diff --git a/website/source/docs/enterprise/packer/artifacts/creating-vagrant-boxes.html.md b/website/source/docs/enterprise/packer/artifacts/creating-vagrant-boxes.html.md index 55fe5d428..6c5484501 100755 --- a/website/source/docs/enterprise/packer/artifacts/creating-vagrant-boxes.html.md +++ b/website/source/docs/enterprise/packer/artifacts/creating-vagrant-boxes.html.md @@ -89,7 +89,7 @@ For `vagrant.box` type artifacts, you can specify keys in the metadata block: - `version`: This is the Vagrant box version and is constrained to the same formatting as in the web UI: `*.*.*` _(optional, but required for boxes with multiple providers). The version will increment on the minor version if left blank (e.g the initial version will be set to 0.1.0, the subsequent version will be set to 0.2.0)._ -- `description`: This is the desciption that will be shown with the +- `description`: This is the description that will be shown with the version of the box. You can use Markdown for links and style. _(optional)_ ## Example diff --git a/website/source/docs/enterprise/packer/builds/build-environment.html.md b/website/source/docs/enterprise/packer/builds/build-environment.html.md index e10db2a45..3402fd860 100755 --- a/website/source/docs/enterprise/packer/builds/build-environment.html.md +++ b/website/source/docs/enterprise/packer/builds/build-environment.html.md @@ -28,8 +28,8 @@ Terraform Enterprise currently supports running the following Packer builders: ### Files -All files in the uploading package (via [Packer push or GitHub](/help/packer/builds/starting)), -and the application from the [build pipeline](/help/applications/build-pipeline) are available on the filesystem +All files in the uploading package (via [Packer push or GitHub](/docs/enterprise/packer/builds/starting.html)), +and the application from the build pipeline are available on the filesystem of the build environment. You can use the file icon on the running build to show a list of @@ -55,7 +55,7 @@ We encourage use of relative paths over absolute paths to maintain portability between Terraform Enterprise and local builds. The total size of all files in the package being uploaded via -[Packer push or GitHub](/help/packer/builds/starting) must be 5 GB or less. +[Packer push or GitHub](/docs/enterprise/packer/builds/starting.html) must be 5 GB or less. If you need to upload objects that are larger, such as dmgs, see the [`packer push` "Limits" documentation](https://packer.io/docs/command-line/push.html) @@ -91,7 +91,7 @@ Additionally, the following environment variables are automatically injected. Al - `ATLAS_BUILD_USERNAME` - This is the username associated with the build (e.g. `"sammy"`) - `ATLAS_BUILD_CONFIGURATION_VERSION` - This is the unique, auto-incrementing - version for the [Packer build configuration](/help/glossary) (e.g. `"34"`). + version for the [Packer build configuration](/docs/enterprise/glossary/index.html) (e.g. `"34"`). - `ATLAS_BUILD_GITHUB_BRANCH` - This is the name of the branch that the associated Packer build configuration version was ingressed from (e.g. `master`). diff --git a/website/source/docs/enterprise/packer/builds/index.html.md b/website/source/docs/enterprise/packer/builds/index.html.md index 3c187a638..28e1035b3 100755 --- a/website/source/docs/enterprise/packer/builds/index.html.md +++ b/website/source/docs/enterprise/packer/builds/index.html.md @@ -24,7 +24,7 @@ more builds by configuring the various components of Packer - Applications that use the build as part of the pipeline and merged into the version prior to running Packer on it When a new version of Packer configuration and associated -scripts from GitHub or `packer push` is recieved, it automatically starts a new +scripts from GitHub or `packer push` is received, it automatically starts a new Packer build. That Packer build runs in an isolated machine environment with the contents of that version available to it. diff --git a/website/source/docs/enterprise/packer/builds/installing-software.html.md b/website/source/docs/enterprise/packer/builds/installing-software.html.md index e98632a84..8231a0485 100755 --- a/website/source/docs/enterprise/packer/builds/installing-software.html.md +++ b/website/source/docs/enterprise/packer/builds/installing-software.html.md @@ -8,7 +8,7 @@ description: |- # Installing Software -Please review the [Packer Build Environment](/docs/enterprise/builds/build-environment.html) +Please review the [Packer Build Environment](/docs/enterprise/packer/builds/build-environment.html) specification for important information on isolation, security, and hardware limitations before continuing. diff --git a/website/source/docs/enterprise/packer/builds/scheduling-builds.html.md b/website/source/docs/enterprise/packer/builds/scheduling-builds.html.md index df55a8928..cd9bcba79 100755 --- a/website/source/docs/enterprise/packer/builds/scheduling-builds.html.md +++ b/website/source/docs/enterprise/packer/builds/scheduling-builds.html.md @@ -17,7 +17,7 @@ run Packer for you, creating any artifacts and sending the appropriate notifications. If your artifacts are used in any other environments and you have activated -the plan on aritfact upload feature, this may also queue Terraform +the plan on artifact upload feature, this may also queue Terraform plans. This feature is useful for maintenance of images and automatic updates, diff --git a/website/source/docs/enterprise/packer/builds/troubleshooting.html.md b/website/source/docs/enterprise/packer/builds/troubleshooting.html.md index 3980e8434..1ac90def0 100755 --- a/website/source/docs/enterprise/packer/builds/troubleshooting.html.md +++ b/website/source/docs/enterprise/packer/builds/troubleshooting.html.md @@ -14,10 +14,10 @@ are all possible. Below is a list of debugging options you can use. ### Verbose Packer Logging -You can [set a variable](/help/packer/builds/build-environment#environment-variables) in the UI that increases the logging verbosity +You can [set a variable](/docs/enterprise/packer/builds/build-environment.html#environment-variables) in the UI that increases the logging verbosity in Packer. Set the `PACKER_LOG` key to a value of `1` to accomplish this. -After setting the variable, you'll need to [rebuild](/help/packer/builds/rebuilding). +After setting the variable, you'll need to [rebuild](/docs/enterprise/packer/builds/rebuilding.html). Verbose logging will be much louder than normal Packer logs and isn't recommended for day-to-day operations. Once enabled, you'll be able to @@ -36,7 +36,7 @@ Things to pay attention to when this happens: - SSH credentials must be properly configured. AWS keypairs should match, SSH usernames should be correct, passwords should match, etc. -- Any VM preseed configuration should have the same SSH configuration +- Any VM pre-seed configuration should have the same SSH configuration as your template defines A good way to debug this is to manually attempt to use the same SSH @@ -46,10 +46,10 @@ more about [debugging Packer builds](https://packer.io/docs/other/debugging.html ### Hardware Limitations Your build may be failing by requesting larger memory or -disk usage then is available. Read more about the [build environment](/docs/enterprise/packer/builds/build-environment#hardware-limitations). +disk usage then is available. Read more about the [build environment](/docs/enterprise/packer/builds/build-environment.html#hardware-limitations). _Typically_ Packer builds that fail due to requesting hardware limits -that exceed Terraform Enterprise's [hardware limitations](/docs/enterprise/packer/builds/build-environment#hardware-limitations) +that exceed Terraform Enterprise's [hardware limitations](/docs/enterprise/packer/builds/build-environment.html#hardware-limitations) will fail with a _The operation was canceled_ error message as shown below: ``` diff --git a/website/source/docs/enterprise/packer/index.html.md b/website/source/docs/enterprise/packer/index.html.md index 3055e5c0f..ff42ee84e 100755 --- a/website/source/docs/enterprise/packer/index.html.md +++ b/website/source/docs/enterprise/packer/index.html.md @@ -15,5 +15,5 @@ source configuration. This is a list of features specific to Packer that Terraform Enterprise provides. - [Running Packer Builds](/docs/enterprise/packer/builds/index.html) -- [Creating and Uploading AMIs](/docs/enterprise/packer/artifacts/creating-amis/index.html) -- [Creating Vagrant Boxes](/docs/enterprise/packer/artifacts/creating-vagrant-boxes/index.html) +- [Creating and Uploading AMIs](/docs/enterprise/packer/artifacts/creating-amis.html) +- [Creating Vagrant Boxes](/docs/enterprise/packer/artifacts/creating-vagrant-boxes.html) diff --git a/website/source/docs/enterprise/runs/starting.html.md b/website/source/docs/enterprise/runs/starting.html.md index b2796121a..e2f1caf46 100755 --- a/website/source/docs/enterprise/runs/starting.html.md +++ b/website/source/docs/enterprise/runs/starting.html.md @@ -84,7 +84,7 @@ Supported GitHub webhook events: ## Artifact Uploads -Upon successful completion of a Terraform run,the remote state is parsed and +Upon successful completion of a Terraform run, the remote state is parsed and any [artifacts](/docs/enterprise/artifacts/artifact-provider.html) are detected that were referenced. When new versions of those referenced artifacts are uploaded, you have the option to automatically queue a new Terraform run. diff --git a/website/source/docs/enterprise/support.html.md b/website/source/docs/enterprise/support.html.md index 9a6918aeb..3770583be 100755 --- a/website/source/docs/enterprise/support.html.md +++ b/website/source/docs/enterprise/support.html.md @@ -20,7 +20,7 @@ within less than 24 hours. ## HashiCorp Tools Support It's often the case that Terraform Enterprise questions or feedback relates to the -HashiCorp tooling. We encourage all Terraform Enterpriseusers to search for related +HashiCorp tooling. We encourage all Terraform Enterprise users to search for related issues and problems in the open source repositories and mailing lists prior to contacting us to help make our support more efficient and to help resolve problems faster. diff --git a/website/source/docs/enterprise/user-accounts/index.html.md b/website/source/docs/enterprise/user-accounts/index.html.md index 7ac07a1b1..175dc5d0e 100755 --- a/website/source/docs/enterprise/user-accounts/index.html.md +++ b/website/source/docs/enterprise/user-accounts/index.html.md @@ -8,6 +8,6 @@ description: |- # User Accounts in Terraform Enterprise -Users are the main identity system in Terrafgorm Enterprise. A user can +Users are the main identity system in Terraform Enterprise. A user can be a member of multiple [organizations](/docs/enterprise/organizations), as well as individually collaborate on various resources. diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 9753bf667..91c94b40c 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -561,15 +561,15 @@ > Packer + > + API + > User Accounts > Organizations - > - API - > Billing diff --git a/website/source/layouts/faq.erb b/website/source/layouts/faq.erb index 94dd70ad2..725fe37fc 100644 --- a/website/source/layouts/faq.erb +++ b/website/source/layouts/faq.erb @@ -10,7 +10,7 @@ FAQ