From 9ac9ab6706a5771f767c9a88b2633faf6cba91b9 Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Wed, 22 Oct 2014 10:01:17 -0400 Subject: [PATCH] Use the built-in alert helpers --- website/source/docs/internals/graph.html.md | 4 +--- website/source/docs/internals/index.html.md | 4 +--- website/source/docs/internals/lifecycle.html.md | 4 +--- website/source/docs/plugins/basics.html.md | 10 +++------- website/source/docs/plugins/index.html.md | 4 +--- website/source/docs/plugins/provider.html.md | 4 +--- website/source/intro/examples/index.html.markdown | 12 ++++-------- website/source/intro/getting-started/build.html.md | 14 ++++---------- .../source/intro/getting-started/modules.html.md | 13 +++---------- 9 files changed, 19 insertions(+), 50 deletions(-) diff --git a/website/source/docs/internals/graph.html.md b/website/source/docs/internals/graph.html.md index ca215cf43..4b1a56de7 100644 --- a/website/source/docs/internals/graph.html.md +++ b/website/source/docs/internals/graph.html.md @@ -15,13 +15,11 @@ generate plans, refresh state, and more. This page documents the details of what are contained in this graph, what types of nodes there are, and how the edges of the graph are determined. -
-Advanced Topic! This page covers technical details +~> **Advanced Topic!** This page covers technical details of Terraform. You don't need to understand these details to effectively use Terraform. The details are documented here for those who wish to learn about them without having to go spelunking through the source code. -
## Graph Nodes diff --git a/website/source/docs/internals/index.html.md b/website/source/docs/internals/index.html.md index 4c8713a0c..135fb027d 100644 --- a/website/source/docs/internals/index.html.md +++ b/website/source/docs/internals/index.html.md @@ -14,8 +14,6 @@ of this section is to remove any notion of "magic" from Terraform. We want you to be able to trust and understand what Terraform is doing to function. -
-Note: Knowledge of Terraform internals is not +-> **Note:** Knowledge of Terraform internals is not required to use Terraform. If you aren't interested in the internals of Terraform, you may safely skip this section. -
diff --git a/website/source/docs/internals/lifecycle.html.md b/website/source/docs/internals/lifecycle.html.md index bf4f8862d..beaa28f77 100644 --- a/website/source/docs/internals/lifecycle.html.md +++ b/website/source/docs/internals/lifecycle.html.md @@ -13,13 +13,11 @@ state machines. Understanding this lifecycle can help better understand how Terraform generates an execution plan, how it safely executes that plan, and what the resource provider is doing throughout all of this. -
-Advanced Topic! This page covers technical details +~> **Advanced Topic!** This page covers technical details of Terraform. You don't need to understand these details to effectively use Terraform. The details are documented here for those who wish to learn about them without having to go spelunking through the source code. -
## Lifecycle diff --git a/website/source/docs/plugins/basics.html.md b/website/source/docs/plugins/basics.html.md index 9d2c26a14..94aa25d77 100644 --- a/website/source/docs/plugins/basics.html.md +++ b/website/source/docs/plugins/basics.html.md @@ -12,12 +12,10 @@ This page documents the basics of how the plugin system in Terraform works, and how to setup a basic development environment for plugin development if you're writing a Terraform plugin. -
-Advanced topic! Plugin development is a highly advanced +~> **Advanced topic!** Plugin development is a highly advanced topic in Terraform, and is not required knowledge for day-to-day usage. If you don't plan on writing any plugins, we recommend not reading this section of the documentation. -
## How it Works @@ -70,12 +68,10 @@ Developing a plugin is simple. The only knowledge necessary to write a plugin is basic command-line skills and basic knowledge of the [Go programming language](http://golang.org). -
-Note: A common pitfall is not properly setting up a +-> **Note:** A common pitfall is not properly setting up a $GOPATH. This can lead to strange errors. You can read more about -this here to familiarize +this [here](https://golang.org/doc/code.html) to familiarize yourself. -
Create a new Go project somewhere in your `$GOPATH`. If you're a GitHub user, we recommend creating the project in the directory diff --git a/website/source/docs/plugins/index.html.md b/website/source/docs/plugins/index.html.md index 726e1c802..7970e704c 100644 --- a/website/source/docs/plugins/index.html.md +++ b/website/source/docs/plugins/index.html.md @@ -18,9 +18,7 @@ to write plugins for Terraform. It does not hold your hand through the process, however, and expects a relatively high level of understanding of Go, provider semantics, Unix, etc. -
-Advanced topic! Plugin development is a highly advanced +~> **Advanced topic!** Plugin development is a highly advanced topic in Terraform, and is not required knowledge for day-to-day usage. If you don't plan on writing any plugins, we recommend not reading this section of the documentation. -
diff --git a/website/source/docs/plugins/provider.html.md b/website/source/docs/plugins/provider.html.md index 6cd0fa6d8..76c4bd003 100644 --- a/website/source/docs/plugins/provider.html.md +++ b/website/source/docs/plugins/provider.html.md @@ -22,12 +22,10 @@ The primary reasons to care about provider plugins are: * You want to write a completely new provider for custom, internal systems such as a private inventory management system. -
-Advanced topic! Plugin development is a highly advanced +~> **Advanced topic!** Plugin development is a highly advanced topic in Terraform, and is not required knowledge for day-to-day usage. If you don't plan on writing any plugins, we recommend not reading this section of the documentation. -
If you're interested in provider development, then read on. The remainder of this page will assume you're familiar with diff --git a/website/source/intro/examples/index.html.markdown b/website/source/intro/examples/index.html.markdown index 4de521f2d..421ac121e 100644 --- a/website/source/intro/examples/index.html.markdown +++ b/website/source/intro/examples/index.html.markdown @@ -16,14 +16,10 @@ ask for input of things such as variables and API keys. If you want to conitnue using the example, you should save those parameters in a "terraform.tfvars" file or in a `provider` config bock. -
-
-Note: The examples use real providers that launch -real resources. That means they can cost money to -experiment with. To avoid unexpected charges, be sure to understand the price -of resources before launching them, and verify any unneeded resources -are cleaned up afterwards.
-
+~> **Warning!** The examples use real providers that launch _real_ resources. +That means they can cost money to experiment with. To avoid unexpected charges, +be sure to understand the price of resources before launching them, and verify +any unneeded resources are cleaned up afterwards. Experimenting in this way can help you learn how the Terraform lifecycle works, as well as how to repeatedly create and destroy infrastructure. diff --git a/website/source/intro/getting-started/build.html.md b/website/source/intro/getting-started/build.html.md index cc81481de..7559f935b 100644 --- a/website/source/intro/getting-started/build.html.md +++ b/website/source/intro/getting-started/build.html.md @@ -29,16 +29,10 @@ If you already have an AWS account, you may be charged some amount of money, but it shouldn't be more than a few dollars at most. -
-

-Note: If you're not using an account that qualifies -under the AWS -free-tier, -you may be charged to run these examples. The most you should -be charged should only be a few dollars, but we're not responsible -for any charges that may incur. -

-
+~> **Warning!** If you're not using an account that qualifies under the AWS +[free-tier](http://aws.amazon.com/free/), you may be charged to run these +examples. The most you should be charged should only be a few dollars, but +we're not responsible for any charges that may incur. ## Configuration diff --git a/website/source/intro/getting-started/modules.html.md b/website/source/intro/getting-started/modules.html.md index bdaf6968b..d7008dd12 100644 --- a/website/source/intro/getting-started/modules.html.md +++ b/website/source/intro/getting-started/modules.html.md @@ -21,16 +21,9 @@ This section of the getting started will cover the basics of using modules. Writing modules is covered in more detail in the [modules documentation](/docs/modules/index.html). -
-

-Warning: The examples on this page are -not eligible for the -AWS -free-tier. Do not execute -the examples on this page unless you're willing to spend a small -amount of money. -

-
+~> **Warning!** The examples on this page are _**not** eligible_ for the AWS +[free-tier](http://aws.amazon.com/free/). Do not execute the examples on this +page unless you're willing to spend a small amount of money. ## Using Modules