Skip to content

Commit

Permalink
Merge pull request #2060 from Cyb3r-Jak3/git-account-pages
Browse files Browse the repository at this point in the history
Adds note about linking git acocunts and Cloudflare
  • Loading branch information
jacobbednarz authored Nov 28, 2022
2 parents 065d474 + d4d1a1c commit 8f1cf31
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .changelog/2060.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```release-note:enhancement
resource/cloudflare_pages_project: add note about linking git accounts to Cloudflare account.
```

```release-note:enhancement
resource/cloudflare_pages_domain: add note about needing to make a separate `cloudflare_record`.
```
5 changes: 4 additions & 1 deletion docs/resources/pages_domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: |-

Provides a resource for managing Cloudflare Pages domains.

-> A DNS record for the domain is not automatically created. You need to create a `cloudflare_record` resource for the domain you want to use.

## Example Usage

```terraform
Expand All @@ -18,6 +20,7 @@ resource "cloudflare_pages_domain" "my-domain" {
domain = "example.com"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

Expand All @@ -38,4 +41,4 @@ Import is supported using the following syntax:

```shell
$ terraform import cloudflare_pages_domain.example <account_id>/<project_name>/<domain-name>
```
```
7 changes: 7 additions & 0 deletions docs/resources/pages_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ description: |-

Provides a resource which manages Cloudflare Pages projects.

-> If you are using a `source` block configuration, you must first have a
connected GitHub or GitLab account connected to Cloudflare. See the
[Getting Started with Pages] documentation on how to link your accounts.

## Example Usage

```terraform
Expand Down Expand Up @@ -106,6 +110,7 @@ resource "cloudflare_pages_project" "deployment_configs" {
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

Expand Down Expand Up @@ -210,3 +215,5 @@ Import is supported using the following syntax:
```shell
$ terraform import cloudflare_pages_project.example <account_id>/<project_name>
```

[Getting Started with Pages]: https://developers.cloudflare.com/pages/get-started/#connect-your-git-provider-to-pages
24 changes: 24 additions & 0 deletions templates/resources/pages_domain.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
page_title: "{{.Name}} {{.Type}} - {{.RenderedProviderName}}"
subcategory: ""
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

{{ .Description | trimspace }}

-> A DNS record for the domain is not automatically created. You need to create a `cloudflare_record` resource for the domain you want to use.

## Example Usage

{{ tffile (printf "%s%s%s" "examples/resources/" .Name "/resource.tf") }}

{{ .SchemaMarkdown | trimspace }}

## Import

Import is supported using the following syntax:

{{ codefile "shell" (printf "%s%s%s" "examples/resources/" .Name "/import.sh") }}
28 changes: 28 additions & 0 deletions templates/resources/pages_project.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
page_title: "{{.Name}} {{.Type}} - {{.RenderedProviderName}}"
subcategory: ""
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

{{ .Description | trimspace }}

-> If you are using a `source` block configuration, you must first have a
connected GitHub or GitLab account connected to Cloudflare. See the
[Getting Started with Pages] documentation on how to link your accounts.

## Example Usage

{{ tffile (printf "%s%s%s" "examples/resources/" .Name "/resource.tf") }}

{{ .SchemaMarkdown | trimspace }}

## Import

Import is supported using the following syntax:

{{ codefile "shell" (printf "%s%s%s" "examples/resources/" .Name "/import.sh") }}

[Getting Started with Pages]: https://developers.cloudflare.com/pages/get-started/#connect-your-git-provider-to-pages

0 comments on commit 8f1cf31

Please sign in to comment.