Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fivetran-aleksandrboldyrev committed Sep 11, 2024
1 parent 3b96200 commit aa5c063
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs/guides/dbt_private_git_deploy_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Then you need to set up the dbt Project public key (field `public_key` in create
```hcl
resource "github_repository_deploy_key" "example_repository_deploy_key" {
title = "Repository test key"
repository = "your-repo"
repository = "repo-owner/repo-name"
key = fivetran_dbt_project.project.public_key
read_only = true
}
Expand All @@ -40,7 +40,7 @@ And after that you can configure your project in `fivetran_dbt_git_project_confi
resource "fivetran_dbt_git_project_config" "project_config" {
id = fivetran_dbt_project.project.id

git_remote_url = "[email protected]:your-repo.git"
git_remote_url = "[email protected]:repo-owner/repo-name.git"
git_branch = "main"
}
```
Expand Down
24 changes: 23 additions & 1 deletion docs/guides/version_1.3.0_update_guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,30 @@ resource "fivetran_dbt_project" "test_project" {
type = "GIT"
}


For GitHub based repositories
```hcl
resource "github_repository_deploy_key" "example_repository_deploy_key" {
title = "Repository test key"
repository = "fivetran/dbt_demo"
key = fivetran_dbt_project.test_project.public_key
read_only = true
}
```

For Bitbucket based repositories
```hcl
resource "bitbucket_deploy_key" "test" {
workspace = "fivetran"
repository = "dbt_demo"
key = fivetran_dbt_project.test_project.public_key
label = "Repository test key"
}
```

```hcl
resource "fivetran_dbt_git_project_config" "test_project_config" {
id = fivetran_dbt_project.test_project.id
project_id = fivetran_dbt_project.test_project.id

folder_path = "/folder/path"
git_remote_url = "[email protected]:fivetran/dbt_demo.git"
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dbt_git_project_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This resource allows you to add and manage dbt Git Projects Configs.

```hcl
resource "fivetran_dbt_git_project_config" "git_project_config" {
id = "project_id"
project_id = "project_id"
git_remote_url = "your_git_remote_url"
git_branch = "main"
folder_path = "/dbt/project/folder/path"
Expand Down
5 changes: 0 additions & 5 deletions docs/resources/dbt_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@ resource "fivetran_dbt_project" "project" {
environment_vars = ["environment_var=value"]
threads = 8
type = "GIT"
project_config {
git_remote_url = "your_git_remote_url"
git_branch = "main"
folder_path = "/dbt/project/folder/path"
}
}
```

Expand Down
4 changes: 2 additions & 2 deletions templates/guides/dbt_private_git_deploy_key.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Then you need to set up the dbt Project public key (field `public_key` in create
```hcl
resource "github_repository_deploy_key" "example_repository_deploy_key" {
title = "Repository test key"
repository = "your-repo"
repository = "repo-owner/repo-name"
key = fivetran_dbt_project.project.public_key
read_only = true
}
Expand All @@ -40,7 +40,7 @@ And after that you can configure your project in `fivetran_dbt_git_project_confi
resource "fivetran_dbt_git_project_config" "project_config" {
id = fivetran_dbt_project.project.id

git_remote_url = "[email protected]:your-repo.git"
git_remote_url = "[email protected]:repo-owner/repo-name.git"
git_branch = "main"
}
```
Expand Down
22 changes: 22 additions & 0 deletions templates/guides/version_1.3.0_update_guides.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,28 @@ resource "fivetran_dbt_project" "test_project" {
type = "GIT"
}


For GitHub based repositories
```hcl
resource "github_repository_deploy_key" "example_repository_deploy_key" {
title = "Repository test key"
repository = "fivetran/dbt_demo"
key = fivetran_dbt_project.test_project.public_key
read_only = true
}
```

For Bitbucket based repositories
```hcl
resource "bitbucket_deploy_key" "test" {
workspace = "fivetran"
repository = "dbt_demo"
key = fivetran_dbt_project.test_project.public_key
label = "Repository test key"
}
```

```hcl
resource "fivetran_dbt_git_project_config" "test_project_config" {
project_id = fivetran_dbt_project.test_project.id

Expand Down
2 changes: 1 addition & 1 deletion templates/resources/dbt_git_project_config.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This resource allows you to add and manage dbt Git Projects Configs.

```hcl
resource "fivetran_dbt_git_project_config" "git_project_config" {
id = "project_id"
project_id = "project_id"
git_remote_url = "your_git_remote_url"
git_branch = "main"
folder_path = "/dbt/project/folder/path"
Expand Down
5 changes: 0 additions & 5 deletions templates/resources/dbt_project.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@ resource "fivetran_dbt_project" "project" {
environment_vars = ["environment_var=value"]
threads = 8
type = "GIT"
project_config {
git_remote_url = "your_git_remote_url"
git_branch = "main"
folder_path = "/dbt/project/folder/path"
}
}
```

Expand Down

0 comments on commit aa5c063

Please sign in to comment.