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

docs: updated the language for the hcp_consul_cluster resource #176

Merged
merged 2 commits into from
Aug 3, 2021

Conversation

karl-cardenas-coding
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding commented Aug 3, 2021

🛠️ Description

🚢 Release Note

Release note for CHANGELOG:

* {affected resource | docs | all}: {Brief description of change} [GH-nnnn]

🏗️ Acceptance tests

  • Are there any feature flags that are required to use this functionality?
  • Have you added an acceptance test for the functionality being added?
  • Have you run the acceptance tests on this branch?

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccXXX'

...

@karl-cardenas-coding
Copy link
Contributor Author

Adding for guidance @daneharrigan

@karl-cardenas-coding karl-cardenas-coding marked this pull request as ready for review August 3, 2021 18:54
@karl-cardenas-coding karl-cardenas-coding requested a review from a team as a code owner August 3, 2021 18:54
@karl-cardenas-coding karl-cardenas-coding requested a review from a team August 3, 2021 18:54
@@ -38,6 +38,7 @@ resource "hcp_consul_cluster" "example" {
### Optional

- **auto_hvn_to_hvn_peering** (Boolean) Enables automatic HVN to HVN peering when creating a secondary cluster in a federation.
The alternative to using the auto-accept feature is to create an [`hcp_hvn_peering_connection`](hvn_peering_connection.md) resource that explicitly defines the HVN resources that are allowed to communicate with each other.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doc is generated, so you'll want to add this line here: https://github.com/hashicorp/terraform-provider-hcp/blob/main/internal/provider/resource_consul_cluster.go#L142
And then run go generate ./...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @bcmdarroch. I went ahead and make the changes in the correct spot.

@karl-cardenas-coding karl-cardenas-coding merged commit 2e0513d into main Aug 3, 2021
@karl-cardenas-coding karl-cardenas-coding deleted the hvn-docs-add branch August 3, 2021 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants