Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation #359

Merged
merged 5 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Fix documentation
  • Loading branch information
fivetran-aleksandrboldyrev committed Sep 11, 2024
commit aa5c0637873bd12fecaa3c15ab5a5e0ea29f38ee
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 = "git@github.com:your-repo.git"
git_remote_url = "git@github.com: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 = "git@github.com: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 = "git@github.com:your-repo.git"
git_remote_url = "git@github.com: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
Loading