Skip to content

Commit

Permalink
chore: Add migration docs
Browse files Browse the repository at this point in the history
Add reference to the migration documentation
  • Loading branch information
vipinvkmenon committed Oct 22, 2024
1 parent 9e93c8e commit d8737c8
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ By default, the underlying Cloud Foundry client used by the Terraform Cloud Foun

If you're not familiar with Terraform yet, see the [Fundamentals](https://developer.hashicorp.com/terraform/tutorials/cli) section with a lot of helpful tutorials.

## Migration Guide

The newer v3 APIs have brought several changes to the many oif the resources are created. Some are deprecated and replaced by
different resources.

Please refer to the [migration guide](https://github.com/cloudfoundry/terraform-provider-cloudfoundry/tree/main/migration-guide) to help transitioning from the existing [community CF provider](https://github.com/cloudfoundry-community/terraform-provider-cloudfoundry) to the [current CF provider](https://github.com/cloudfoundry/terraform-provider-cloudfoundry) and states the difference between them.

## Best Practices

For the best experience using the Cloud Foundry provider, we recommend applying the common best practices for Terraform adoption as described in the Hashicorp documentation. For example, see [Phases of Terraform Adoption](https://developer.hashicorp.com/well-architected-framework/operational-excellence/operational-excellence-terraform-maturity).
7 changes: 7 additions & 0 deletions templates/index.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ By default, the underlying Cloud Foundry client used by the Terraform Cloud Foun

If you're not familiar with Terraform yet, see the [Fundamentals](https://developer.hashicorp.com/terraform/tutorials/cli) section with a lot of helpful tutorials.

## Migration Guide

The newer v3 APIs have brought several changes to the many oif the resources are created. Some are deprecated and replaced by
different resources.

Please refer to the [migration guide](https://github.com/cloudfoundry/terraform-provider-cloudfoundry/tree/main/migration-guide) to help transitioning from the existing [community CF provider](https://github.com/cloudfoundry-community/terraform-provider-cloudfoundry) to the [current CF provider](https://github.com/cloudfoundry/terraform-provider-cloudfoundry) and states the difference between them.

## Best Practices

For the best experience using the {{.RenderedProviderName}} provider, we recommend applying the common best practices for Terraform adoption as described in the Hashicorp documentation. For example, see [Phases of Terraform Adoption](https://developer.hashicorp.com/well-architected-framework/operational-excellence/operational-excellence-terraform-maturity).

0 comments on commit d8737c8

Please sign in to comment.