From 66666ed29b41f700f79d3387231ee196707117c9 Mon Sep 17 00:00:00 2001 From: Jack Pearkes Date: Tue, 21 Apr 2015 14:39:22 -0700 Subject: [PATCH] website: improve artifact docs --- .../docs/providers/atlas/r/artifact.html.markdown | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/website/source/docs/providers/atlas/r/artifact.html.markdown b/website/source/docs/providers/atlas/r/artifact.html.markdown index ba139e411..889413f21 100644 --- a/website/source/docs/providers/atlas/r/artifact.html.markdown +++ b/website/source/docs/providers/atlas/r/artifact.html.markdown @@ -16,6 +16,10 @@ of resources. ## Example Usage +An artifact can be created that has metadata representing +an AMI in AWS. This AMI can be used to configure an instance. Any changes +to this artifact will trigger a change to that instance. + ``` # Read the AMI resource "atlas_artifact" "web" { @@ -43,14 +47,15 @@ The following arguments are supported: * `type` - (Required) The type of artifact to query for. -* `build` - (Optional) The build to filter on. This can be "latest", +* `build` - (Optional) The build number responsible for creating + the version of the artifact to filter on. This can be "latest", to find a matching artifact in the latest build, "any" to find a matching artifact in any build, or a specific number to pin to that build. If `build` and `version` are unspecified, `version` will default to "latest". Cannot be specified with `version`. -* `version` - (Optional) The version to filter on. This can be "latest", - to match against the latest version, "any" to find a matching artifact +* `version` - (Optional) The version of the artifact to filter on. This can + be "latest", to match against the latest version, "any" to find a matching artifact in any version, or a specific number to pin to that version. Defaults to "latest" if neither `build` or `version` is specified. Cannot be specified with `build`.