Skip to content

Commit

Permalink
migrate documentation files to new directory format
Browse files Browse the repository at this point in the history
  • Loading branch information
davidji99 committed Mar 2, 2021
1 parent 9150302 commit 74f0fa1
Show file tree
Hide file tree
Showing 36 changed files with 270 additions and 296 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Please list the resources as a list, for example:
If this issue appears to affect multiple resources, it may be an issue with Terraform's core, so please mention this.

### Terraform Configuration Files
```hcl
```hcl-terraform
# Copy-paste your Terraform configurations here - for large Terraform configs,
# please use a service like Dropbox and share a link to the ZIP file. For
# security, you can also encrypt the files using our GPG public key.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Requirements
------------

- [Terraform](https://www.terraform.io/downloads.html) 0.12.x
- [Go](https://golang.org/doc/install) 1.14 (to build the provider plugin)
- [Go](https://golang.org/doc/install) 1.15 (to build the provider plugin)

Usage
-----

For Terraform 0.12+ compatibility, the configuration should specifiy version 2 or higher:

```hcl
```hcl-terraform
provider "heroku" {
version = "~> 2.0"
}
Expand Down Expand Up @@ -64,7 +64,7 @@ cp $GOPATH/bin/terraform-provider-heroku ~/.terraform.d/plugins/

Set the Heroku provider without a version constraint:

```hcl
```hcl-terraform
provider "heroku" {}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this data source to get information about a Heroku Addon.

## Example Usage

```hcl
```hcl-terraform
data "heroku_addon" "from_another_app" {
name = "addon-from-another-app"
}
Expand Down
4 changes: 2 additions & 2 deletions website/docs/d/app.html.markdown → docs/data-sources/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this data source to get information about a Heroku App.

## Example Usage

```hcl
```hcl-terraform
# Lookup an existing Heroku app
data "heroku_app" "default" {
name = "my-cool-app"
Expand Down Expand Up @@ -53,7 +53,7 @@ The following attributes are exported:
* `heroku_hostname` - The hostname for the Heroku application, suitable
for pointing DNS records.

* `config_vars` - A map of all of the configuration variables for the app.
* `config_vars` - A map of all configuration variables for the app.

* `acm` - True if Heroku ACM is enabled for this app, false otherwise.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,13 @@ description: |-

Use this data source to get information about a Heroku Pipeline.

~> **NOTE:** This data source can only be used to fetch information regarding a pipeline that has apps associated to it.
~> **NOTE:**
This data source can only be used to fetch information regarding a pipeline that has apps already associated to it.
This is a limitation in the Heroku Platform API where it is not possible to query a pipeline without apps by its name.

## Example Usage

```hcl
```hcl-terraform
data "heroku_pipeline" "foobar" {
name = "pipeline-test-123"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this data source to get information about a [Heroku Private Space](https://w

## Example Usage

```hcl
```hcl-terraform
# Look up a Heroku Private Space
data "heroku_space" "default" {
name = "my-secret-space"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ Use this data source to get peering information about a [Heroku Private Space](h

## Example Usage

```hcl
```hcl-terraform
# Look up a Heroku Private Space's peering info.
data "heroku_space_peering_info" "default" {
name = "my-secret-space"
}
# Initiate a VPC peering connection request.
resource "aws_vpc_peering_connection" "foo" {
peer_owner_id = "${data.heroku_space_peering_info.default.aws_account_id}"
peer_vpc_id = "${data.heroku_space_peering_info.default.vpc_id}"
vpc_id = "${aws_vpc.foo.id}"
peer_owner_id = data.heroku_space_peering_info.default.aws_account_id
peer_vpc_id = data.heroku_space_peering_info.default.vpc_id
vpc_id = aws_vpc.foo.id
}
```

Expand All @@ -37,8 +37,13 @@ The following arguments are supported:
The following attributes are exported:

* `aws_account_id` - The AWS account ID that the Heroku Private Space runs in.

* `aws_region` - The AWS region that the Heroku Private Space runs in.

* `vpc_id` - The VPC ID of the Heroku Private Space.

* `vpc_cidr` - The CIDR block of the VPC ID.

* `dyno_cidr_blocks` - The CIDR blocks that the Dynos run on.

* `unavailable_cidr_blocks` - A list of unavailable CIDR blocks.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this data source to get information about a Heroku Team or Heroku Enterprise

## Example Usage

```hcl
```hcl-terraform
data "heroku_team" "my_heroku_team" {
name = "name_of_my_heroku_team"
}
Expand Down Expand Up @@ -40,8 +40,13 @@ The following arguments are supported:
The following attributes are exported:

* `id` - The ID of the team

* `default` - Whether to use this team when none is specified

* `credit_card_collections` - Whether charges incurred by the team are paid by credit card

* `membership_limit` - Upper limit of members allowed in a team

* `provisioned_licenses` - Whether the team is provisioned licenses by Salesforce

* `type` - type of team Will likely be either "enterprise" or "team"
8 changes: 4 additions & 4 deletions website/docs/index.html.markdown → docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Development happens in the [GitHub repo](https://github.com/heroku/terraform-pro

## Example Usage

```hcl
```hcl-terraform
# Configure the Heroku provider
provider "heroku" {
email = "[email protected]"
Expand Down Expand Up @@ -58,7 +58,7 @@ precedence, and explained below:
Credentials can be provided statically by adding `email` and `api_key` arguments
to the Heroku provider block:

```hcl
```hcl-terraform
provider "heroku" {
email = "[email protected]"
api_key = var.heroku_api_key
Expand All @@ -71,7 +71,7 @@ When the Heroku provider block does not contain an `email` or `api_key`
argument, the missing credentials will be sourced from the environment via the
`HEROKU_EMAIL` and `HEROKU_API_KEY` environment variables respectively:

```hcl
```hcl-terraform
provider "heroku" {}
```

Expand All @@ -87,7 +87,7 @@ Refreshing Terraform state in-memory prior to plan...
Credentials can instead be sourced from the [`.netrc`](https://ec.haxx.se/usingcurl-netrc.html)
file in your home directory:

```hcl
```hcl-terraform
provider "heroku" {}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,14 @@ and remove resource from state.

## Available Features

For a list of available features, use the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) to fetch them for the current user:

```
heroku labs
```
For a list of available features, use the [`heroku labs`](https://devcenter.heroku.com/articles/heroku-cli)
command to fetch them for the current authenticated user.

The output will contain **User Features** that may be managed with this resource.

## Example Usage

```hcl
# Create a new Heroku app
```hcl-terraform
resource "heroku_account_feature" "example_metrics" {
name = "metrics-request-volume"
enabled = true
Expand All @@ -38,14 +34,17 @@ resource "heroku_account_feature" "example_metrics" {
The following arguments are supported:

* `name` - (Required) Name of the account feature

* `enabled` - (Required) Enable or disable the account feature

## Attributes Reference

The following attributes are exported:

* `id` - Comprised of acount email & feature name

* `description` - Description of account feature

* `state` - State of account feature

## Import
Expand All @@ -54,6 +53,7 @@ Existing account features can be imported using a combination of the account ema
and the feature name.

For example:

```
$ terraform import heroku_account_feature.example_metrics [email protected]:metrics-request-volume
```
13 changes: 10 additions & 3 deletions website/docs/r/addon.html.markdown → docs/resources/addon.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ services to a Heroku app.

## Example Usage

```hcl
```hcl-terraform
# Create a new Heroku app
resource "heroku_app" "default" {
name = "test-app"
}
# Create a database, and configure the app to use it
resource "heroku_addon" "database" {
app = "${heroku_app.default.name}"
app = heroku_app.default.name
plan = "heroku-postgresql:hobby-basic"
}
# Add a web-hook addon for the app
resource "heroku_addon" "webhook" {
app = "${heroku_app.default.name}"
app = heroku_app.default.name
plan = "deployhooks:http"
config = {
Expand All @@ -41,18 +41,25 @@ resource "heroku_addon" "webhook" {
The following arguments are supported:

* `app` - (Required) The Heroku app to add to.

* `plan` - (Required) The addon to add.

* `config` - (Optional) Optional plan configuration.

* `name` - (Optional) Globally unique name of the add-on.

## Attributes Reference

The following attributes are exported:

* `id` - The ID of the add-on

* `name` - The add-on name

* `plan` - The plan name

* `provider_id` - The ID of the plan provider

* `config_vars` - The Configuration variables of the add-on


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Attaches a Heroku Addon Resource to an additional Heroku App.

## Example Usage

```hcl
```hcl-terraform
resource "heroku_addon_attachment" "database" {
app_id = heroku_app.default.id
addon_id = heroku_addon.database.id
Expand All @@ -32,8 +32,11 @@ resource "heroku_addon_attachment" "database_credentials" {
The following arguments are supported:

* `app_id` - (Required) The ID of the Heroku App to attach to.

* `addon_id` - (Required) The ID of the existing Heroku Addon to attach.

* `name` - (Optional) A friendly name for the Heroku Addon Attachment.

* `namespace` - (Optional) The namespace value for the Heroku Addon Attachment. This can be used to configure the behaviour of the attachment. See [Heroku Platform API Reference](https://devcenter.heroku.com/articles/platform-api-reference#add-on-attachment-create)

## Attributes Reference
Expand Down
Loading

0 comments on commit 74f0fa1

Please sign in to comment.